Required role: | Consumer |
POST | /business/next-to-claim |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PlaceGuid | body | Guid? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
NextStep | form | NextClaimStep | No | |
User | form | ClaimUserInfo | Yes | |
Place | form | PlaceBasicApiDto | Yes |
AuthenticateWithVipps | |
CreatePassword | |
AcceptBusinessTermsOfService | |
Claim | |
Completed |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FirstName | form | string | No | |
LastName | form | string | No | |
form | string | Yes | ||
LegalIdentityVerified | form | bool | No | |
PhoneNumber | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
Guid | form | Guid | No | |
Overview | form | string | No | |
Name | form | string | Yes | |
Longitude | form | float | No | |
Latitude | form | float | No | |
Claimed | form | bool | No | |
OrganizationNumber | form | string | No | |
CountryCode | form | string | Yes | |
OpeningHours | form | OpeningHours | No | |
WheelchairAccessible | form | bool? | No | |
Wifi | form | bool? | No | |
OutdoorSeating | form | bool? | No | |
SaveFoodAndMoney | form | bool? | No | |
PlaceType | form | PlaceType | No | |
PriceMainDish | form | PriceMainDishApiDto | No | |
TimeZoneDto | form | TimeZoneDto | Yes | |
BusinessId | form | long? | No | |
Contact | form | PlaceContact | Yes | |
Address | form | PlaceAddress | Yes | |
Categories | form | List<CategoryTreeApiDto> | Yes | |
LogoUrl | form | ImageUrls | No | |
ImageUrl | form | ImageUrls | No | |
WearPriceProfiles | form | List<WearPriceProfileEsDto> | Yes | |
Brands | form | List<PlaceSelectedBrandApiDto> | Yes | |
Floor | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Weekly | form | WeeklyOpeningHours | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Monday | form | OpeningHour | No | |
Tuesday | form | OpeningHour | No | |
Wednesday | form | OpeningHour | No | |
Thursday | form | OpeningHour | No | |
Friday | form | OpeningHour | No | |
Saturday | form | OpeningHour | No | |
Sunday | form | OpeningHour | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OpenAtHour | form | int | No | |
OpenAtMinute | form | int | No | |
CloseAtHour | form | int | No | |
CloseAtMinute | form | int | No |
Mall | |
Regular |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Title | form | string | Yes | |
Slug | form | PriceMainDish | No |
Value | |
Medium | |
High | |
FineDining |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BaseUtcOffset | form | TimeSpan | No | |
DaylightName | form | string | Yes | |
DisplayName | form | string | Yes | |
Id | form | string | Yes | |
StandardName | form | string | Yes | |
SupportsDaylightSavingTime | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Phone | form | string | No | |
form | string | No | ||
Website | form | string | No | |
WebShop | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Street | form | string | Yes | |
PostalCode | form | string | Yes | |
Region | form | string | Yes | |
CountryCode | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes | |
Slug | form | string | Yes | |
AbsoluteSlug | form | string | Yes | |
ImageUrl | form | string | No | |
AllImageUrl | form | string | No | |
IconImageUrl | form | string | No | |
Position | form | int | No | |
Children | form | List<CategoryTreeApiDto> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Preview | form | string | Yes | |
Small | form | string | Yes | |
Medium | form | string | Yes | |
Large | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Slug | form | string | Yes | |
Label | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Brand | form | BrandApiDto | No | |
CategoryAbsoluteSlugs | form | string[] | No | |
PlaceCustomBrand | form | PlaceCustomBrandApiDto | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
placeGuid: 00000000-0000-0000-0000-000000000000
}
HTTP/1.1 200 OK Content-Type: text/jsv 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 } }