Trendsic Platform Service

FormStartersRequest

The following routes are available for this service:
GET	/v1/forms/starters

<?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 FormStarter implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $TemplateUID='',
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Noun=null,
        /** @var string|null */
        public ?string $NumberPrefix=null,
        /** @var string|null */
        public ?string $Description=null,
        /** @var string|null */
        public ?string $Pack=null,
        /** @var string|null */
        public ?string $PackName=null,
        /** @var bool|null */
        public ?bool $IsTenantTemplate=null,
        /** @var string|null */
        public ?string $PayloadJson=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TemplateUID'])) $this->TemplateUID = $o['TemplateUID'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Noun'])) $this->Noun = $o['Noun'];
        if (isset($o['NumberPrefix'])) $this->NumberPrefix = $o['NumberPrefix'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['Pack'])) $this->Pack = $o['Pack'];
        if (isset($o['PackName'])) $this->PackName = $o['PackName'];
        if (isset($o['IsTenantTemplate'])) $this->IsTenantTemplate = $o['IsTenantTemplate'];
        if (isset($o['PayloadJson'])) $this->PayloadJson = $o['PayloadJson'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TemplateUID)) $o['TemplateUID'] = $this->TemplateUID;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Noun)) $o['Noun'] = $this->Noun;
        if (isset($this->NumberPrefix)) $o['NumberPrefix'] = $this->NumberPrefix;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->Pack)) $o['Pack'] = $this->Pack;
        if (isset($this->PackName)) $o['PackName'] = $this->PackName;
        if (isset($this->IsTenantTemplate)) $o['IsTenantTemplate'] = $this->IsTenantTemplate;
        if (isset($this->PayloadJson)) $o['PayloadJson'] = $this->PayloadJson;
        return empty($o) ? new class(){} : $o;
    }
}

class FormStartersResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<FormStarter>|null */
        public ?array $Starters=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class FormStartersRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP FormStartersRequest 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/forms/starters HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<FormStartersResponse 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>
  <Starters>
    <FormStarter>
      <Description>String</Description>
      <IsTenantTemplate>false</IsTenantTemplate>
      <Name>String</Name>
      <Noun>String</Noun>
      <NumberPrefix>String</NumberPrefix>
      <Pack>String</Pack>
      <PackName>String</PackName>
      <PayloadJson>String</PayloadJson>
      <TemplateUID>00000000-0000-0000-0000-000000000000</TemplateUID>
    </FormStarter>
  </Starters>
</FormStartersResponse>