ConsumerApi

<back to all web services

SharePlaceLinkRequest

Consumer
Requires Authentication
Required role:Consumer
The following routes are available for this service:
GET/share/share-place-linkCreate a share place linkThe link contains a JWT token with the identity of the referring user and the shared place as well as the expiration of the link.
"use strict";
export class SharePlaceLinkResponse {
    /** @param {{linkWithSharePlaceToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    linkWithSharePlaceToken;
}
export class SharePlaceLinkRequest {
    /** @param {{placeId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    placeId;
}

JavaScript SharePlaceLinkRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /share/share-place-link HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	linkWithSharePlaceToken: String
}