| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/Rfp/{RfpDocumentUID}/Estimate/Assemblies |
|---|
<?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 AppliedAssembly implements JsonSerializable
{
public function __construct(
/** @var int */
public int $TaskSeq=0,
/** @var string|null */
public ?string $TemplateUID=null,
/** @var string|null */
public ?string $TemplateName=null,
/** @var string|null */
public ?string $AppliedBy=null,
/** @var DateTime|null */
public ?DateTime $AppliedAt=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['TaskSeq'])) $this->TaskSeq = $o['TaskSeq'];
if (isset($o['TemplateUID'])) $this->TemplateUID = $o['TemplateUID'];
if (isset($o['TemplateName'])) $this->TemplateName = $o['TemplateName'];
if (isset($o['AppliedBy'])) $this->AppliedBy = $o['AppliedBy'];
if (isset($o['AppliedAt'])) $this->AppliedAt = JsonConverters::from('DateTime', $o['AppliedAt']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->TaskSeq)) $o['TaskSeq'] = $this->TaskSeq;
if (isset($this->TemplateUID)) $o['TemplateUID'] = $this->TemplateUID;
if (isset($this->TemplateName)) $o['TemplateName'] = $this->TemplateName;
if (isset($this->AppliedBy)) $o['AppliedBy'] = $this->AppliedBy;
if (isset($this->AppliedAt)) $o['AppliedAt'] = JsonConverters::to('DateTime', $this->AppliedAt);
return empty($o) ? new class(){} : $o;
}
}
class AssemblyOption implements JsonSerializable
{
public function __construct(
/** @var string */
public string $TemplateUID='',
/** @var string|null */
public ?string $Name=null,
/** @var string|null */
public ?string $Unit=null,
/** @var string|null */
public ?string $Pack=null,
/** @var bool|null */
public ?bool $IsGlobal=null,
/** @var string|null */
public ?string $Summary=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['TemplateUID'])) $this->TemplateUID = $o['TemplateUID'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Unit'])) $this->Unit = $o['Unit'];
if (isset($o['Pack'])) $this->Pack = $o['Pack'];
if (isset($o['IsGlobal'])) $this->IsGlobal = $o['IsGlobal'];
if (isset($o['Summary'])) $this->Summary = $o['Summary'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->TemplateUID)) $o['TemplateUID'] = $this->TemplateUID;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Unit)) $o['Unit'] = $this->Unit;
if (isset($this->Pack)) $o['Pack'] = $this->Pack;
if (isset($this->IsGlobal)) $o['IsGlobal'] = $this->IsGlobal;
if (isset($this->Summary)) $o['Summary'] = $this->Summary;
return empty($o) ? new class(){} : $o;
}
}
class EstimateAssembliesResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<AppliedAssembly>|null */
public ?array $Applied=null,
/** @var array<AssemblyOption>|null */
public ?array $Available=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['Applied'])) $this->Applied = JsonConverters::fromArray('AppliedAssembly', $o['Applied']);
if (isset($o['Available'])) $this->Available = JsonConverters::fromArray('AssemblyOption', $o['Available']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->Applied)) $o['Applied'] = JsonConverters::toArray('AppliedAssembly', $this->Applied);
if (isset($this->Available)) $o['Available'] = JsonConverters::toArray('AssemblyOption', $this->Available);
return empty($o) ? new class(){} : $o;
}
}
class EstimateAssembliesRequest implements JsonSerializable
{
public function __construct(
/** @var string */
public string $RfpDocumentUID=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['RfpDocumentUID'])) $this->RfpDocumentUID = $o['RfpDocumentUID'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->RfpDocumentUID)) $o['RfpDocumentUID'] = $this->RfpDocumentUID;
return empty($o) ? new class(){} : $o;
}
}
PHP EstimateAssembliesRequest 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.
GET /v1/Rfp/{RfpDocumentUID}/Estimate/Assemblies HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
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
}
},
Applied:
[
{
TaskSeq: 0,
TemplateUID: 00000000000000000000000000000000,
TemplateName: String,
AppliedBy: String,
AppliedAt: 0001-01-01
}
],
Available:
[
{
TemplateUID: 00000000000000000000000000000000,
Name: String,
Unit: String,
Pack: String,
IsGlobal: False,
Summary: String
}
]
}