Trendsic Platform Service

FormFillStartRequest

The following routes are available for this service:
POST	/v1/formfill/{TenantSlug}/{FormSlug}/start

<?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 FormFillStartResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Token=null,
        /** @var int */
        public int $Rev=0,
        /** @var string|null */
        public ?string $StatusUrl=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class FormFillStartRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $TenantSlug=null,
        /** @var string|null */
        public ?string $FormSlug=null,
        /** @var string|null */
        public ?string $TurnstileToken=null,
        /** @var string|null */
        public ?string $Invite=null,
        /** @var string|null */
        public ?string $Lang=null,
        /** @var array<string,string>|null */
        public ?array $Params=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TenantSlug'])) $this->TenantSlug = $o['TenantSlug'];
        if (isset($o['FormSlug'])) $this->FormSlug = $o['FormSlug'];
        if (isset($o['TurnstileToken'])) $this->TurnstileToken = $o['TurnstileToken'];
        if (isset($o['Invite'])) $this->Invite = $o['Invite'];
        if (isset($o['Lang'])) $this->Lang = $o['Lang'];
        if (isset($o['Params'])) $this->Params = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['Params']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TenantSlug)) $o['TenantSlug'] = $this->TenantSlug;
        if (isset($this->FormSlug)) $o['FormSlug'] = $this->FormSlug;
        if (isset($this->TurnstileToken)) $o['TurnstileToken'] = $this->TurnstileToken;
        if (isset($this->Invite)) $o['Invite'] = $this->Invite;
        if (isset($this->Lang)) $o['Lang'] = $this->Lang;
        if (isset($this->Params)) $o['Params'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->Params);
        return empty($o) ? new class(){} : $o;
    }
}

PHP FormFillStartRequest 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 /v1/formfill/{TenantSlug}/{FormSlug}/start HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormFillStartRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FormSlug>String</FormSlug>
  <Invite>String</Invite>
  <Lang>String</Lang>
  <Params xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Params>
  <TenantSlug>String</TenantSlug>
  <TurnstileToken>String</TurnstileToken>
</FormFillStartRequest>

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

<FormFillStartResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Rev>0</Rev>
  <StatusUrl>String</StatusUrl>
  <Token>String</Token>
</FormFillStartResponse>