Trendsic Platform Service

<back to all web services

SubmittalDetailRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/projects/{ProjectID}/submittals/{SubmittalID}
<?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 Submittal implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $SubmittalID=0,
        /** @var string */
        public string $SubmittalUID='',
        /** @var int */
        public int $ProjectID=0,
        /** @var string|null */
        public ?string $SubmittalNo=null,
        /** @var string|null */
        public ?string $SpecSection=null,
        /** @var string|null */
        public ?string $Title=null,
        /** @var string|null */
        public ?string $SubType=null,
        /** @var int */
        public int $Rev=0,
        /** @var string|null */
        public ?string $BallInCourt=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var DateTime|null */
        public ?DateTime $DueDate=null,
        /** @var DateTime|null */
        public ?DateTime $SubmittedDate=null,
        /** @var DateTime|null */
        public ?DateTime $DecidedDate=null,
        /** @var string|null */
        public ?string $Notes=null,
        /** @var string|null */
        public ?string $CreatedBy=null,
        /** @var DateTime|null */
        public ?DateTime $CreatedAt=null,
        /** @var DateTime|null */
        public ?DateTime $UpdatedAt=null,
        /** @var bool|null */
        public ?bool $IsOverdue=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['SubmittalID'])) $this->SubmittalID = $o['SubmittalID'];
        if (isset($o['SubmittalUID'])) $this->SubmittalUID = $o['SubmittalUID'];
        if (isset($o['ProjectID'])) $this->ProjectID = $o['ProjectID'];
        if (isset($o['SubmittalNo'])) $this->SubmittalNo = $o['SubmittalNo'];
        if (isset($o['SpecSection'])) $this->SpecSection = $o['SpecSection'];
        if (isset($o['Title'])) $this->Title = $o['Title'];
        if (isset($o['SubType'])) $this->SubType = $o['SubType'];
        if (isset($o['Rev'])) $this->Rev = $o['Rev'];
        if (isset($o['BallInCourt'])) $this->BallInCourt = $o['BallInCourt'];
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['DueDate'])) $this->DueDate = JsonConverters::from('DateTime', $o['DueDate']);
        if (isset($o['SubmittedDate'])) $this->SubmittedDate = JsonConverters::from('DateTime', $o['SubmittedDate']);
        if (isset($o['DecidedDate'])) $this->DecidedDate = JsonConverters::from('DateTime', $o['DecidedDate']);
        if (isset($o['Notes'])) $this->Notes = $o['Notes'];
        if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
        if (isset($o['CreatedAt'])) $this->CreatedAt = JsonConverters::from('DateTime', $o['CreatedAt']);
        if (isset($o['UpdatedAt'])) $this->UpdatedAt = JsonConverters::from('DateTime', $o['UpdatedAt']);
        if (isset($o['IsOverdue'])) $this->IsOverdue = $o['IsOverdue'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->SubmittalID)) $o['SubmittalID'] = $this->SubmittalID;
        if (isset($this->SubmittalUID)) $o['SubmittalUID'] = $this->SubmittalUID;
        if (isset($this->ProjectID)) $o['ProjectID'] = $this->ProjectID;
        if (isset($this->SubmittalNo)) $o['SubmittalNo'] = $this->SubmittalNo;
        if (isset($this->SpecSection)) $o['SpecSection'] = $this->SpecSection;
        if (isset($this->Title)) $o['Title'] = $this->Title;
        if (isset($this->SubType)) $o['SubType'] = $this->SubType;
        if (isset($this->Rev)) $o['Rev'] = $this->Rev;
        if (isset($this->BallInCourt)) $o['BallInCourt'] = $this->BallInCourt;
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->DueDate)) $o['DueDate'] = JsonConverters::to('DateTime', $this->DueDate);
        if (isset($this->SubmittedDate)) $o['SubmittedDate'] = JsonConverters::to('DateTime', $this->SubmittedDate);
        if (isset($this->DecidedDate)) $o['DecidedDate'] = JsonConverters::to('DateTime', $this->DecidedDate);
        if (isset($this->Notes)) $o['Notes'] = $this->Notes;
        if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
        if (isset($this->CreatedAt)) $o['CreatedAt'] = JsonConverters::to('DateTime', $this->CreatedAt);
        if (isset($this->UpdatedAt)) $o['UpdatedAt'] = JsonConverters::to('DateTime', $this->UpdatedAt);
        if (isset($this->IsOverdue)) $o['IsOverdue'] = $this->IsOverdue;
        return empty($o) ? new class(){} : $o;
    }
}

class SubmittalResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var Submittal|null */
        public ?Submittal $Submittal=null
    ) {
    }

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

class SubmittalDetailRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ProjectID=0,
        /** @var int */
        public int $SubmittalID=0
    ) {
    }

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

PHP SubmittalDetailRequest 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/projects/{ProjectID}/submittals/{SubmittalID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Submittal":{"SubmittalID":0,"SubmittalUID":"00000000000000000000000000000000","ProjectID":0,"SubmittalNo":"String","SpecSection":"String","Title":"String","SubType":"String","Rev":0,"BallInCourt":"String","Status":"String","DueDate":"0001-01-01T00:00:00.0000000","SubmittedDate":"0001-01-01T00:00:00.0000000","DecidedDate":"0001-01-01T00:00:00.0000000","Notes":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000","IsOverdue":false}}