Trendsic Platform Service

<back to all web services

FormVersionsRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/versions
<?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 FormVersionRow implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $VersionNo=0,
        /** @var DateTime|null */
        public ?DateTime $PublishedAt=null,
        /** @var string|null */
        public ?string $PublishedBy=null,
        /** @var string|null */
        public ?string $Notes=null,
        /** @var array<string>|null */
        public ?array $Changes=null,
        /** @var bool|null */
        public ?bool $IsLive=null,
        /** @var int */
        public int $Submissions=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['VersionNo'])) $this->VersionNo = $o['VersionNo'];
        if (isset($o['PublishedAt'])) $this->PublishedAt = JsonConverters::from('DateTime', $o['PublishedAt']);
        if (isset($o['PublishedBy'])) $this->PublishedBy = $o['PublishedBy'];
        if (isset($o['Notes'])) $this->Notes = $o['Notes'];
        if (isset($o['Changes'])) $this->Changes = JsonConverters::fromArray('string', $o['Changes']);
        if (isset($o['IsLive'])) $this->IsLive = $o['IsLive'];
        if (isset($o['Submissions'])) $this->Submissions = $o['Submissions'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->VersionNo)) $o['VersionNo'] = $this->VersionNo;
        if (isset($this->PublishedAt)) $o['PublishedAt'] = JsonConverters::to('DateTime', $this->PublishedAt);
        if (isset($this->PublishedBy)) $o['PublishedBy'] = $this->PublishedBy;
        if (isset($this->Notes)) $o['Notes'] = $this->Notes;
        if (isset($this->Changes)) $o['Changes'] = JsonConverters::toArray('string', $this->Changes);
        if (isset($this->IsLive)) $o['IsLive'] = $this->IsLive;
        if (isset($this->Submissions)) $o['Submissions'] = $this->Submissions;
        return empty($o) ? new class(){} : $o;
    }
}

class FormVersionsResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<FormVersionRow>|null */
        public ?array $Versions=null,
        /** @var array<string>|null */
        public ?array $DraftChanges=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class FormVersionsRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $FormUID=''
    ) {
    }

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

PHP FormVersionsRequest 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/{FormUID}/versions HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormVersionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DraftChanges xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DraftChanges>
  <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>
  <Versions>
    <FormVersionRow>
      <Changes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Changes>
      <IsLive>false</IsLive>
      <Notes>String</Notes>
      <PublishedAt>0001-01-01T00:00:00</PublishedAt>
      <PublishedBy>String</PublishedBy>
      <Submissions>0</Submissions>
      <VersionNo>0</VersionNo>
    </FormVersionRow>
  </Versions>
</FormVersionsResponse>