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.
SharePlaceLinkRequest Parameters:
NameParameterData TypeRequiredDescription
PlaceIdquerylong?Yes
SharePlaceLinkResponse Parameters:
NameParameterData TypeRequiredDescription
LinkWithSharePlaceTokenformstringYes

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

HTTP + CSV

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: consumer-api.brovs.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"linkWithSharePlaceToken":"String"}