ConsumerApi

ReferFriendLinkUsedRequest

Consumer

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

**ReferFriendLinkUsedRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ReferFriendToken	body	string	Yes

**ReferFriendLinkUsedResponse** Parameters:
Name	Parameter	Data Type	Required
ReferringUser	form	ReferFriendUser	No
ExpiresAt	form	DateTimeOffset?	No
State	form	ReferFriendState	No

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

**ReferFriendState** Enum:
Available
Awarded
CanNotReferYourself
YouWereAlreadySignedUp
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-friend-link-used HTTP/1.1 
Host: consumer-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<ReferFriendLinkUsedResponse 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>
  <ReferringUser>
    <FirstName>String</FirstName>
    <LastName>String</LastName>
    <ProfilePhotoUrl>String</ProfilePhotoUrl>
  </ReferringUser>
  <State>Available</State>
</ReferFriendLinkUsedResponse>