Trendsic Platform Service

<back to all web services

FormFillRequestRequest

The following routes are available for this service:
GET/v1/formfill/status/{Token}/request
<?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 FormFillRequestResponse implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $Open=null,
        /** @var string|null */
        public ?string $RequestUID=null,
        /** @var string|null */
        public ?string $Note=null,
        /** @var string|null */
        public ?string $From=null,
        /** @var string|null */
        public ?string $Number=null,
        /** @var string|null */
        public ?string $FormName=null,
        /** @var string|null */
        public ?string $Noun=null,
        /** @var string|null */
        public ?string $NounEs=null,
        /** @var string|null */
        public ?string $TenantName=null,
        /** @var string|null */
        public ?string $Lang=null,
        /** @var string|null */
        public ?string $Today=null,
        /** @var array<string>|null */
        public ?array $Keys=null,
        /** @var array<string>|null */
        public ?array $Resign=null,
        /** @var array<string>|null */
        public ?array $SignKeys=null,
        /** @var array<string>|null */
        public ?array $Sensitive=null,
        /** @var string|null */
        public ?string $AppJson=null,
        /** @var string|null */
        public ?string $AnswersJson=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Open'])) $this->Open = $o['Open'];
        if (isset($o['RequestUID'])) $this->RequestUID = $o['RequestUID'];
        if (isset($o['Note'])) $this->Note = $o['Note'];
        if (isset($o['From'])) $this->From = $o['From'];
        if (isset($o['Number'])) $this->Number = $o['Number'];
        if (isset($o['FormName'])) $this->FormName = $o['FormName'];
        if (isset($o['Noun'])) $this->Noun = $o['Noun'];
        if (isset($o['NounEs'])) $this->NounEs = $o['NounEs'];
        if (isset($o['TenantName'])) $this->TenantName = $o['TenantName'];
        if (isset($o['Lang'])) $this->Lang = $o['Lang'];
        if (isset($o['Today'])) $this->Today = $o['Today'];
        if (isset($o['Keys'])) $this->Keys = JsonConverters::fromArray('string', $o['Keys']);
        if (isset($o['Resign'])) $this->Resign = JsonConverters::fromArray('string', $o['Resign']);
        if (isset($o['SignKeys'])) $this->SignKeys = JsonConverters::fromArray('string', $o['SignKeys']);
        if (isset($o['Sensitive'])) $this->Sensitive = JsonConverters::fromArray('string', $o['Sensitive']);
        if (isset($o['AppJson'])) $this->AppJson = $o['AppJson'];
        if (isset($o['AnswersJson'])) $this->AnswersJson = $o['AnswersJson'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Open)) $o['Open'] = $this->Open;
        if (isset($this->RequestUID)) $o['RequestUID'] = $this->RequestUID;
        if (isset($this->Note)) $o['Note'] = $this->Note;
        if (isset($this->From)) $o['From'] = $this->From;
        if (isset($this->Number)) $o['Number'] = $this->Number;
        if (isset($this->FormName)) $o['FormName'] = $this->FormName;
        if (isset($this->Noun)) $o['Noun'] = $this->Noun;
        if (isset($this->NounEs)) $o['NounEs'] = $this->NounEs;
        if (isset($this->TenantName)) $o['TenantName'] = $this->TenantName;
        if (isset($this->Lang)) $o['Lang'] = $this->Lang;
        if (isset($this->Today)) $o['Today'] = $this->Today;
        if (isset($this->Keys)) $o['Keys'] = JsonConverters::toArray('string', $this->Keys);
        if (isset($this->Resign)) $o['Resign'] = JsonConverters::toArray('string', $this->Resign);
        if (isset($this->SignKeys)) $o['SignKeys'] = JsonConverters::toArray('string', $this->SignKeys);
        if (isset($this->Sensitive)) $o['Sensitive'] = JsonConverters::toArray('string', $this->Sensitive);
        if (isset($this->AppJson)) $o['AppJson'] = $this->AppJson;
        if (isset($this->AnswersJson)) $o['AnswersJson'] = $this->AnswersJson;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class FormFillRequestRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Token=null
    ) {
    }

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

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

GET /v1/formfill/status/{Token}/request HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormFillRequestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AnswersJson>String</AnswersJson>
  <AppJson>String</AppJson>
  <FormName>String</FormName>
  <From>String</From>
  <Keys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Keys>
  <Lang>String</Lang>
  <Note>String</Note>
  <Noun>String</Noun>
  <NounEs>String</NounEs>
  <Number>String</Number>
  <Open>false</Open>
  <RequestUID>String</RequestUID>
  <Resign xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Resign>
  <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>
  <Sensitive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Sensitive>
  <SignKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SignKeys>
  <TenantName>String</TenantName>
  <Today>String</Today>
</FormFillRequestResponse>