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.

"use strict";
export class ReferBusinessUser {
    /** @param {{firstName?:string,lastName?:string,profilePhotoUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    firstName;
    /** @type {string} */
    lastName;
    /** @type {?string} */
    profilePhotoUrl;
}
export class ReferredPlace {
    /** @param {{id?:number,guid?:string,name?:string,logoUrl?:string,imageUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    id;
    /** @type {?string} */
    guid;
    /** @type {string} */
    name;
    /** @type {?string} */
    logoUrl;
    /** @type {?string} */
    imageUrl;
}
/** @typedef {'SignInToSee'|'Available'|'CanNotReferYourself'|'AlreadyClaimedByYou'|'AlreadyClaimedBySomeoneElse'|'Expired'} */
export var ReferBusinessState;
(function (ReferBusinessState) {
    ReferBusinessState["SignInToSee"] = "SignInToSee"
    ReferBusinessState["Available"] = "Available"
    ReferBusinessState["CanNotReferYourself"] = "CanNotReferYourself"
    ReferBusinessState["AlreadyClaimedByYou"] = "AlreadyClaimedByYou"
    ReferBusinessState["AlreadyClaimedBySomeoneElse"] = "AlreadyClaimedBySomeoneElse"
    ReferBusinessState["Expired"] = "Expired"
})(ReferBusinessState || (ReferBusinessState = {}));
export class ReferBusinessLinkUsedResponse {
    /** @param {{referringUser?:ReferBusinessUser,referredPlace?:ReferredPlace,state?:ReferBusinessState}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?ReferBusinessUser} */
    referringUser;
    /** @type {?ReferredPlace} */
    referredPlace;
    /** @type {?ReferBusinessState} */
    state;
}
export class ReferBusinessLinkUsedRequest {
    /** @param {{referBusinessToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    referBusinessToken;
}

JavaScript 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>