Trendsic Platform Service

<back to all web services

PlanSetStatusRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/plansets/{PlanSetUID}/status
<?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 PlanSetStatusResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var string */
        public string $PlanSetUID='',
        /** @var string|null */
        public ?string $Status=null,
        /** @var int */
        public int $Progress=0,
        /** @var int */
        public int $PageCount=0,
        /** @var int */
        public int $SheetCount=0,
        /** @var string|null */
        public ?string $ErrorText=null,
        /** @var string|null */
        public ?string $StageLabel=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['PlanSetUID'])) $this->PlanSetUID = $o['PlanSetUID'];
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['Progress'])) $this->Progress = $o['Progress'];
        if (isset($o['PageCount'])) $this->PageCount = $o['PageCount'];
        if (isset($o['SheetCount'])) $this->SheetCount = $o['SheetCount'];
        if (isset($o['ErrorText'])) $this->ErrorText = $o['ErrorText'];
        if (isset($o['StageLabel'])) $this->StageLabel = $o['StageLabel'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->PlanSetUID)) $o['PlanSetUID'] = $this->PlanSetUID;
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->Progress)) $o['Progress'] = $this->Progress;
        if (isset($this->PageCount)) $o['PageCount'] = $this->PageCount;
        if (isset($this->SheetCount)) $o['SheetCount'] = $this->SheetCount;
        if (isset($this->ErrorText)) $o['ErrorText'] = $this->ErrorText;
        if (isset($this->StageLabel)) $o['StageLabel'] = $this->StageLabel;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

PHP PlanSetStatusRequest 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/plansets/{PlanSetUID}/status HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl

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

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"PlanSetUID":"00000000000000000000000000000000","Status":"String","Progress":0,"PageCount":0,"SheetCount":0,"ErrorText":"String","StageLabel":"String"}