ConsumerApi

NextToClaimBusinessRequest

ConsumerBusiness

**Requires Authentication**
Required role:	Consumer

The following routes are available for this service:
POST	/business/next-to-claim

namespace ConsumerApi

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type NextClaimStep =
        | AuthenticateWithVipps = 0
        | CreatePassword = 1
        | AcceptBusinessTermsOfService = 2
        | Claim = 3
        | Completed = 4

    [<AllowNullLiteral>]
    type ClaimUserInfo() = 
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val Email:String = null with get,set
        member val LegalIdentityVerified:Boolean = new Boolean() with get,set
        member val PhoneNumber:String = null with get,set

    [<AllowNullLiteral>]
    type OpeningHour() = 
        member val OpenAtHour:Int32 = new Int32() with get,set
        member val OpenAtMinute:Int32 = new Int32() with get,set
        member val CloseAtHour:Int32 = new Int32() with get,set
        member val CloseAtMinute:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type WeeklyOpeningHours() = 
        member val Monday:OpeningHour = null with get,set
        member val Tuesday:OpeningHour = null with get,set
        member val Wednesday:OpeningHour = null with get,set
        member val Thursday:OpeningHour = null with get,set
        member val Friday:OpeningHour = null with get,set
        member val Saturday:OpeningHour = null with get,set
        member val Sunday:OpeningHour = null with get,set

    [<AllowNullLiteral>]
    type OpeningHours() = 
        member val Weekly:WeeklyOpeningHours = null with get,set

    type PlaceType =
        | Mall = 0
        | Regular = 1

    type PriceMainDish =
        | Value = 0
        | Medium = 1
        | High = 2
        | FineDining = 3

    [<AllowNullLiteral>]
    type PriceMainDishApiDto() = 
        member val Title:String = null with get,set
        member val Slug:PriceMainDish = new PriceMainDish() with get,set

    [<AllowNullLiteral>]
    type TimeZoneDto() = 
        member val BaseUtcOffset:TimeSpan = new TimeSpan() with get,set
        member val DaylightName:String = null with get,set
        member val DisplayName:String = null with get,set
        member val Id:String = null with get,set
        member val StandardName:String = null with get,set
        member val SupportsDaylightSavingTime:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type PlaceContact() = 
        member val Phone:String = null with get,set
        member val Email:String = null with get,set
        member val Website:String = null with get,set
        member val WebShop:String = null with get,set

    [<AllowNullLiteral>]
    type PlaceAddress() = 
        member val Street:String = null with get,set
        member val PostalCode:String = null with get,set
        member val Region:String = null with get,set
        member val CountryCode:String = null with get,set

    [<AllowNullLiteral>]
    type CategoryTreeApiDto() = 
        member val Name:String = null with get,set
        member val Slug:String = null with get,set
        member val AbsoluteSlug:String = null with get,set
        member val ImageUrl:String = null with get,set
        member val AllImageUrl:String = null with get,set
        member val IconImageUrl:String = null with get,set
        member val Position:Int32 = new Int32() with get,set
        member val Children:ResizeArray<CategoryTreeApiDto> = new ResizeArray<CategoryTreeApiDto>() with get,set

    [<AllowNullLiteral>]
    type ImageUrls() = 
        member val Preview:String = null with get,set
        member val Small:String = null with get,set
        member val Medium:String = null with get,set
        member val Large:String = null with get,set

    [<AllowNullLiteral>]
    type WearPriceProfileEsDto() = 
        member val Slug:String = null with get,set
        member val Label:String = null with get,set

    [<AllowNullLiteral>]
    type BrandApiDto() = 
        member val Name:String = null with get,set

    [<AllowNullLiteral>]
    type PlaceCustomBrandApiDto() = 
        member val Name:String = null with get,set

    [<AllowNullLiteral>]
    type PlaceSelectedBrandApiDto() = 
        member val Brand:BrandApiDto = null with get,set
        member val CategoryAbsoluteSlugs:String[] = [||] with get,set
        member val PlaceCustomBrand:PlaceCustomBrandApiDto = null with get,set

    [<AllowNullLiteral>]
    type PlaceBasicApiDto() = 
        member val Id:Int64 = new Int64() with get,set
        member val Guid:Guid = new Guid() with get,set
        member val Overview:String = null with get,set
        member val Name:String = null with get,set
        member val Longitude:Single = new Single() with get,set
        member val Latitude:Single = new Single() with get,set
        member val Claimed:Boolean = new Boolean() with get,set
        member val OrganizationNumber:String = null with get,set
        member val CountryCode:String = null with get,set
        member val OpeningHours:OpeningHours = null with get,set
        member val WheelchairAccessible:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val Wifi:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val OutdoorSeating:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val SaveFoodAndMoney:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val PlaceType:PlaceType = new PlaceType() with get,set
        member val PriceMainDish:PriceMainDishApiDto = null with get,set
        member val TimeZoneDto:TimeZoneDto = null with get,set
        member val BusinessId:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val Contact:PlaceContact = null with get,set
        member val Address:PlaceAddress = null with get,set
        member val Categories:ResizeArray<CategoryTreeApiDto> = new ResizeArray<CategoryTreeApiDto>() with get,set
        member val LogoUrl:ImageUrls = null with get,set
        member val ImageUrl:ImageUrls = null with get,set
        member val WearPriceProfiles:ResizeArray<WearPriceProfileEsDto> = new ResizeArray<WearPriceProfileEsDto>() with get,set
        member val Brands:ResizeArray<PlaceSelectedBrandApiDto> = new ResizeArray<PlaceSelectedBrandApiDto>() with get,set
        member val Floor:String = null with get,set

    [<AllowNullLiteral>]
    type NextToClaimBusinessResponse() = 
        member val NextStep:NextClaimStep = new NextClaimStep() with get,set
        member val User:ClaimUserInfo = null with get,set
        member val Place:PlaceBasicApiDto = null with get,set

    [<AllowNullLiteral>]
    type NextToClaimBusinessRequest() = 
        interface IPost
        member val PlaceGuid:Nullable<Guid> = new Nullable<Guid>() with get,set

