ConsumerApi

NextToClaimBusinessRequest

ConsumerBusiness

**Requires Authentication**
Required role:	Consumer

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


export module ConsumerApi
{
    // @ts-nocheck

    export enum NextClaimStep
    {
        AuthenticateWithVipps = 'AuthenticateWithVipps',
        CreatePassword = 'CreatePassword',
        AcceptBusinessTermsOfService = 'AcceptBusinessTermsOfService',
        Claim = 'Claim',
        Completed = 'Completed',
    }

    export class ClaimUserInfo
    {
        public firstName?: string;
        public lastName?: string;
        public email: string;
        public legalIdentityVerified?: boolean;
        public phoneNumber: string;

        public constructor(init?: Partial<ClaimUserInfo>) { (Object as any).assign(this, init); }
    }

    export class OpeningHour
    {
        public openAtHour?: number;
        public openAtMinute?: number;
        public closeAtHour?: number;
        public closeAtMinute?: number;

        public constructor(init?: Partial<OpeningHour>) { (Object as any).assign(this, init); }
    }

    export class WeeklyOpeningHours
    {
        public monday?: OpeningHour;
        public tuesday?: OpeningHour;
        public wednesday?: OpeningHour;
        public thursday?: OpeningHour;
        public friday?: OpeningHour;
        public saturday?: OpeningHour;
        public sunday?: OpeningHour;

        public constructor(init?: Partial<WeeklyOpeningHours>) { (Object as any).assign(this, init); }
    }

    export class OpeningHours
    {
        public weekly: WeeklyOpeningHours;

        public constructor(init?: Partial<OpeningHours>) { (Object as any).assign(this, init); }
    }

    export enum PlaceType
    {
        Mall = 'Mall',
        Regular = 'Regular',
    }

    export enum PriceMainDish
    {
        Value = 'Value',
        Medium = 'Medium',
        High = 'High',
        FineDining = 'FineDining',
    }

    export class PriceMainDishApiDto
    {
        public title: string;
        public slug?: PriceMainDish;

        public constructor(init?: Partial<PriceMainDishApiDto>) { (Object as any).assign(this, init); }
    }

    export class TimeZoneDto
    {
        public baseUtcOffset?: string;
        public daylightName: string;
        public displayName: string;
        public id: string;
        public standardName: string;
        public supportsDaylightSavingTime?: boolean;

        public constructor(init?: Partial<TimeZoneDto>) { (Object as any).assign(this, init); }
    }

    export class PlaceContact
    {
        public phone?: string;
        public email?: string;
        public website?: string;
        public webShop?: string;

        public constructor(init?: Partial<PlaceContact>) { (Object as any).assign(this, init); }
    }

    export class PlaceAddress
    {
        public street: string;
        public postalCode: string;
        public region: string;
        public countryCode: string;

        public constructor(init?: Partial<PlaceAddress>) { (Object as any).assign(this, init); }
    }

    export class CategoryTreeApiDto
    {
        public name: string;
        public slug: string;
        public absoluteSlug: string;
        public imageUrl?: string;
        public allImageUrl?: string;
        public iconImageUrl?: string;
        public position?: number;
        public children?: CategoryTreeApiDto[] = [];

        public constructor(init?: Partial<CategoryTreeApiDto>) { (Object as any).assign(this, init); }
    }

    export class ImageUrls
    {
        public preview: string;
        public small: string;
        public medium: string;
        public large: string;

        public constructor(init?: Partial<ImageUrls>) { (Object as any).assign(this, init); }
    }

    export class WearPriceProfileEsDto
    {
        public slug: string;
        public label: string;

        public constructor(init?: Partial<WearPriceProfileEsDto>) { (Object as any).assign(this, init); }
    }

    export class BrandApiDto
    {
        public name: string;

        public constructor(init?: Partial<BrandApiDto>) { (Object as any).assign(this, init); }
    }

    export class PlaceCustomBrandApiDto
    {
        public name: string;

        public constructor(init?: Partial<PlaceCustomBrandApiDto>) { (Object as any).assign(this, init); }
    }

    export class PlaceSelectedBrandApiDto
    {
        public brand?: BrandApiDto;
        public categoryAbsoluteSlugs?: string[] = [];
        public placeCustomBrand?: PlaceCustomBrandApiDto;

        public constructor(init?: Partial<PlaceSelectedBrandApiDto>) { (Object as any).assign(this, init); }
    }

    export class PlaceBasicApiDto
    {
        public id?: number;
        public guid?: string;
        public overview?: string;
        public name: string;
        public longitude?: number;
        public latitude?: number;
        public claimed?: boolean;
        public organizationNumber?: string;
        public countryCode: string;
        public openingHours?: OpeningHours;
        public wheelchairAccessible?: boolean;
        public wifi?: boolean;
        public outdoorSeating?: boolean;
        public saveFoodAndMoney?: boolean;
        public placeType?: PlaceType;
        public priceMainDish?: PriceMainDishApiDto;
        public timeZoneDto: TimeZoneDto;
        public businessId?: number;
        public contact: PlaceContact;
        public address: PlaceAddress;
        public categories: CategoryTreeApiDto[] = [];
        public logoUrl?: ImageUrls;
        public imageUrl?: ImageUrls;
        public wearPriceProfiles: WearPriceProfileEsDto[] = [];
        public brands: PlaceSelectedBrandApiDto[] = [];
        public floor?: string;

        public constructor(init?: Partial<PlaceBasicApiDto>) { (Object as any).assign(this, init); }
    }

    export class NextToClaimBusinessResponse
    {
        public nextStep?: NextClaimStep;
        public user: ClaimUserInfo;
        public place: PlaceBasicApiDto;

        public constructor(init?: Partial<NextToClaimBusinessResponse>) { (Object as any).assign(this, init); }
    }

    export class NextToClaimBusinessRequest implements IPost
    {
        public placeGuid?: string;

        public constructor(init?: Partial<NextToClaimBusinessRequest>) { (Object as any).assign(this, init); }
    }

}

TypeScript 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>