Trendsic Platform Service

<back to all web services

FormReadinessRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/readiness
<?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 FormReadinessCheck implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Level=null,
        /** @var string|null */
        public ?string $Text=null,
        /** @var string|null */
        public ?string $FixTab=null,
        /** @var string|null */
        public ?string $FixFieldKey=null,
        /** @var string|null */
        public ?string $FixLabel=null
    ) {
    }

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

class FormReadinessResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<FormReadinessCheck>|null */
        public ?array $Checks=null,
        /** @var array<string>|null */
        public ?array $Changes=null,
        /** @var int */
        public int $NextVersion=0,
        /** @var bool|null */
        public ?bool $IsFirstPublish=null,
        /** @var bool|null */
        public ?bool $NothingChanged=null,
        /** @var bool|null */
        public ?bool $CanPublish=null,
        /** @var int */
        public int $DraftRev=0,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Checks'])) $this->Checks = JsonConverters::fromArray('FormReadinessCheck', $o['Checks']);
        if (isset($o['Changes'])) $this->Changes = JsonConverters::fromArray('string', $o['Changes']);
        if (isset($o['NextVersion'])) $this->NextVersion = $o['NextVersion'];
        if (isset($o['IsFirstPublish'])) $this->IsFirstPublish = $o['IsFirstPublish'];
        if (isset($o['NothingChanged'])) $this->NothingChanged = $o['NothingChanged'];
        if (isset($o['CanPublish'])) $this->CanPublish = $o['CanPublish'];
        if (isset($o['DraftRev'])) $this->DraftRev = $o['DraftRev'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Checks)) $o['Checks'] = JsonConverters::toArray('FormReadinessCheck', $this->Checks);
        if (isset($this->Changes)) $o['Changes'] = JsonConverters::toArray('string', $this->Changes);
        if (isset($this->NextVersion)) $o['NextVersion'] = $this->NextVersion;
        if (isset($this->IsFirstPublish)) $o['IsFirstPublish'] = $this->IsFirstPublish;
        if (isset($this->NothingChanged)) $o['NothingChanged'] = $this->NothingChanged;
        if (isset($this->CanPublish)) $o['CanPublish'] = $this->CanPublish;
        if (isset($this->DraftRev)) $o['DraftRev'] = $this->DraftRev;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class FormReadinessRequest 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 FormReadinessRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/forms/{FormUID}/readiness HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv

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

{"Checks":[{"Level":"String","Text":"String","FixTab":"String","FixFieldKey":"String","FixLabel":"String"}],"Changes":["String"],"NextVersion":0,"IsFirstPublish":false,"NothingChanged":false,"CanPublish":false,"DraftRev":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}