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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ReferBusinessLinkUsedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
  <ReferBusinessToken>String</ReferBusinessToken>
</ReferBusinessLinkUsedRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReferBusinessLinkUsedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
  <ExpiresAt xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </ExpiresAt>
  <ReferredPlace>
    <Guid>00000000-0000-0000-0000-000000000000</Guid>
    <Id>0</Id>
    <ImageUrl>String</ImageUrl>
    <LogoUrl>String</LogoUrl>
    <Name>String</Name>
  </ReferredPlace>
  <ReferringUser>
    <FirstName>String</FirstName>
    <LastName>String</LastName>
    <ProfilePhotoUrl>String</ProfilePhotoUrl>
  </ReferringUser>
  <State>SignInToSee</State>
</ReferBusinessLinkUsedResponse>