Trendsic Platform Service

MaterialShortfallsRequest

The following routes are available for this service:
GET,OPTIONS	/v1/projects/{ProjectID}/material-shortfalls

<?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 MaterialShortfall implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $MaterialID=0,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $MaterialType=null,
        /** @var float */
        public float $OnHand=0.0,
        /** @var float */
        public float $QtyNeeded=0.0,
        /** @var float */
        public float $ShortQty=0.0,
        /** @var string|null */
        public ?string $Unit=null,
        /** @var float */
        public float $UnitPrice=0.0,
        /** @var float */
        public float $EstUSD=0.0,
        /** @var string|null */
        public ?string $Vendor=null,
        /** @var DateTime|null */
        public ?DateTime $JobStartDate=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['MaterialID'])) $this->MaterialID = $o['MaterialID'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['MaterialType'])) $this->MaterialType = $o['MaterialType'];
        if (isset($o['OnHand'])) $this->OnHand = $o['OnHand'];
        if (isset($o['QtyNeeded'])) $this->QtyNeeded = $o['QtyNeeded'];
        if (isset($o['ShortQty'])) $this->ShortQty = $o['ShortQty'];
        if (isset($o['Unit'])) $this->Unit = $o['Unit'];
        if (isset($o['UnitPrice'])) $this->UnitPrice = $o['UnitPrice'];
        if (isset($o['EstUSD'])) $this->EstUSD = $o['EstUSD'];
        if (isset($o['Vendor'])) $this->Vendor = $o['Vendor'];
        if (isset($o['JobStartDate'])) $this->JobStartDate = JsonConverters::from('DateTime', $o['JobStartDate']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->MaterialID)) $o['MaterialID'] = $this->MaterialID;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->MaterialType)) $o['MaterialType'] = $this->MaterialType;
        if (isset($this->OnHand)) $o['OnHand'] = $this->OnHand;
        if (isset($this->QtyNeeded)) $o['QtyNeeded'] = $this->QtyNeeded;
        if (isset($this->ShortQty)) $o['ShortQty'] = $this->ShortQty;
        if (isset($this->Unit)) $o['Unit'] = $this->Unit;
        if (isset($this->UnitPrice)) $o['UnitPrice'] = $this->UnitPrice;
        if (isset($this->EstUSD)) $o['EstUSD'] = $this->EstUSD;
        if (isset($this->Vendor)) $o['Vendor'] = $this->Vendor;
        if (isset($this->JobStartDate)) $o['JobStartDate'] = JsonConverters::to('DateTime', $this->JobStartDate);
        return empty($o) ? new class(){} : $o;
    }
}

class MaterialShortfallsResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var int */
        public int $ProjectID=0,
        /** @var array<MaterialShortfall>|null */
        public ?array $Shortfalls=null
    ) {
    }

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

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

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

PHP MaterialShortfallsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /v1/projects/{ProjectID}/material-shortfalls HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"ProjectID":0,"Shortfalls":[{"MaterialID":0,"Name":"String","MaterialType":"String","OnHand":0,"QtyNeeded":0,"ShortQty":0,"Unit":"String","UnitPrice":0,"EstUSD":0,"Vendor":"String","JobStartDate":"0001-01-01T00:00:00.0000000"}]}