ShortlinksAPI

PostUserLinkRequest

The following routes are available for this service:
POST	/v4/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};


// @DataContract
class V4BaseRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class V4BaseResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="status")
        /** @var ResponseStatus|null */
        public ?ResponseStatus $status=null
    ) {
    }

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

// @DataContract
class PostUserLinkResponse extends V4BaseResponse implements JsonSerializable
{
    /**
     * @param ResponseStatus|null $status
     */
    public function __construct(
        ?ResponseStatus $status=null
    ) {
        parent::__construct($status);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        return empty($o) ? new class(){} : $o;
    }
}

enum LinkType : string
{
    case None = 'None';
    case Simple = 'Simple';
    case Split = 'Split';
    case Interstitial = 'Interstitial';
    case Advanced = 'Advanced';
    case Collection = 'Collection';
}

// @DataContract
class PostUserLinkRequest extends V4BaseRequest implements IPostUserLinkRequest, JsonSerializable
{
    public function __construct(
        // @DataMember(Name="baseCode")
        /** @var string|null */
        public ?string $baseCode=null,

        // @DataMember(Name="linkType")
        /** @var LinkType|null */
        public ?LinkType $linkType=null,

        // @DataMember(Name="typeDefinitionPublicId")
        /** @var string|null */
        public ?string $typeDefinitionPublicId=null
    ) {
    }

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

PHP PostUserLinkRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /v4/links HTTP/1.1 
Host: shortlinks-api.qa.platform.georiot.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"baseCode":"String","linkType":"None","typeDefinitionPublicId":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"status":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}