| GET,POST,PUT,DELETE,OPTIONS | /v1/Project/Equipment/{ProjectID} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/Project/Equipment/{ProjectID}/{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 Project implements JsonSerializable
{
public function __construct(
/** @var int */
public int $ProjectID=0,
/** @var string */
public string $ProjectUID='',
/** @var string|null */
public ?string $ProjectName=null,
/** @var string|null */
public ?string $ImageURL=null,
/** @var string|null */
public ?string $ImageKey=null,
/** @var string|null */
public ?string $ClientName=null,
/** @var string|null */
public ?string $ClientPhone=null,
/** @var string|null */
public ?string $ClientEmail=null,
/** @var int */
public int $ProjectManagerID=0,
/** @var string|null */
public ?string $ProjectManagerName=null,
/** @var DateTime|null */
public ?DateTime $StartDate=null,
/** @var DateTime|null */
public ?DateTime $EndDate=null,
/** @var DateTime|null */
public ?DateTime $ActualStartDate=null,
/** @var DateTime|null */
public ?DateTime $ActualEndDate=null,
/** @var int */
public int $JobCount=0,
/** @var int */
public int $CrewMemberCount=0,
/** @var int */
public int $EquipmentCount=0,
/** @var int */
public int $MaterialCount=0,
/** @var int */
public int $ProjectStatusID=0,
/** @var string|null */
public ?string $ProjectStatusDescription=null,
/** @var float */
public float $Budget=0.0,
/** @var float */
public float $CostToDate=0.0,
/** @var string|null */
public ?string $ProjectLocation=null,
/** @var string|null */
public ?string $ProjectType=null,
/** @var string|null */
public ?string $ProjectSponsor=null,
/** @var string|null */
public ?string $CreatedBy=null,
/** @var DateTime|null */
public ?DateTime $CreatedAt=null,
/** @var DateTime|null */
public ?DateTime $UpdatedAt=null,
/** @var string|null */
public ?string $ProjectDescription=null,
/** @var string|null */
public ?string $Scope=null,
/** @var int */
public int $StatusId=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ProjectID'])) $this->ProjectID = $o['ProjectID'];
if (isset($o['ProjectUID'])) $this->ProjectUID = $o['ProjectUID'];
if (isset($o['ProjectName'])) $this->ProjectName = $o['ProjectName'];
if (isset($o['ImageURL'])) $this->ImageURL = $o['ImageURL'];
if (isset($o['ImageKey'])) $this->ImageKey = $o['ImageKey'];
if (isset($o['ClientName'])) $this->ClientName = $o['ClientName'];
if (isset($o['ClientPhone'])) $this->ClientPhone = $o['ClientPhone'];
if (isset($o['ClientEmail'])) $this->ClientEmail = $o['ClientEmail'];
if (isset($o['ProjectManagerID'])) $this->ProjectManagerID = $o['ProjectManagerID'];
if (isset($o['ProjectManagerName'])) $this->ProjectManagerName = $o['ProjectManagerName'];
if (isset($o['StartDate'])) $this->StartDate = JsonConverters::from('DateTime', $o['StartDate']);
if (isset($o['EndDate'])) $this->EndDate = JsonConverters::from('DateTime', $o['EndDate']);
if (isset($o['ActualStartDate'])) $this->ActualStartDate = JsonConverters::from('DateTime', $o['ActualStartDate']);
if (isset($o['ActualEndDate'])) $this->ActualEndDate = JsonConverters::from('DateTime', $o['ActualEndDate']);
if (isset($o['JobCount'])) $this->JobCount = $o['JobCount'];
if (isset($o['CrewMemberCount'])) $this->CrewMemberCount = $o['CrewMemberCount'];
if (isset($o['EquipmentCount'])) $this->EquipmentCount = $o['EquipmentCount'];
if (isset($o['MaterialCount'])) $this->MaterialCount = $o['MaterialCount'];
if (isset($o['ProjectStatusID'])) $this->ProjectStatusID = $o['ProjectStatusID'];
if (isset($o['ProjectStatusDescription'])) $this->ProjectStatusDescription = $o['ProjectStatusDescription'];
if (isset($o['Budget'])) $this->Budget = $o['Budget'];
if (isset($o['CostToDate'])) $this->CostToDate = $o['CostToDate'];
if (isset($o['ProjectLocation'])) $this->ProjectLocation = $o['ProjectLocation'];
if (isset($o['ProjectType'])) $this->ProjectType = $o['ProjectType'];
if (isset($o['ProjectSponsor'])) $this->ProjectSponsor = $o['ProjectSponsor'];
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['ProjectDescription'])) $this->ProjectDescription = $o['ProjectDescription'];
if (isset($o['Scope'])) $this->Scope = $o['Scope'];
if (isset($o['StatusId'])) $this->StatusId = $o['StatusId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ProjectID)) $o['ProjectID'] = $this->ProjectID;
if (isset($this->ProjectUID)) $o['ProjectUID'] = $this->ProjectUID;
if (isset($this->ProjectName)) $o['ProjectName'] = $this->ProjectName;
if (isset($this->ImageURL)) $o['ImageURL'] = $this->ImageURL;
if (isset($this->ImageKey)) $o['ImageKey'] = $this->ImageKey;
if (isset($this->ClientName)) $o['ClientName'] = $this->ClientName;
if (isset($this->ClientPhone)) $o['ClientPhone'] = $this->ClientPhone;
if (isset($this->ClientEmail)) $o['ClientEmail'] = $this->ClientEmail;
if (isset($this->ProjectManagerID)) $o['ProjectManagerID'] = $this->ProjectManagerID;
if (isset($this->ProjectManagerName)) $o['ProjectManagerName'] = $this->ProjectManagerName;
if (isset($this->StartDate)) $o['StartDate'] = JsonConverters::to('DateTime', $this->StartDate);
if (isset($this->EndDate)) $o['EndDate'] = JsonConverters::to('DateTime', $this->EndDate);
if (isset($this->ActualStartDate)) $o['ActualStartDate'] = JsonConverters::to('DateTime', $this->ActualStartDate);
if (isset($this->ActualEndDate)) $o['ActualEndDate'] = JsonConverters::to('DateTime', $this->ActualEndDate);
if (isset($this->JobCount)) $o['JobCount'] = $this->JobCount;
if (isset($this->CrewMemberCount)) $o['CrewMemberCount'] = $this->CrewMemberCount;
if (isset($this->EquipmentCount)) $o['EquipmentCount'] = $this->EquipmentCount;
if (isset($this->MaterialCount)) $o['MaterialCount'] = $this->MaterialCount;
if (isset($this->ProjectStatusID)) $o['ProjectStatusID'] = $this->ProjectStatusID;
if (isset($this->ProjectStatusDescription)) $o['ProjectStatusDescription'] = $this->ProjectStatusDescription;
if (isset($this->Budget)) $o['Budget'] = $this->Budget;
if (isset($this->CostToDate)) $o['CostToDate'] = $this->CostToDate;
if (isset($this->ProjectLocation)) $o['ProjectLocation'] = $this->ProjectLocation;
if (isset($this->ProjectType)) $o['ProjectType'] = $this->ProjectType;
if (isset($this->ProjectSponsor)) $o['ProjectSponsor'] = $this->ProjectSponsor;
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->ProjectDescription)) $o['ProjectDescription'] = $this->ProjectDescription;
if (isset($this->Scope)) $o['Scope'] = $this->Scope;
if (isset($this->StatusId)) $o['StatusId'] = $this->StatusId;
return empty($o) ? new class(){} : $o;
}
}
class Equipment implements JsonSerializable
{
public function __construct(
/** @var int */
public int $EquipmentID=0,
/** @var string|null */
public ?string $EquipmentName=null,
/** @var int */
public int $EquipmentTypeID=0,
/** @var string|null */
public ?string $Manufacturer=null,
/** @var string|null */
public ?string $EquipmentType=null,
/** @var string|null */
public ?string $SerialNumber=null,
/** @var string|null */
public ?string $BarCode=null,
/** @var string|null */
public ?string $EquipmentLocation=null,
/** @var string|null */
public ?string $ImageURL=null,
/** @var string|null */
public ?string $ProductDetailsURL=null,
/** @var DateTime */
public DateTime $RecordCreatedDate=new DateTime(),
/** @var string */
public string $CreatedByUID='',
/** @var bool|null */
public ?bool $Active=null,
/** @var string|null */
public ?string $Notes=null,
/** @var float */
public float $Rate=0.0,
/** @var array<Project>|null */
public ?array $Projects=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['EquipmentID'])) $this->EquipmentID = $o['EquipmentID'];
if (isset($o['EquipmentName'])) $this->EquipmentName = $o['EquipmentName'];
if (isset($o['EquipmentTypeID'])) $this->EquipmentTypeID = $o['EquipmentTypeID'];
if (isset($o['Manufacturer'])) $this->Manufacturer = $o['Manufacturer'];
if (isset($o['EquipmentType'])) $this->EquipmentType = $o['EquipmentType'];
if (isset($o['SerialNumber'])) $this->SerialNumber = $o['SerialNumber'];
if (isset($o['BarCode'])) $this->BarCode = $o['BarCode'];
if (isset($o['EquipmentLocation'])) $this->EquipmentLocation = $o['EquipmentLocation'];
if (isset($o['ImageURL'])) $this->ImageURL = $o['ImageURL'];
if (isset($o['ProductDetailsURL'])) $this->ProductDetailsURL = $o['ProductDetailsURL'];
if (isset($o['RecordCreatedDate'])) $this->RecordCreatedDate = JsonConverters::from('DateTime', $o['RecordCreatedDate']);
if (isset($o['CreatedByUID'])) $this->CreatedByUID = $o['CreatedByUID'];
if (isset($o['Active'])) $this->Active = $o['Active'];
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
if (isset($o['Rate'])) $this->Rate = $o['Rate'];
if (isset($o['Projects'])) $this->Projects = JsonConverters::fromArray('Project', $o['Projects']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->EquipmentID)) $o['EquipmentID'] = $this->EquipmentID;
if (isset($this->EquipmentName)) $o['EquipmentName'] = $this->EquipmentName;
if (isset($this->EquipmentTypeID)) $o['EquipmentTypeID'] = $this->EquipmentTypeID;
if (isset($this->Manufacturer)) $o['Manufacturer'] = $this->Manufacturer;
if (isset($this->EquipmentType)) $o['EquipmentType'] = $this->EquipmentType;
if (isset($this->SerialNumber)) $o['SerialNumber'] = $this->SerialNumber;
if (isset($this->BarCode)) $o['BarCode'] = $this->BarCode;
if (isset($this->EquipmentLocation)) $o['EquipmentLocation'] = $this->EquipmentLocation;
if (isset($this->ImageURL)) $o['ImageURL'] = $this->ImageURL;
if (isset($this->ProductDetailsURL)) $o['ProductDetailsURL'] = $this->ProductDetailsURL;
if (isset($this->RecordCreatedDate)) $o['RecordCreatedDate'] = JsonConverters::to('DateTime', $this->RecordCreatedDate);
if (isset($this->CreatedByUID)) $o['CreatedByUID'] = $this->CreatedByUID;
if (isset($this->Active)) $o['Active'] = $this->Active;
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
if (isset($this->Rate)) $o['Rate'] = $this->Rate;
if (isset($this->Projects)) $o['Projects'] = JsonConverters::toArray('Project', $this->Projects);
return empty($o) ? new class(){} : $o;
}
}
class ProjectEquipment extends Equipment implements JsonSerializable
{
/**
* @param int $EquipmentID
* @param string|null $EquipmentName
* @param int $EquipmentTypeID
* @param string|null $Manufacturer
* @param string|null $EquipmentType
* @param string|null $SerialNumber
* @param string|null $BarCode
* @param string|null $EquipmentLocation
* @param string|null $ImageURL
* @param string|null $ProductDetailsURL
* @param DateTime $RecordCreatedDate
* @param string $CreatedByUID
* @param bool|null $Active
* @param string|null $Notes
* @param float $Rate
* @param array<Project>|null $Projects
*/
public function __construct(
int $EquipmentID=0,
?string $EquipmentName=null,
int $EquipmentTypeID=0,
?string $Manufacturer=null,
?string $EquipmentType=null,
?string $SerialNumber=null,
?string $BarCode=null,
?string $EquipmentLocation=null,
?string $ImageURL=null,
?string $ProductDetailsURL=null,
DateTime $RecordCreatedDate=new DateTime(),
string $CreatedByUID='',
?bool $Active=null,
?string $Notes=null,
float $Rate=0.0,
?array $Projects=null,
/** @var int */
public int $ProjectEquipmentID=0,
/** @var int */
public int $ProjectID=0,
/** @var DateTime */
public DateTime $ProjectEndDate=new DateTime(),
/** @var float */
public float $EquipmentRate=0.0,
/** @var int */
public int $JobID=0,
/** @var float */
public float $BilledEquipmentRate=0.0,
/** @var string|null */
public ?string $Status=null
) {
parent::__construct($EquipmentID,$EquipmentName,$EquipmentTypeID,$Manufacturer,$EquipmentType,$SerialNumber,$BarCode,$EquipmentLocation,$ImageURL,$ProductDetailsURL,$RecordCreatedDate,$CreatedByUID,$Active,$Notes,$Rate,$Projects);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['ProjectEquipmentID'])) $this->ProjectEquipmentID = $o['ProjectEquipmentID'];
if (isset($o['ProjectID'])) $this->ProjectID = $o['ProjectID'];
if (isset($o['ProjectEndDate'])) $this->ProjectEndDate = JsonConverters::from('DateTime', $o['ProjectEndDate']);
if (isset($o['EquipmentRate'])) $this->EquipmentRate = $o['EquipmentRate'];
if (isset($o['JobID'])) $this->JobID = $o['JobID'];
if (isset($o['BilledEquipmentRate'])) $this->BilledEquipmentRate = $o['BilledEquipmentRate'];
if (isset($o['Status'])) $this->Status = $o['Status'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->ProjectEquipmentID)) $o['ProjectEquipmentID'] = $this->ProjectEquipmentID;
if (isset($this->ProjectID)) $o['ProjectID'] = $this->ProjectID;
if (isset($this->ProjectEndDate)) $o['ProjectEndDate'] = JsonConverters::to('DateTime', $this->ProjectEndDate);
if (isset($this->EquipmentRate)) $o['EquipmentRate'] = $this->EquipmentRate;
if (isset($this->JobID)) $o['JobID'] = $this->JobID;
if (isset($this->BilledEquipmentRate)) $o['BilledEquipmentRate'] = $this->BilledEquipmentRate;
if (isset($this->Status)) $o['Status'] = $this->Status;
return empty($o) ? new class(){} : $o;
}
}
class ProjectEquipmentListResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<ProjectEquipment>|null */
public ?array $ProjectEquipment=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['ProjectEquipment'])) $this->ProjectEquipment = JsonConverters::fromArray('ProjectEquipment', $o['ProjectEquipment']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->ProjectEquipment)) $o['ProjectEquipment'] = JsonConverters::toArray('ProjectEquipment', $this->ProjectEquipment);
return empty($o) ? new class(){} : $o;
}
}
class ProjectEquipmentListRequest implements JsonSerializable
{
public function __construct(
/** @var int */
public int $ProjectID=0,
/** @var int */
public int $JobID=0,
/** @var array<Equipment>|null */
public ?array $ProjectEquipment=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ProjectID'])) $this->ProjectID = $o['ProjectID'];
if (isset($o['JobID'])) $this->JobID = $o['JobID'];
if (isset($o['ProjectEquipment'])) $this->ProjectEquipment = JsonConverters::fromArray('Equipment', $o['ProjectEquipment']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ProjectID)) $o['ProjectID'] = $this->ProjectID;
if (isset($this->JobID)) $o['JobID'] = $this->JobID;
if (isset($this->ProjectEquipment)) $o['ProjectEquipment'] = JsonConverters::toArray('Equipment', $this->ProjectEquipment);
return empty($o) ? new class(){} : $o;
}
}
PHP ProjectEquipmentListRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/Project/Equipment/{ProjectID} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ProjectID: 0,
JobID: 0,
ProjectEquipment:
[
{
EquipmentID: 0,
EquipmentName: String,
EquipmentTypeID: 0,
Manufacturer: String,
EquipmentType: String,
SerialNumber: String,
BarCode: String,
EquipmentLocation: String,
ImageURL: String,
ProductDetailsURL: String,
RecordCreatedDate: 0001-01-01,
CreatedByUID: 00000000000000000000000000000000,
Active: False,
Notes: String,
Rate: 0,
Projects:
[
{
ProjectID: 0,
ProjectUID: 00000000000000000000000000000000,
ProjectName: String,
ImageURL: String,
ImageKey: String,
ClientName: String,
ClientPhone: String,
ClientEmail: String,
ProjectManagerID: 0,
ProjectManagerName: String,
StartDate: 0001-01-01,
EndDate: 0001-01-01,
ActualStartDate: 0001-01-01,
ActualEndDate: 0001-01-01,
JobCount: 0,
CrewMemberCount: 0,
EquipmentCount: 0,
MaterialCount: 0,
ProjectStatusID: 0,
ProjectStatusDescription: String,
Budget: 0,
CostToDate: 0,
ProjectLocation: String,
ProjectType: String,
ProjectSponsor: String,
CreatedBy: String,
CreatedAt: 0001-01-01,
UpdatedAt: 0001-01-01,
ProjectDescription: String,
Scope: String,
StatusId: 0
}
]
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
ProjectEquipment:
[
{
ProjectEquipmentID: 0,
ProjectID: 0,
ProjectEndDate: 0001-01-01,
EquipmentRate: 0,
JobID: 0,
BilledEquipmentRate: 0,
Status: String,
EquipmentID: 0,
EquipmentName: String,
EquipmentTypeID: 0,
Manufacturer: String,
EquipmentType: String,
SerialNumber: String,
BarCode: String,
EquipmentLocation: String,
ImageURL: String,
ProductDetailsURL: String,
RecordCreatedDate: 0001-01-01,
CreatedByUID: 00000000000000000000000000000000,
Active: False,
Notes: String,
Rate: 0,
Projects:
[
{
ProjectID: 0,
ProjectUID: 00000000000000000000000000000000,
ProjectName: String,
ImageURL: String,
ImageKey: String,
ClientName: String,
ClientPhone: String,
ClientEmail: String,
ProjectManagerID: 0,
ProjectManagerName: String,
StartDate: 0001-01-01,
EndDate: 0001-01-01,
ActualStartDate: 0001-01-01,
ActualEndDate: 0001-01-01,
JobCount: 0,
CrewMemberCount: 0,
EquipmentCount: 0,
MaterialCount: 0,
ProjectStatusID: 0,
ProjectStatusDescription: String,
Budget: 0,
CostToDate: 0,
ProjectLocation: String,
ProjectType: String,
ProjectSponsor: String,
CreatedBy: String,
CreatedAt: 0001-01-01,
UpdatedAt: 0001-01-01,
ProjectDescription: String,
Scope: String,
StatusId: 0
}
]
}
]
}