ConsumerApi

ReferBusinessLinkUsedRequest

ConsumerBusiness

The following routes are available for this service:
POST	/share/refer-business-link-used	A business referral link was used	Validates the JWT token with the identity of the referring user and the place, and returns relevant information.

**ReferBusinessLinkUsedRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ReferBusinessToken	body	string	Yes

**ReferBusinessLinkUsedResponse** Parameters:
Name	Parameter	Data Type	Required
ReferringUser	form	ReferBusinessUser	No
ReferredPlace	form	ReferredPlace	No
ExpiresAt	form	DateTimeOffset?	No
State	form	ReferBusinessState	No

**ReferBusinessUser** Parameters:
Name	Parameter	Data Type	Required
FirstName	form	string	Yes
LastName	form	string	Yes
ProfilePhotoUrl	form	string	No

**ReferredPlace** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Guid	form	Guid	No
Name	form	string	Yes
LogoUrl	form	string	No
ImageUrl	form	string	No

**ReferBusinessState** Enum:
SignInToSee
Available
CanNotReferYourself
AlreadyClaimedByYou
AlreadyClaimedBySomeoneElse
Expired

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 /share/refer-business-link-used HTTP/1.1 
Host: consumer-api.brovs.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	referBusinessToken: String
}

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

{
	referringUser: 
	{
		firstName: String,
		lastName: String,
		profilePhotoUrl: String
	},
	referredPlace: 
	{
		id: 0,
		name: String,
		logoUrl: String,
		imageUrl: String
	},
	expiresAt: 0001-01-01T00:00:00.0000000+00:00,
	state: SignInToSee
}