Booklinker.API

PostCollectionRequest

The following routes are available for this service:
POST	/v2/collections

<?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 V2BaseRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

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

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

// @DataContract
class PostCollectionResponse extends V2BaseResponse implements IPostCollectionResponse, JsonSerializable
{
    /**
     * @param ResponseStatus|null $responseStatus
     */
    public function __construct(
        ?ResponseStatus $responseStatus=null
    ) {
        parent::__construct($responseStatus);
    }

    /** @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;
    }
}

// @DataContract
class PostCollectionRequest extends V2BaseRequest implements IPostCollectionRequest, JsonSerializable
{
    public function __construct(
        // @DataMember(Name="aliasDomain")
        /** @var string|null */
        public ?string $aliasDomain=null,

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

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

        // @DataMember(Name="linkIds")
        /** @var array<string>|null */
        public ?array $linkIds=null,

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

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['aliasDomain'])) $this->aliasDomain = $o['aliasDomain'];
        if (isset($o['aliasCode'])) $this->aliasCode = $o['aliasCode'];
        if (isset($o['title'])) $this->title = $o['title'];
        if (isset($o['linkIds'])) $this->linkIds = JsonConverters::fromArray('string', $o['linkIds']);
        if (isset($o['collectionSettingsId'])) $this->collectionSettingsId = $o['collectionSettingsId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->aliasDomain)) $o['aliasDomain'] = $this->aliasDomain;
        if (isset($this->aliasCode)) $o['aliasCode'] = $this->aliasCode;
        if (isset($this->title)) $o['title'] = $this->title;
        if (isset($this->linkIds)) $o['linkIds'] = JsonConverters::toArray('string', $this->linkIds);
        if (isset($this->collectionSettingsId)) $o['collectionSettingsId'] = $this->collectionSettingsId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP PostCollectionRequest DTOs

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

HTTP + JSV

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

POST /v2/collections HTTP/1.1 
Host: api.booklinker.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	aliasDomain: String,
	aliasCode: String,
	title: String,
	collectionSettingsId: String
}

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

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