BusinessApi

<back to all web services

UserStatusRequest

Business
The following routes are available for this service:
GET/user/status
UserStatusResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformBusinessUserStatusNo
UserDtoformBusinessUserDtoNo
InvitationsformList<StaffInvitationDto>No
RolesformList<string>No
BusinessesformList<BusinessDto>No
PlacesformList<PlaceBasicDto>No
BusinessUserStatus Enum:
SignInOrUp
MustCompleteConsumerSignup
MustProvideEmailAddress
MustConfirmEmailAddress
MustAcceptTermsOfService
Ready
BusinessUserDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
EmailformstringNo
FirstNameformstringNo
LastNameformstringNo
MobilePhoneformstringYes
LegalIdentityVerifiedformboolNo
LocaleformLocaleNo
Locale Enum:
EnUs
NbNo
StaffInvitationDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
UserIdformlong?No
PlaceIdformlong?No
PlaceGuidformGuid?No
InviteKeyformstringYes
BusinessIdformlong?No
FirstNameformstringNo
LastNameformstringNo
PlaceNameformstringNo
BusinessNameformstringNo
RoleformStaffRoleNo
BusinessRoleformBusinessRoleNo
CreatedAtformDateTimeNo
UpdatedAtformDateTimeNo
StaffRole Enum:
Owner
Admin
Regular
BusinessRole Enum:
Owner
Manager
Sales
Marketing
Other
BusinessDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringYes
OrganizationNumberformstringNo
StreetAddressformstringYes
PostalCodeformstringYes
CityformstringYes
CountryformstringYes
ContactformBusinessContactNo
BusinessContact Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringYes
LastNameformstringYes
PositionformstringYes
PhoneformstringNo
EmailformstringNo
PlaceBasicDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
GuidformGuidNo
NameformstringYes
BusinessIdformlong?No
Longitudeformfloat?No
Latitudeformfloat?No
ClaimedformboolNo
OrganizationNumberformstringNo
CountryCodeformstringYes
OverviewformstringNo
OpeningHoursformOpeningHoursNo
PlaceTypeformPlaceTypeNo
ContactformPlaceContactYes
AddressformPlaceAddressYes
WheelChairAccessibleformbool?No
Wififormbool?No
OutdoorSeatingformbool?No
SaveFoodAndMoneyformbool?No
TimeZoneDtoformTimeZoneDtoYes
PriceMainDishformPriceMainDishDtoNo
OtherServicesformList<MallOtherServiceDto>No
FloorformstringNo
OpeningHours Parameters:
NameParameterData TypeRequiredDescription
WeeklyformWeeklyOpeningHoursYes
WeeklyOpeningHours Parameters:
NameParameterData TypeRequiredDescription
MondayformOpeningHourNo
TuesdayformOpeningHourNo
WednesdayformOpeningHourNo
ThursdayformOpeningHourNo
FridayformOpeningHourNo
SaturdayformOpeningHourNo
SundayformOpeningHourNo
OpeningHour Parameters:
NameParameterData TypeRequiredDescription
OpenAtHourformintNo
OpenAtMinuteformintNo
CloseAtHourformintNo
CloseAtMinuteformintNo
PlaceType Enum:
Mall
Regular
PlaceContact Parameters:
NameParameterData TypeRequiredDescription
PhoneformstringNo
EmailformstringNo
WebsiteformstringNo
WebShopformstringNo
PlaceAddress Parameters:
NameParameterData TypeRequiredDescription
StreetformstringYes
PostalCodeformstringYes
RegionformstringYes
CountryCodeformstringYes
TimeZoneDto Parameters:
NameParameterData TypeRequiredDescription
BaseUtcOffsetformTimeSpanNo
DaylightNameformstringYes
DisplayNameformstringYes
IdformstringYes
StandardNameformstringYes
SupportsDaylightSavingTimeformboolNo
PriceMainDishDto Parameters:
NameParameterData TypeRequiredDescription
TitleformstringYes
SlugformPriceMainDishNo
PriceMainDish Enum:
Value
Medium
High
FineDining
MallOtherServiceDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ServiceNameformstringYes
FloorformstringYes

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.

GET /user/status HTTP/1.1 
Host: business-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	status: SignInOrUp,
	userDto: 
	{
		id: 0,
		email: String,
		firstName: String,
		lastName: String,
		mobilePhone: String,
		legalIdentityVerified: False,
		locale: EnUs
	},
	invitations: 
	[
		{
			id: 0,
			userId: 0,
			placeId: 0,
			placeGuid: 00000000-0000-0000-0000-000000000000,
			inviteKey: String,
			businessId: 0,
			firstName: String,
			lastName: String,
			placeName: String,
			businessName: String,
			role: Owner,
			businessRole: Owner,
			createdAt: 0001-01-01,
			updatedAt: 0001-01-01
		}
	],
	roles: 
	[
		String
	],
	businesses: 
	[
		{
			id: 0,
			name: String,
			organizationNumber: String,
			streetAddress: String,
			postalCode: String,
			city: String,
			country: String,
			contact: 
			{
				firstName: String,
				lastName: String,
				position: String,
				phone: String,
				email: String
			}
		}
	],
	places: 
	[
		{
			id: 0,
			name: String,
			businessId: 0,
			longitude: 0,
			latitude: 0,
			claimed: False,
			organizationNumber: String,
			countryCode: String,
			overview: 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
					}
				}
			},
			placeType: Mall,
			contact: 
			{
				phone: String,
				email: String,
				website: String,
				webShop: String
			},
			address: 
			{
				street: String,
				postalCode: String,
				region: String,
				countryCode: String
			},
			wheelChairAccessible: False,
			wifi: False,
			outdoorSeating: False,
			saveFoodAndMoney: False,
			timeZoneDto: 
			{
				baseUtcOffset: PT0S,
				daylightName: String,
				displayName: String,
				id: String,
				standardName: String,
				supportsDaylightSavingTime: False
			},
			priceMainDish: 
			{
				title: String,
				slug: Value
			},
			otherServices: 
			[
				{
					id: 0,
					serviceName: String,
					floor: String
				}
			],
			floor: String
		}
	]
}