ConsumerApi

UserStatusRequest

Consumer

The following routes are available for this service:
GET	/user/status

**UserStatusRequest** Parameters:
Name	Parameter	Data Type	Required	Description
FromPwa	query	bool?	Yes

**UserStatusResponse** Parameters:
Name	Parameter	Data Type	Required
Status	form	UserStatus	No
SuggestPwaInstallation	form	bool	No
UserProfile	form	UserProfileDto	No
BusinessInvites	form	List<StaffInviteSmallDto>	No

**UserStatus** Enum:
LoginOrSignup
CompleteProfile
Ready

**UserProfileDto** Parameters:
Name	Parameter	Data Type	Required
Locale	form	Locale	No
UserGuid	form	Guid	No
FirstName	form	string	No
LastName	form	string	No
ProfilePhotoUrl	form	string	No
MobilePhone	form	string	Yes
MobilePhoneVerified	form	bool	No
Email	form	string	No
EmailVerified	form	bool	No
HasPassword	form	bool	No
DateOfBirth	form	DateOfBirth	Yes
Sex	form	Sex?	No
Home	form	HomeLocation	Yes
ShowDistancesIn	form	DistanceUnit	No
LegalIdentityVerified	form	bool	No
ManagesPlacesInBusinessWeb	form	bool	No
HasAccessToBackofficeWeb	form	bool	No
PointsTotal	form	long	No

**Locale** Enum:
EnUs
NbNo

**DateOfBirth** Parameters:
Name	Parameter	Data Type	Required
Year	form	int	No
Month	form	int	No
DayOfMonth	form	int	No

**Sex** Enum:
Male
Female

**HomeLocation** Parameters:
Name	Parameter	Data Type	Required
Address	form	UserAddress	Yes
Latitude	form	float	No
Longitude	form	float	No

**UserAddress** Parameters:
Name	Parameter	Data Type	Required
StreetName	form	string	Yes
StreetNumber	form	string	Yes
PostalCode	form	string	Yes
Region	form	string	Yes
CountryCode	form	string	Yes

**DistanceUnit** Enum:
Kilometer
Mile

**StaffInviteSmallDto** Parameters:
Name	Parameter	Data Type	Required
InviteKey	form	string	Yes
Name	form	string	Yes
InvitingUserName	form	string	Yes

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: unstable-consumer-api.brovs.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	status: LoginOrSignup,
	suggestPwaInstallation: False,
	userProfile: 
	{
		locale: EnUs,
		firstName: String,
		lastName: String,
		profilePhotoUrl: String,
		mobilePhone: String,
		mobilePhoneVerified: False,
		email: String,
		emailVerified: False,
		hasPassword: False,
		dateOfBirth: 
		{
			year: 0,
			month: 0,
			dayOfMonth: 0
		},
		sex: Male,
		home: 
		{
			address: 
			{
				streetName: String,
				streetNumber: String,
				postalCode: String,
				region: String,
				countryCode: String
			},
			latitude: 0,
			longitude: 0
		},
		showDistancesIn: Kilometer,
		legalIdentityVerified: False,
		managesPlacesInBusinessWeb: False,
		hasAccessToBackofficeWeb: False,
		pointsTotal: 0
	},
	businessInvites: 
	[
		{
			inviteKey: String,
			name: String,
			invitingUserName: String
		}
	]
}