| GET,PUT,OPTIONS | /v1/agreement/{AgreementID}/tasks |
|---|
<?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 AgreementTask implements JsonSerializable
{
public function __construct(
/** @var int */
public int $AgreementTaskID=0,
/** @var int */
public int $AgreementID=0,
/** @var int */
public int $ServiceTaskID=0,
/** @var int */
public int $SortOrder=0,
/** @var string|null */
public ?string $Name=null,
/** @var string|null */
public ?string $Category=null,
/** @var bool|null */
public ?bool $Active=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['AgreementTaskID'])) $this->AgreementTaskID = $o['AgreementTaskID'];
if (isset($o['AgreementID'])) $this->AgreementID = $o['AgreementID'];
if (isset($o['ServiceTaskID'])) $this->ServiceTaskID = $o['ServiceTaskID'];
if (isset($o['SortOrder'])) $this->SortOrder = $o['SortOrder'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Category'])) $this->Category = $o['Category'];
if (isset($o['Active'])) $this->Active = $o['Active'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->AgreementTaskID)) $o['AgreementTaskID'] = $this->AgreementTaskID;
if (isset($this->AgreementID)) $o['AgreementID'] = $this->AgreementID;
if (isset($this->ServiceTaskID)) $o['ServiceTaskID'] = $this->ServiceTaskID;
if (isset($this->SortOrder)) $o['SortOrder'] = $this->SortOrder;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Category)) $o['Category'] = $this->Category;
if (isset($this->Active)) $o['Active'] = $this->Active;
return empty($o) ? new class(){} : $o;
}
}
class AgreementTasksResponse implements JsonSerializable
{
public function __construct(
/** @var array<AgreementTask>|null */
public ?array $Tasks=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Tasks'])) $this->Tasks = JsonConverters::fromArray('AgreementTask', $o['Tasks']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Tasks)) $o['Tasks'] = JsonConverters::toArray('AgreementTask', $this->Tasks);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
class AgreementTasksRequest implements JsonSerializable
{
public function __construct(
/** @var int */
public int $AgreementID=0,
/** @var array<int>|null */
public ?array $ServiceTaskIds=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['AgreementID'])) $this->AgreementID = $o['AgreementID'];
if (isset($o['ServiceTaskIds'])) $this->ServiceTaskIds = JsonConverters::fromArray('int', $o['ServiceTaskIds']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->AgreementID)) $o['AgreementID'] = $this->AgreementID;
if (isset($this->ServiceTaskIds)) $o['ServiceTaskIds'] = JsonConverters::toArray('int', $this->ServiceTaskIds);
return empty($o) ? new class(){} : $o;
}
}
PHP AgreementTasksRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /v1/agreement/{AgreementID}/tasks HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AgreementTasksRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AgreementID>0</AgreementID>
<ServiceTaskIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</ServiceTaskIds>
</AgreementTasksRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgreementTasksResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Tasks>
<AgreementTask>
<Active>false</Active>
<AgreementID>0</AgreementID>
<AgreementTaskID>0</AgreementTaskID>
<Category>String</Category>
<Name>String</Name>
<ServiceTaskID>0</ServiceTaskID>
<SortOrder>0</SortOrder>
</AgreementTask>
</Tasks>
</AgreementTasksResponse>