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.


export module ConsumerApi
{
    // @ts-nocheck

    export class ReferFriendUser
    {
        public firstName?: string;
        public lastName?: string;
        public profilePhotoUrl?: string;

        public constructor(init?: Partial<ReferFriendUser>) { (Object as any).assign(this, init); }
    }

    export enum ReferFriendState
    {
        Available = 'Available',
        Awarded = 'Awarded',
        CanNotReferYourself = 'CanNotReferYourself',
        YouWereAlreadySignedUp = 'YouWereAlreadySignedUp',
        Expired = 'Expired',
    }

    export class ReferFriendLinkUsedResponse
    {
        public referringUser?: ReferFriendUser;
        public state?: ReferFriendState;

        public constructor(init?: Partial<ReferFriendLinkUsedResponse>) { (Object as any).assign(this, init); }
    }

    export class ReferFriendLinkUsedRequest implements IPost
    {
        public referFriendToken: string;

        public constructor(init?: Partial<ReferFriendLinkUsedRequest>) { (Object as any).assign(this, init); }
    }

}

TypeScript ReferFriendLinkUsedRequest DTOs

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