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

PUT /v1/forms/{FormUID}/settings HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormSettingsSaveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
  <SettingsJson>String</SettingsJson>
  <SettingsRev>0</SettingsRev>
</FormSettingsSaveRequest>

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

<FormSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DraftsInProgress>0</DraftsInProgress>
  <Link>String</Link>
  <LinkPaused>String</LinkPaused>
  <OfferChecks>
    <FormReadinessCheck>
      <FixFieldKey>String</FixFieldKey>
      <FixLabel>String</FixLabel>
      <FixTab>String</FixTab>
      <Level>String</Level>
      <Text>String</Text>
    </FormReadinessCheck>
  </OfferChecks>
  <ResponseStatus 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>
  </ResponseStatus>
  <SettingsJson>String</SettingsJson>
  <SettingsRev>0</SettingsRev>
</FormSettingsResponse>