F# NextToClaimBusinessRequest DTOs

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

HTTP + XML

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: consumer-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<NextToClaimBusinessRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
  <PlaceGuid>00000000-0000-0000-0000-000000000000</PlaceGuid>
</NextToClaimBusinessRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NextToClaimBusinessResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
  <NextStep>AuthenticateWithVipps</NextStep>
  <Place>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:CountryCode>String</d3p1:CountryCode>
      <d3p1:PostalCode>String</d3p1:PostalCode>
      <d3p1:Region>String</d3p1:Region>
      <d3p1:Street>String</d3p1:Street>
    </Address>
    <Brands>
      <PlaceSelectedBrandApiDto>
        <Brand>
          <Name>String</Name>
        </Brand>
        <CategoryAbsoluteSlugs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </CategoryAbsoluteSlugs>
        <PlaceCustomBrand>
          <Name>String</Name>
        </PlaceCustomBrand>
      </PlaceSelectedBrandApiDto>
    </Brands>
    <BusinessId>0</BusinessId>
    <Categories>
      <CategoryTreeApiDto>
        <AbsoluteSlug>String</AbsoluteSlug>
        <AllImageUrl>String</AllImageUrl>
        <Children>
          <CategoryTreeApiDto>
            <AbsoluteSlug>String</AbsoluteSlug>
            <AllImageUrl>String</AllImageUrl>
            <Children>
              <CategoryTreeApiDto>
                <AbsoluteSlug>String</AbsoluteSlug>
                <AllImageUrl>String</AllImageUrl>
                <Children i:nil="true" />
                <IconImageUrl>String</IconImageUrl>
                <ImageUrl>String</ImageUrl>
                <Name>String</Name>
                <Position>0</Position>
                <Slug>String</Slug>
              </CategoryTreeApiDto>
            </Children>
            <IconImageUrl>String</IconImageUrl>
            <ImageUrl>String</ImageUrl>
            <Name>String</Name>
            <Position>0</Position>
            <Slug>String</Slug>
          </CategoryTreeApiDto>
        </Children>
        <IconImageUrl>String</IconImageUrl>
        <ImageUrl>String</ImageUrl>
        <Name>String</Name>
        <Position>0</Position>
        <Slug>String</Slug>
      </CategoryTreeApiDto>
    </Categories>
    <Claimed>false</Claimed>
    <Contact xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:Email>String</d3p1:Email>
      <d3p1:Phone>String</d3p1:Phone>
      <d3p1:WebShop>String</d3p1:WebShop>
      <d3p1:Website>String</d3p1:Website>
    </Contact>
    <CountryCode>String</CountryCode>
    <Floor>String</Floor>
    <Guid>00000000-0000-0000-0000-000000000000</Guid>
    <Id>0</Id>
    <ImageUrl xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:Large>String</d3p1:Large>
      <d3p1:Medium>String</d3p1:Medium>
      <d3p1:Preview>String</d3p1:Preview>
      <d3p1:Small>String</d3p1:Small>
    </ImageUrl>
    <Latitude>0</Latitude>
    <LogoUrl xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:Large>String</d3p1:Large>
      <d3p1:Medium>String</d3p1:Medium>
      <d3p1:Preview>String</d3p1:Preview>
      <d3p1:Small>String</d3p1:Small>
    </LogoUrl>
    <Longitude>0</Longitude>
    <Name>String</Name>
    <OpeningHours xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:Weekly>
        <d3p1:Friday>
          <d3p1:CloseAtHour>0</d3p1:CloseAtHour>
          <d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
          <d3p1:OpenAtHour>0</d3p1:OpenAtHour>
          <d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
        </d3p1:Friday>
        <d3p1:Monday>
          <d3p1:CloseAtHour>0</d3p1:CloseAtHour>
          <d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
          <d3p1:OpenAtHour>0</d3p1:OpenAtHour>
          <d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
        </d3p1:Monday>
        <d3p1:Saturday>
          <d3p1:CloseAtHour>0</d3p1:CloseAtHour>
          <d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
          <d3p1:OpenAtHour>0</d3p1:OpenAtHour>
          <d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
        </d3p1:Saturday>
        <d3p1:Sunday>
          <d3p1:CloseAtHour>0</d3p1:CloseAtHour>
          <d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
          <d3p1:OpenAtHour>0</d3p1:OpenAtHour>
          <d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
        </d3p1:Sunday>
        <d3p1:Thursday>
          <d3p1:CloseAtHour>0</d3p1:CloseAtHour>
          <d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
          <d3p1:OpenAtHour>0</d3p1:OpenAtHour>
          <d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
        </d3p1:Thursday>
        <d3p1:Tuesday>
          <d3p1:CloseAtHour>0</d3p1:CloseAtHour>
          <d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
          <d3p1:OpenAtHour>0</d3p1:OpenAtHour>
          <d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
        </d3p1:Tuesday>
        <d3p1:Wednesday>
          <d3p1:CloseAtHour>0</d3p1:CloseAtHour>
          <d3p1:CloseAtMinute>0</d3p1:CloseAtMinute>
          <d3p1:OpenAtHour>0</d3p1:OpenAtHour>
          <d3p1:OpenAtMinute>0</d3p1:OpenAtMinute>
        </d3p1:Wednesday>
      </d3p1:Weekly>
    </OpeningHours>
    <OrganizationNumber>String</OrganizationNumber>
    <OutdoorSeating>false</OutdoorSeating>
    <Overview>String</Overview>
    <PlaceType>Mall</PlaceType>
    <PriceMainDish>
      <Slug>Value</Slug>
      <Title>String</Title>
    </PriceMainDish>
    <SaveFoodAndMoney>false</SaveFoodAndMoney>
    <TimeZoneDto xmlns:d3p1="http://schemas.datacontract.org/2004/07/Entities.Common">
      <d3p1:BaseUtcOffset>PT0S</d3p1:BaseUtcOffset>
      <d3p1:DaylightName>String</d3p1:DaylightName>
      <d3p1:DisplayName>String</d3p1:DisplayName>
      <d3p1:Id>String</d3p1:Id>
      <d3p1:StandardName>String</d3p1:StandardName>
      <d3p1:SupportsDaylightSavingTime>false</d3p1:SupportsDaylightSavingTime>
    </TimeZoneDto>
    <WearPriceProfiles>
      <WearPriceProfileEsDto>
        <Label>String</Label>
        <Slug>String</Slug>
      </WearPriceProfileEsDto>
    </WearPriceProfiles>
    <WheelchairAccessible>false</WheelchairAccessible>
    <Wifi>false</Wifi>
  </Place>
  <User>
    <Email>String</Email>
    <FirstName>String</FirstName>
    <LastName>String</LastName>
    <LegalIdentityVerified>false</LegalIdentityVerified>
    <PhoneNumber>String</PhoneNumber>
  </User>
</NextToClaimBusinessResponse>