ConsumerApi

<back to all web services

NextToClaimBusinessRequest

ConsumerBusiness
Requires Authentication
Required role:Consumer
The following routes are available for this service:
POST/business/next-to-claim
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class ConsumerApi
{

    public static class NextToClaimBusinessRequest implements IPost
    {
        public UUID placeGuid = null;
        
        public UUID getPlaceGuid() { return placeGuid; }
        public NextToClaimBusinessRequest setPlaceGuid(UUID value) { this.placeGuid = value; return this; }
    }

    public static class NextToClaimBusinessResponse
    {
        public NextClaimStep nextStep = null;
        public ClaimUserInfo user = null;
        public PlaceBasicApiDto place = null;
        
        public NextClaimStep getNextStep() { return nextStep; }
        public NextToClaimBusinessResponse setNextStep(NextClaimStep value) { this.nextStep = value; return this; }
        public ClaimUserInfo getUser() { return user; }
        public NextToClaimBusinessResponse setUser(ClaimUserInfo value) { this.user = value; return this; }
        public PlaceBasicApiDto getPlace() { return place; }
        public NextToClaimBusinessResponse setPlace(PlaceBasicApiDto value) { this.place = value; return this; }
    }

    public static enum NextClaimStep
    {
        AuthenticateWithVipps,
        CreatePassword,
        AcceptBusinessTermsOfService,
        Claim,
        Completed;
    }

    public static class ClaimUserInfo
    {
        public String firstName = null;
        public String lastName = null;
        public String email = null;
        public Boolean legalIdentityVerified = null;
        public String phoneNumber = null;
        
        public String getFirstName() { return firstName; }
        public ClaimUserInfo setFirstName(String value) { this.firstName = value; return this; }
        public String getLastName() { return lastName; }
        public ClaimUserInfo setLastName(String value) { this.lastName = value; return this; }
        public String getEmail() { return email; }
        public ClaimUserInfo setEmail(String value) { this.email = value; return this; }
        public Boolean isLegalIdentityVerified() { return legalIdentityVerified; }
        public ClaimUserInfo setLegalIdentityVerified(Boolean value) { this.legalIdentityVerified = value; return this; }
        public String getPhoneNumber() { return phoneNumber; }
        public ClaimUserInfo setPhoneNumber(String value) { this.phoneNumber = value; return this; }
    }

    public static class PlaceBasicApiDto
    {
        public Long id = null;
        public UUID guid = null;
        public String overview = null;
        public String name = null;
        public Float longitude = null;
        public Float latitude = null;
        public Boolean claimed = null;
        public String organizationNumber = null;
        public String countryCode = null;
        public OpeningHours openingHours = null;
        public Boolean wheelchairAccessible = null;
        public Boolean wifi = null;
        public Boolean outdoorSeating = null;
        public Boolean saveFoodAndMoney = null;
        public PlaceType placeType = null;
        public PriceMainDishApiDto priceMainDish = null;
        public TimeZoneDto timeZoneDto = null;
        public Long businessId = null;
        public PlaceContact contact = null;
        public PlaceAddress address = null;
        public ArrayList<CategoryTreeApiDto> categories = new ArrayList<CategoryTreeApiDto>();
        public ImageUrls logoUrl = null;
        public ImageUrls imageUrl = null;
        public ArrayList<WearPriceProfileEsDto> wearPriceProfiles = new ArrayList<WearPriceProfileEsDto>();
        public ArrayList<PlaceSelectedBrandApiDto> brands = new ArrayList<PlaceSelectedBrandApiDto>();
        public String floor = null;
        
        public Long getId() { return id; }
        public PlaceBasicApiDto setId(Long value) { this.id = value; return this; }
        public UUID getGuid() { return guid; }
        public PlaceBasicApiDto setGuid(UUID value) { this.guid = value; return this; }
        public String getOverview() { return overview; }
        public PlaceBasicApiDto setOverview(String value) { this.overview = value; return this; }
        public String getName() { return name; }
        public PlaceBasicApiDto setName(String value) { this.name = value; return this; }
        public Float getLongitude() { return longitude; }
        public PlaceBasicApiDto setLongitude(Float value) { this.longitude = value; return this; }
        public Float getLatitude() { return latitude; }
        public PlaceBasicApiDto setLatitude(Float value) { this.latitude = value; return this; }
        public Boolean isClaimed() { return claimed; }
        public PlaceBasicApiDto setClaimed(Boolean value) { this.claimed = value; return this; }
        public String getOrganizationNumber() { return organizationNumber; }
        public PlaceBasicApiDto setOrganizationNumber(String value) { this.organizationNumber = value; return this; }
        public String getCountryCode() { return countryCode; }
        public PlaceBasicApiDto setCountryCode(String value) { this.countryCode = value; return this; }
        public OpeningHours getOpeningHours() { return openingHours; }
        public PlaceBasicApiDto setOpeningHours(OpeningHours value) { this.openingHours = value; return this; }
        public Boolean isWheelchairAccessible() { return wheelchairAccessible; }
        public PlaceBasicApiDto setWheelchairAccessible(Boolean value) { this.wheelchairAccessible = value; return this; }
        public Boolean isWifi() { return wifi; }
        public PlaceBasicApiDto setWifi(Boolean value) { this.wifi = value; return this; }
        public Boolean isOutdoorSeating() { return outdoorSeating; }
        public PlaceBasicApiDto setOutdoorSeating(Boolean value) { this.outdoorSeating = value; return this; }
        public Boolean isSaveFoodAndMoney() { return saveFoodAndMoney; }
        public PlaceBasicApiDto setSaveFoodAndMoney(Boolean value) { this.saveFoodAndMoney = value; return this; }
        public PlaceType getPlaceType() { return placeType; }
        public PlaceBasicApiDto setPlaceType(PlaceType value) { this.placeType = value; return this; }
        public PriceMainDishApiDto getPriceMainDish() { return priceMainDish; }
        public PlaceBasicApiDto setPriceMainDish(PriceMainDishApiDto value) { this.priceMainDish = value; return this; }
        public TimeZoneDto getTimeZoneDto() { return timeZoneDto; }
        public PlaceBasicApiDto setTimeZoneDto(TimeZoneDto value) { this.timeZoneDto = value; return this; }
        public Long getBusinessId() { return businessId; }
        public PlaceBasicApiDto setBusinessId(Long value) { this.businessId = value; return this; }
        public PlaceContact getContact() { return contact; }
        public PlaceBasicApiDto setContact(PlaceContact value) { this.contact = value; return this; }
        public PlaceAddress getAddress() { return address; }
        public PlaceBasicApiDto setAddress(PlaceAddress value) { this.address = value; return this; }
        public ArrayList<CategoryTreeApiDto> getCategories() { return categories; }
        public PlaceBasicApiDto setCategories(ArrayList<CategoryTreeApiDto> value) { this.categories = value; return this; }
        public ImageUrls getLogoUrl() { return logoUrl; }
        public PlaceBasicApiDto setLogoUrl(ImageUrls value) { this.logoUrl = value; return this; }
        public ImageUrls getImageUrl() { return imageUrl; }
        public PlaceBasicApiDto setImageUrl(ImageUrls value) { this.imageUrl = value; return this; }
        public ArrayList<WearPriceProfileEsDto> getWearPriceProfiles() { return wearPriceProfiles; }
        public PlaceBasicApiDto setWearPriceProfiles(ArrayList<WearPriceProfileEsDto> value) { this.wearPriceProfiles = value; return this; }
        public ArrayList<PlaceSelectedBrandApiDto> getBrands() { return brands; }
        public PlaceBasicApiDto setBrands(ArrayList<PlaceSelectedBrandApiDto> value) { this.brands = value; return this; }
        public String getFloor() { return floor; }
        public PlaceBasicApiDto setFloor(String value) { this.floor = value; return this; }
    }

    public static class OpeningHours
    {
        public WeeklyOpeningHours weekly = null;
        
        public WeeklyOpeningHours getWeekly() { return weekly; }
        public OpeningHours setWeekly(WeeklyOpeningHours value) { this.weekly = value; return this; }
    }

    public static class WeeklyOpeningHours
    {
        public OpeningHour monday = null;
        public OpeningHour tuesday = null;
        public OpeningHour wednesday = null;
        public OpeningHour thursday = null;
        public OpeningHour friday = null;
        public OpeningHour saturday = null;
        public OpeningHour sunday = null;
        
        public OpeningHour getMonday() { return monday; }
        public WeeklyOpeningHours setMonday(OpeningHour value) { this.monday = value; return this; }
        public OpeningHour getTuesday() { return tuesday; }
        public WeeklyOpeningHours setTuesday(OpeningHour value) { this.tuesday = value; return this; }
        public OpeningHour getWednesday() { return wednesday; }
        public WeeklyOpeningHours setWednesday(OpeningHour value) { this.wednesday = value; return this; }
        public OpeningHour getThursday() { return thursday; }
        public WeeklyOpeningHours setThursday(OpeningHour value) { this.thursday = value; return this; }
        public OpeningHour getFriday() { return friday; }
        public WeeklyOpeningHours setFriday(OpeningHour value) { this.friday = value; return this; }
        public OpeningHour getSaturday() { return saturday; }
        public WeeklyOpeningHours setSaturday(OpeningHour value) { this.saturday = value; return this; }
        public OpeningHour getSunday() { return sunday; }
        public WeeklyOpeningHours setSunday(OpeningHour value) { this.sunday = value; return this; }
    }

    public static class OpeningHour
    {
        public Integer openAtHour = null;
        public Integer openAtMinute = null;
        public Integer closeAtHour = null;
        public Integer closeAtMinute = null;
        
        public Integer getOpenAtHour() { return openAtHour; }
        public OpeningHour setOpenAtHour(Integer value) { this.openAtHour = value; return this; }
        public Integer getOpenAtMinute() { return openAtMinute; }
        public OpeningHour setOpenAtMinute(Integer value) { this.openAtMinute = value; return this; }
        public Integer getCloseAtHour() { return closeAtHour; }
        public OpeningHour setCloseAtHour(Integer value) { this.closeAtHour = value; return this; }
        public Integer getCloseAtMinute() { return closeAtMinute; }
        public OpeningHour setCloseAtMinute(Integer value) { this.closeAtMinute = value; return this; }
    }

    public static enum PlaceType
    {
        Mall,
        Regular;
    }

    public static class PriceMainDishApiDto
    {
        public String title = null;
        public PriceMainDish slug = null;
        
        public String getTitle() { return title; }
        public PriceMainDishApiDto setTitle(String value) { this.title = value; return this; }
        public PriceMainDish getSlug() { return slug; }
        public PriceMainDishApiDto setSlug(PriceMainDish value) { this.slug = value; return this; }
    }

    public static enum PriceMainDish
    {
        Value,
        Medium,
        High,
        FineDining;
    }

    public static class TimeZoneDto
    {
        public TimeSpan baseUtcOffset = null;
        public String daylightName = null;
        public String displayName = null;
        public String id = null;
        public String standardName = null;
        public Boolean supportsDaylightSavingTime = null;
        
        public TimeSpan getBaseUtcOffset() { return baseUtcOffset; }
        public TimeZoneDto setBaseUtcOffset(TimeSpan value) { this.baseUtcOffset = value; return this; }
        public String getDaylightName() { return daylightName; }
        public TimeZoneDto setDaylightName(String value) { this.daylightName = value; return this; }
        public String getDisplayName() { return displayName; }
        public TimeZoneDto setDisplayName(String value) { this.displayName = value; return this; }
        public String getId() { return id; }
        public TimeZoneDto setId(String value) { this.id = value; return this; }
        public String getStandardName() { return standardName; }
        public TimeZoneDto setStandardName(String value) { this.standardName = value; return this; }
        public Boolean isSupportsDaylightSavingTime() { return supportsDaylightSavingTime; }
        public TimeZoneDto setSupportsDaylightSavingTime(Boolean value) { this.supportsDaylightSavingTime = value; return this; }
    }

    public static class PlaceContact
    {
        public String phone = null;
        public String email = null;
        public String website = null;
        public String webShop = null;
        
        public String getPhone() { return phone; }
        public PlaceContact setPhone(String value) { this.phone = value; return this; }
        public String getEmail() { return email; }
        public PlaceContact setEmail(String value) { this.email = value; return this; }
        public String getWebsite() { return website; }
        public PlaceContact setWebsite(String value) { this.website = value; return this; }
        public String getWebShop() { return webShop; }
        public PlaceContact setWebShop(String value) { this.webShop = value; return this; }
    }

    public static class PlaceAddress
    {
        public String street = null;
        public String postalCode = null;
        public String region = null;
        public String countryCode = null;
        
        public String getStreet() { return street; }
        public PlaceAddress setStreet(String value) { this.street = value; return this; }
        public String getPostalCode() { return postalCode; }
        public PlaceAddress setPostalCode(String value) { this.postalCode = value; return this; }
        public String getRegion() { return region; }
        public PlaceAddress setRegion(String value) { this.region = value; return this; }
        public String getCountryCode() { return countryCode; }
        public PlaceAddress setCountryCode(String value) { this.countryCode = value; return this; }
    }

    public static class CategoryTreeApiDto
    {
        public String name = null;
        public String slug = null;
        public String absoluteSlug = null;
        public String imageUrl = null;
        public String allImageUrl = null;
        public String iconImageUrl = null;
        public Integer position = null;
        public ArrayList<CategoryTreeApiDto> children = new ArrayList<CategoryTreeApiDto>();
        
        public String getName() { return name; }
        public CategoryTreeApiDto setName(String value) { this.name = value; return this; }
        public String getSlug() { return slug; }
        public CategoryTreeApiDto setSlug(String value) { this.slug = value; return this; }
        public String getAbsoluteSlug() { return absoluteSlug; }
        public CategoryTreeApiDto setAbsoluteSlug(String value) { this.absoluteSlug = value; return this; }
        public String getImageUrl() { return imageUrl; }
        public CategoryTreeApiDto setImageUrl(String value) { this.imageUrl = value; return this; }
        public String getAllImageUrl() { return allImageUrl; }
        public CategoryTreeApiDto setAllImageUrl(String value) { this.allImageUrl = value; return this; }
        public String getIconImageUrl() { return iconImageUrl; }
        public CategoryTreeApiDto setIconImageUrl(String value) { this.iconImageUrl = value; return this; }
        public Integer getPosition() { return position; }
        public CategoryTreeApiDto setPosition(Integer value) { this.position = value; return this; }
        public ArrayList<CategoryTreeApiDto> getChildren() { return children; }
        public CategoryTreeApiDto setChildren(ArrayList<CategoryTreeApiDto> value) { this.children = value; return this; }
    }

    public static class ImageUrls
    {
        public String preview = null;
        public String small = null;
        public String medium = null;
        public String large = null;
        
        public String getPreview() { return preview; }
        public ImageUrls setPreview(String value) { this.preview = value; return this; }
        public String getSmall() { return small; }
        public ImageUrls setSmall(String value) { this.small = value; return this; }
        public String getMedium() { return medium; }
        public ImageUrls setMedium(String value) { this.medium = value; return this; }
        public String getLarge() { return large; }
        public ImageUrls setLarge(String value) { this.large = value; return this; }
    }

    public static class WearPriceProfileEsDto
    {
        public String slug = null;
        public String label = null;
        
        public String getSlug() { return slug; }
        public WearPriceProfileEsDto setSlug(String value) { this.slug = value; return this; }
        public String getLabel() { return label; }
        public WearPriceProfileEsDto setLabel(String value) { this.label = value; return this; }
    }

    public static class PlaceSelectedBrandApiDto
    {
        public BrandApiDto brand = null;
        public ArrayList<String> categoryAbsoluteSlugs = new ArrayList<String>();
        public PlaceCustomBrandApiDto placeCustomBrand = null;
        
        public BrandApiDto getBrand() { return brand; }
        public PlaceSelectedBrandApiDto setBrand(BrandApiDto value) { this.brand = value; return this; }
        public ArrayList<String> getCategoryAbsoluteSlugs() { return categoryAbsoluteSlugs; }
        public PlaceSelectedBrandApiDto setCategoryAbsoluteSlugs(ArrayList<String> value) { this.categoryAbsoluteSlugs = value; return this; }
        public PlaceCustomBrandApiDto getPlaceCustomBrand() { return placeCustomBrand; }
        public PlaceSelectedBrandApiDto setPlaceCustomBrand(PlaceCustomBrandApiDto value) { this.placeCustomBrand = value; return this; }
    }

    public static class BrandApiDto
    {
        public String name = null;
        
        public String getName() { return name; }
        public BrandApiDto setName(String value) { this.name = value; return this; }
    }

    public static class PlaceCustomBrandApiDto
    {
        public String name = null;
        
        public String getName() { return name; }
        public PlaceCustomBrandApiDto setName(String value) { this.name = value; return this; }
    }

}

