Trendsic Platform Service

FormSettingsSaveRequest

The following routes are available for this service:
PUT	/v1/forms/{FormUID}/settings

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


class FormReadinessCheck implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Level=null,
        /** @var string|null */
        public ?string $Text=null,
        /** @var string|null */
        public ?string $FixTab=null,
        /** @var string|null */
        public ?string $FixFieldKey=null,
        /** @var string|null */
        public ?string $FixLabel=null
    ) {
    }

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

class FormSettingsResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $SettingsJson=null,
        /** @var int */
        public int $SettingsRev=0,
        /** @var string|null */
        public ?string $Link=null,
        /** @var string|null */
        public ?string $LinkPaused=null,
        /** @var array<FormReadinessCheck>|null */
        public ?array $OfferChecks=null,
        /** @var int */
        public int $DraftsInProgress=0,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['SettingsJson'])) $this->SettingsJson = $o['SettingsJson'];
        if (isset($o['SettingsRev'])) $this->SettingsRev = $o['SettingsRev'];
        if (isset($o['Link'])) $this->Link = $o['Link'];
        if (isset($o['LinkPaused'])) $this->LinkPaused = $o['LinkPaused'];
        if (isset($o['OfferChecks'])) $this->OfferChecks = JsonConverters::fromArray('FormReadinessCheck', $o['OfferChecks']);
        if (isset($o['DraftsInProgress'])) $this->DraftsInProgress = $o['DraftsInProgress'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->SettingsJson)) $o['SettingsJson'] = $this->SettingsJson;
        if (isset($this->SettingsRev)) $o['SettingsRev'] = $this->SettingsRev;
        if (isset($this->Link)) $o['Link'] = $this->Link;
        if (isset($this->LinkPaused)) $o['LinkPaused'] = $this->LinkPaused;
        if (isset($this->OfferChecks)) $o['OfferChecks'] = JsonConverters::toArray('FormReadinessCheck', $this->OfferChecks);
        if (isset($this->DraftsInProgress)) $o['DraftsInProgress'] = $this->DraftsInProgress;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class FormSettingsSaveRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $FormUID='',
        /** @var string|null */
        public ?string $SettingsJson=null,
        /** @var int */
        public int $SettingsRev=0
    ) {
    }

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

PHP FormSettingsSaveRequest 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 /v1/forms/{FormUID}/settings HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FormUID: 00000000000000000000000000000000,
	SettingsJson: String,
	SettingsRev: 0
}

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

{
	SettingsJson: String,
	SettingsRev: 0,
	Link: String,
	LinkPaused: String,
	OfferChecks: 
	[
		{
			Level: String,
			Text: String,
			FixTab: String,
			FixFieldKey: String,
			FixLabel: String
		}
	],
	DraftsInProgress: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}