| 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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
referBusinessToken: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
referringUser:
{
firstName: String,
lastName: String,
profilePhotoUrl: String
},
referredPlace:
{
id: 0,
name: String,
logoUrl: String,
imageUrl: String
},
state: SignInToSee
}