Java NextToClaimBusinessRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /business/next-to-claim HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"placeGuid":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"nextStep":"AuthenticateWithVipps","user":{"firstName":"String","lastName":"String","email":"String","legalIdentityVerified":false,"phoneNumber":"String"},"place":{"id":0,"overview":"String","name":"String","longitude":0,"latitude":0,"claimed":false,"organizationNumber":"String","countryCode":"String","openingHours":{"weekly":{"monday":{"openAtHour":0,"openAtMinute":0,"closeAtHour":0,"closeAtMinute":0},"tuesday":{"openAtHour":0,"openAtMinute":0,"closeAtHour":0,"closeAtMinute":0},"wednesday":{"openAtHour":0,"openAtMinute":0,"closeAtHour":0,"closeAtMinute":0},"thursday":{"openAtHour":0,"openAtMinute":0,"closeAtHour":0,"closeAtMinute":0},"friday":{"openAtHour":0,"openAtMinute":0,"closeAtHour":0,"closeAtMinute":0},"saturday":{"openAtHour":0,"openAtMinute":0,"closeAtHour":0,"closeAtMinute":0},"sunday":{"openAtHour":0,"openAtMinute":0,"closeAtHour":0,"closeAtMinute":0}}},"wheelchairAccessible":false,"wifi":false,"outdoorSeating":false,"saveFoodAndMoney":false,"placeType":"Mall","priceMainDish":{"title":"String","slug":"Value"},"timeZoneDto":{"baseUtcOffset":"PT0S","daylightName":"String","displayName":"String","id":"String","standardName":"String","supportsDaylightSavingTime":false},"businessId":0,"contact":{"phone":"String","email":"String","website":"String","webShop":"String"},"address":{"street":"String","postalCode":"String","region":"String","countryCode":"String"},"categories":[{"name":"String","slug":"String","absoluteSlug":"String","imageUrl":"String","allImageUrl":"String","iconImageUrl":"String","position":0,"children":[{"name":"String","slug":"String","absoluteSlug":"String","imageUrl":"String","allImageUrl":"String","iconImageUrl":"String","position":0,"children":[{"name":"String","slug":"String","absoluteSlug":"String","imageUrl":"String","allImageUrl":"String","iconImageUrl":"String","position":0}]}]}],"logoUrl":{"preview":"String","small":"String","medium":"String","large":"String"},"imageUrl":{"preview":"String","small":"String","medium":"String","large":"String"},"wearPriceProfiles":[{"slug":"String","label":"String"}],"brands":[{"brand":{"name":"String"},"categoryAbsoluteSlugs":["String"],"placeCustomBrand":{"name":"String"}}],"floor":"String"}}