ConsumerApi

<back to all web services

ReferFriendLinkRequest

Consumer
Requires Authentication
Required role:Consumer
The following routes are available for this service:
GET/share/refer-friend-linkCreate a friend referral linkThe link contains a JWT token with the identity of the referring user as well as the expiration of the referral.
ReferFriendLinkResponse Parameters:
NameParameterData TypeRequiredDescription
LinkWithReferFriendTokenformstringYes

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.

GET /share/refer-friend-link HTTP/1.1 
Host: consumer-api.brovs.com 
Accept: application/xml

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

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