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.
<?php namespace ConsumerApi;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class SharePlaceLinkResponse implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $linkWithSharePlaceToken=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['linkWithSharePlaceToken'])) $this->linkWithSharePlaceToken = $o['linkWithSharePlaceToken'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->linkWithSharePlaceToken)) $o['linkWithSharePlaceToken'] = $this->linkWithSharePlaceToken;
        return empty($o) ? new class(){} : $o;
    }
}

class SharePlaceLinkRequest implements IGet, JsonSerializable
{
    public function __construct(
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $placeId=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['placeId'])) $this->placeId = $o['placeId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->placeId)) $o['placeId'] = $this->placeId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP SharePlaceLinkRequest DTOs

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

{"linkWithSharePlaceToken":"String"}