CollectionsAPI

PutCollectionSettingsRequest

The following routes are available for this service:
PUT	/v4/collections/settings
PUT	/v4/collections/settings/{Id}

<?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;
    }
}

enum SignatureAppearance : string
{
    case None = 'none';
    case Text = 'text';
    case Upload = 'upload';
}

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

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

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

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

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

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['profileImageId'])) $this->profileImageId = $o['profileImageId'];
        if (isset($o['signatureImageId'])) $this->signatureImageId = $o['signatureImageId'];
        if (isset($o['signatureText'])) $this->signatureText = $o['signatureText'];
        if (isset($o['signatureFont'])) $this->signatureFont = $o['signatureFont'];
        if (isset($o['signatureAppearance'])) $this->signatureAppearance = JsonConverters::from('SignatureAppearance', $o['signatureAppearance']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->profileImageId)) $o['profileImageId'] = $this->profileImageId;
        if (isset($this->signatureImageId)) $o['signatureImageId'] = $this->signatureImageId;
        if (isset($this->signatureText)) $o['signatureText'] = $this->signatureText;
        if (isset($this->signatureFont)) $o['signatureFont'] = $this->signatureFont;
        if (isset($this->signatureAppearance)) $o['signatureAppearance'] = JsonConverters::to('SignatureAppearance', $this->signatureAppearance);
        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 PutCollectionSettingsResponse 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;
    }
}

// @DataContract
class PutCollectionSettingsRequest extends CollectionSettingsBaseRequest implements IPutCollectionSettingsRequest, JsonSerializable
{
    /**
     * @param string|null $profileImageId
     * @param string|null $signatureImageId
     * @param string|null $signatureText
     * @param string|null $signatureFont
     * @param SignatureAppearance|null $signatureAppearance
     */
    public function __construct(
        ?string $profileImageId=null,
        ?string $signatureImageId=null,
        ?string $signatureText=null,
        ?string $signatureFont=null,
        ?SignatureAppearance $signatureAppearance=null,
        // @DataMember(Name="id")
        /** @var string|null */
        public ?string $id=null
    ) {
        parent::__construct($profileImageId,$signatureImageId,$signatureText,$signatureFont,$signatureAppearance);
    }

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

PHP PutCollectionSettingsRequest 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.

PUT /v4/collections/settings HTTP/1.1 
Host: collections-api-zane.dev.platform.georiot.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	profileImageId: String,
	signatureImageId: String,
	signatureText: String,
	signatureFont: String,
	signatureAppearance: none
}

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
		}
	}
}