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.


export module ConsumerApi
{
    // @ts-nocheck

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

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

    export class ReferredPlace
    {
        public id?: number;
        public guid?: string;
        public name: string;
        public logoUrl?: string;
        public imageUrl?: string;

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

    export enum ReferBusinessState
    {
        SignInToSee = 'SignInToSee',
        Available = 'Available',
        CanNotReferYourself = 'CanNotReferYourself',
        AlreadyClaimedByYou = 'AlreadyClaimedByYou',
        AlreadyClaimedBySomeoneElse = 'AlreadyClaimedBySomeoneElse',
        Expired = 'Expired',
    }

    export class ReferBusinessLinkUsedResponse
    {
        public referringUser?: ReferBusinessUser;
        public referredPlace?: ReferredPlace;
        public state?: ReferBusinessState;

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

    export class ReferBusinessLinkUsedRequest implements IPost
    {
        public referBusinessToken: string;

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

}

TypeScript ReferBusinessLinkUsedRequest 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-business-link-used HTTP/1.1 
Host: unstable-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">
  <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>