Trendsic Platform Service

<back to all web services

FormDraftRequest

Requires Authentication
The following routes are available for this service:
PUT/v1/forms/{FormUID}/draft
<?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 FormDraftResponse implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $DraftRev=0,
        /** @var bool|null */
        public ?bool $DraftDirty=null,
        /** @var array<string>|null */
        public ?array $Warnings=null,
        /** @var array<string>|null */
        public ?array $AlwaysHidden=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

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

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

PHP FormDraftRequest 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}/draft HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormDraftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DraftJson>String</DraftJson>
  <DraftRev>0</DraftRev>
  <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
  <SettingsJson>String</SettingsJson>
</FormDraftRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormDraftResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AlwaysHidden xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AlwaysHidden>
  <DraftDirty>false</DraftDirty>
  <DraftRev>0</DraftRev>
  <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>
  <Warnings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Warnings>
</FormDraftResponse>