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 .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Versions":[{"VersionNo":0,"PublishedAt":"0001-01-01T00:00:00.0000000","PublishedBy":"String","Notes":"String","Changes":["String"],"IsLive":false,"Submissions":0}],"DraftChanges":["String"],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}