CollectionsAPI

PostCollectionRequest

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

/**
 * @property string|null $id
 */
interface IPostCollectionResponseData
{
}

// @DataContract
class PostCollectionResponse extends V4BaseResponse implements IPostCollectionResponse, JsonSerializable
{
    /**
     * @param ResponseStatus|null $status
     */
    public function __construct(
        ?ResponseStatus $status=null,
        // @DataMember(Name="data")
        /** @var IPostCollectionResponseData|null */
        public ?IPostCollectionResponseData $data=null
    ) {
        parent::__construct($status);
    }

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

// @DataContract
class PostCollectionRequest extends V4BaseRequest implements IPostCollectionRequest, JsonSerializable
{
    public function __construct(
        // @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['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->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 .xml suffix or ?format=xml

HTTP + XML

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

POST /v4/collections HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostCollectionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CollectionsAPI.ServiceModel.V4.Requests">
  <collectionSettingsId>String</collectionSettingsId>
  <linkIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <title>String</title>
</PostCollectionRequest>

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

<PostCollectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CollectionsAPI.ServiceModel.V4.Responses">
  <status xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </status>
  <data i:nil="true" />
</PostCollectionResponse>