ShortlinksAPI

<back to all web services

GetAffiliateTokenSetRequest

Requires Authentication
The following routes are available for this service:
GET/v4/short-links
<?php namespace dtos;

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 RefreshableMetadata implements IRefreshableMetadata, JsonSerializable
{
    public function __construct(
        /** @var DateTime */
        public DateTime $createdDate=new DateTime(),
        /** @var DateTime */
        public DateTime $updatedDate=new DateTime()
    ) {
    }

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

class ShortLink implements IShortLink, JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $baseCode=null,
        /** @var string|null */
        public ?string $domain=null,
        /** @var string|null */
        public ?string $username=null,
        /** @var string|null */
        public ?string $affiliateTokensSet=null,
        /** @var RefreshableMetadata|null */
        public ?RefreshableMetadata $metadata=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['baseCode'])) $this->baseCode = $o['baseCode'];
        if (isset($o['domain'])) $this->domain = $o['domain'];
        if (isset($o['username'])) $this->username = $o['username'];
        if (isset($o['affiliateTokensSet'])) $this->affiliateTokensSet = $o['affiliateTokensSet'];
        if (isset($o['metadata'])) $this->metadata = JsonConverters::from('RefreshableMetadata', $o['metadata']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->baseCode)) $o['baseCode'] = $this->baseCode;
        if (isset($this->domain)) $o['domain'] = $this->domain;
        if (isset($this->username)) $o['username'] = $this->username;
        if (isset($this->affiliateTokensSet)) $o['affiliateTokensSet'] = $this->affiliateTokensSet;
        if (isset($this->metadata)) $o['metadata'] = JsonConverters::to('RefreshableMetadata', $this->metadata);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class GetAffiliateTokenSetResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var ShortLink|null */
        public ?ShortLink $result=null,

        // @DataMember
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['result'])) $this->result = JsonConverters::from('ShortLink', $o['result']);
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->result)) $o['result'] = JsonConverters::to('ShortLink', $this->result);
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class GetAffiliateTokenSetRequest implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="baseCode")
        /** @var string|null */
        public ?string $baseCode=null
    ) {
    }

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

PHP GetAffiliateTokenSetRequest DTOs

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

HTTP + OTHER

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

GET /v4/short-links HTTP/1.1 
Host: shortlinks-api.qa.platform.georiot.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"result":{"baseCode":"String","domain":"String","username":"String","affiliateTokensSet":"00000000000000000000000000000000","metadata":{"createdDate":"0001-01-01T00:00:00.0000000","updatedDate":"0001-01-01T00:00:00.0000000"}},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}