ShortlinksAPI

<back to all web services

PutUserLinkRequest

<?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 PutUserLinkResponse 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 PutUserLinkRequest extends V4BaseRequest implements IPutUserLinkRequest, JsonSerializable
{
    public function __construct(
        // @DataMember(Name="id")
        /** @var string|null */
        public ?string $id=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['id'])) $this->id = $o['id'];
        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->id)) $o['id'] = $this->id;
        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 PutUserLinkRequest DTOs

PUT /v4/links HTTP/1.1 
Host: shortlinks-api.qa.platform.georiot.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	linkType: None,
	typeDefinitionPublicId: String
}

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

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