Trendsic Platform Service

<back to all web services

PmJobRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/pm/job/{JobID}
<?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 PmJobCrew implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ContactID=0,
        /** @var string|null */
        public ?string $Name=null,
        /** @var float */
        public float $Rate=0.0,
        /** @var float */
        public float $BudgetedHours=0.0,
        /** @var bool|null */
        public ?bool $IsOpen=null
    ) {
    }

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

class PmJobResource implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @var string|null */
        public ?string $Name=null,
        /** @var float */
        public float $Amount=0.0,
        /** @var int */
        public int $Qty=0,
        /** @var string|null */
        public ?string $Unit=null
    ) {
    }

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

class PmJob implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $JobID=0,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Description=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var string|null */
        public ?string $StartDate=null,
        /** @var string|null */
        public ?string $EndDate=null,
        /** @var int */
        public int $CrewCount=0,
        /** @var float */
        public float $BudgetedHours=0.0,
        /** @var int */
        public int $EquipmentCount=0,
        /** @var int */
        public int $MaterialCount=0,
        /** @var float */
        public float $CrewCost=0.0,
        /** @var float */
        public float $EquipCost=0.0,
        /** @var float */
        public float $MatCost=0.0,
        /** @var float */
        public float $Cost=0.0,
        /** @var bool|null */
        public ?bool $NoCrew=null,
        /** @var bool|null */
        public ?bool $EquipConflict=null,
        /** @var bool|null */
        public ?bool $MaterialGap=null,
        /** @var int */
        public int $ReadyPct=0,
        /** @var string|null */
        public ?string $Priority=null,
        /** @var array<string>|null */
        public ?array $Tags=null,
        /** @var array<PmJobCrew>|null */
        public ?array $Crew=null,
        /** @var array<PmJobResource>|null */
        public ?array $Equipment=null,
        /** @var array<PmJobResource>|null */
        public ?array $Materials=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['JobID'])) $this->JobID = $o['JobID'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['StartDate'])) $this->StartDate = $o['StartDate'];
        if (isset($o['EndDate'])) $this->EndDate = $o['EndDate'];
        if (isset($o['CrewCount'])) $this->CrewCount = $o['CrewCount'];
        if (isset($o['BudgetedHours'])) $this->BudgetedHours = $o['BudgetedHours'];
        if (isset($o['EquipmentCount'])) $this->EquipmentCount = $o['EquipmentCount'];
        if (isset($o['MaterialCount'])) $this->MaterialCount = $o['MaterialCount'];
        if (isset($o['CrewCost'])) $this->CrewCost = $o['CrewCost'];
        if (isset($o['EquipCost'])) $this->EquipCost = $o['EquipCost'];
        if (isset($o['MatCost'])) $this->MatCost = $o['MatCost'];
        if (isset($o['Cost'])) $this->Cost = $o['Cost'];
        if (isset($o['NoCrew'])) $this->NoCrew = $o['NoCrew'];
        if (isset($o['EquipConflict'])) $this->EquipConflict = $o['EquipConflict'];
        if (isset($o['MaterialGap'])) $this->MaterialGap = $o['MaterialGap'];
        if (isset($o['ReadyPct'])) $this->ReadyPct = $o['ReadyPct'];
        if (isset($o['Priority'])) $this->Priority = $o['Priority'];
        if (isset($o['Tags'])) $this->Tags = JsonConverters::fromArray('string', $o['Tags']);
        if (isset($o['Crew'])) $this->Crew = JsonConverters::fromArray('PmJobCrew', $o['Crew']);
        if (isset($o['Equipment'])) $this->Equipment = JsonConverters::fromArray('PmJobResource', $o['Equipment']);
        if (isset($o['Materials'])) $this->Materials = JsonConverters::fromArray('PmJobResource', $o['Materials']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->JobID)) $o['JobID'] = $this->JobID;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->StartDate)) $o['StartDate'] = $this->StartDate;
        if (isset($this->EndDate)) $o['EndDate'] = $this->EndDate;
        if (isset($this->CrewCount)) $o['CrewCount'] = $this->CrewCount;
        if (isset($this->BudgetedHours)) $o['BudgetedHours'] = $this->BudgetedHours;
        if (isset($this->EquipmentCount)) $o['EquipmentCount'] = $this->EquipmentCount;
        if (isset($this->MaterialCount)) $o['MaterialCount'] = $this->MaterialCount;
        if (isset($this->CrewCost)) $o['CrewCost'] = $this->CrewCost;
        if (isset($this->EquipCost)) $o['EquipCost'] = $this->EquipCost;
        if (isset($this->MatCost)) $o['MatCost'] = $this->MatCost;
        if (isset($this->Cost)) $o['Cost'] = $this->Cost;
        if (isset($this->NoCrew)) $o['NoCrew'] = $this->NoCrew;
        if (isset($this->EquipConflict)) $o['EquipConflict'] = $this->EquipConflict;
        if (isset($this->MaterialGap)) $o['MaterialGap'] = $this->MaterialGap;
        if (isset($this->ReadyPct)) $o['ReadyPct'] = $this->ReadyPct;
        if (isset($this->Priority)) $o['Priority'] = $this->Priority;
        if (isset($this->Tags)) $o['Tags'] = JsonConverters::toArray('string', $this->Tags);
        if (isset($this->Crew)) $o['Crew'] = JsonConverters::toArray('PmJobCrew', $this->Crew);
        if (isset($this->Equipment)) $o['Equipment'] = JsonConverters::toArray('PmJobResource', $this->Equipment);
        if (isset($this->Materials)) $o['Materials'] = JsonConverters::toArray('PmJobResource', $this->Materials);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

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

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

PHP PmJobRequest 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/pm/job/{JobID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Job":{"JobID":0,"Name":"String","Description":"String","Status":"String","StartDate":"String","EndDate":"String","CrewCount":0,"BudgetedHours":0,"EquipmentCount":0,"MaterialCount":0,"CrewCost":0,"EquipCost":0,"MatCost":0,"Cost":0,"NoCrew":false,"EquipConflict":false,"MaterialGap":false,"ReadyPct":0,"Priority":"String","Tags":["String"],"Crew":[{"ContactID":0,"Name":"String","Rate":0,"BudgetedHours":0,"IsOpen":false}],"Equipment":[{"Id":0,"Name":"String","Amount":0,"Qty":0,"Unit":"String"}],"Materials":[{"Id":0,"Name":"String","Amount":0,"Qty":0,"Unit":"String"}]},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}