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 Foundation
import ServiceStack

public class NextToClaimBusinessRequest : IPost, Codable
{
    public var placeGuid:String?

    required public init(){}
}

public class NextToClaimBusinessResponse : Codable
{
    public var nextStep:NextClaimStep
    public var user:ClaimUserInfo
    public var place:PlaceBasicApiDto

    required public init(){}
}

public enum NextClaimStep : String, Codable
{
    case AuthenticateWithVipps
    case CreatePassword
    case AcceptBusinessTermsOfService
    case Claim
    case Completed
}

public class ClaimUserInfo : Codable
{
    public var firstName:String
    public var lastName:String
    public var email:String
    public var legalIdentityVerified:Bool
    public var phoneNumber:String

    required public init(){}
}

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

    required public init(){}
}

public class OpeningHours : Codable
{
    public var weekly:WeeklyOpeningHours

    required public init(){}
}

public class WeeklyOpeningHours : Codable
{
    public var monday:OpeningHour
    public var tuesday:OpeningHour
    public var wednesday:OpeningHour
    public var thursday:OpeningHour
    public var friday:OpeningHour
    public var saturday:OpeningHour
    public var sunday:OpeningHour

    required public init(){}
}

public class OpeningHour : Codable
{
    public var openAtHour:Int
    public var openAtMinute:Int
    public var closeAtHour:Int
    public var closeAtMinute:Int

    required public init(){}
}

public enum PlaceType : String, Codable
{
    case Mall
    case Regular
}

public class PriceMainDishApiDto : Codable
{
    public var title:String
    public var slug:PriceMainDish

    required public init(){}
}

public enum PriceMainDish : String, Codable
{
    case Value
    case Medium
    case High
    case FineDining
}

public class TimeZoneDto : Codable
{
    @TimeSpan public var baseUtcOffset:TimeInterval
    public var daylightName:String
    public var displayName:String
    public var id:String
    public var standardName:String
    public var supportsDaylightSavingTime:Bool

    required public init(){}
}

public class PlaceContact : Codable
{
    public var phone:String
    public var email:String
    public var website:String
    public var webShop:String

    required public init(){}
}

public class PlaceAddress : Codable
{
    public var street:String
    public var postalCode:String
    public var region:String
    public var countryCode:String

    required public init(){}
}

public class CategoryTreeApiDto : Codable
{
    public var name:String
    public var slug:String
    public var absoluteSlug:String
    public var imageUrl:String
    public var allImageUrl:String
    public var iconImageUrl:String
    public var position:Int
    public var children:[CategoryTreeApiDto] = []

    required public init(){}
}

public class ImageUrls : Codable
{
    public var preview:String
    public var small:String
    public var medium:String
    public var large:String

    required public init(){}
}

public class WearPriceProfileEsDto : Codable
{
    public var slug:String
    public var label:String

    required public init(){}
}

public class PlaceSelectedBrandApiDto : Codable
{
    public var brand:BrandApiDto
    public var categoryAbsoluteSlugs:[String] = []
    public var placeCustomBrand:PlaceCustomBrandApiDto

    required public init(){}
}

public class BrandApiDto : Codable
{
    public var name:String

    required public init(){}
}

public class PlaceCustomBrandApiDto : Codable
{
    public var name:String

    required public init(){}
}


Swift NextToClaimBusinessRequest DTOs

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

HTTP + 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
	}
}