| Requires any of the roles: | Agent, Administrator |
| GET, DELETE, OPTIONS | /v1/AgentDevice/{DeviceId} | ||
|---|---|---|---|
| POST, OPTIONS | /v1/AgentDevice |
<?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 AgentDevice implements JsonSerializable
{
public function __construct(
/** @var int */
public int $AgentDeviceId=0,
/** @var string */
public string $UserId='',
/** @var string|null */
public ?string $DeviceId=null,
/** @var string|null */
public ?string $Model=null,
/** @var string|null */
public ?string $Platform=null,
/** @var string|null */
public ?string $UUID=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['AgentDeviceId'])) $this->AgentDeviceId = $o['AgentDeviceId'];
if (isset($o['UserId'])) $this->UserId = $o['UserId'];
if (isset($o['DeviceId'])) $this->DeviceId = $o['DeviceId'];
if (isset($o['Model'])) $this->Model = $o['Model'];
if (isset($o['Platform'])) $this->Platform = $o['Platform'];
if (isset($o['UUID'])) $this->UUID = $o['UUID'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->AgentDeviceId)) $o['AgentDeviceId'] = $this->AgentDeviceId;
if (isset($this->UserId)) $o['UserId'] = $this->UserId;
if (isset($this->DeviceId)) $o['DeviceId'] = $this->DeviceId;
if (isset($this->Model)) $o['Model'] = $this->Model;
if (isset($this->Platform)) $o['Platform'] = $this->Platform;
if (isset($this->UUID)) $o['UUID'] = $this->UUID;
return empty($o) ? new class(){} : $o;
}
}
class AgentDeviceResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var AgentDevice|null */
public ?AgentDevice $AgentDevice=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['AgentDevice'])) $this->AgentDevice = JsonConverters::from('AgentDevice', $o['AgentDevice']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->AgentDevice)) $o['AgentDevice'] = JsonConverters::to('AgentDevice', $this->AgentDevice);
return empty($o) ? new class(){} : $o;
}
}
class AgentDeviceRequest implements JsonSerializable
{
public function __construct(
/** @var AgentDevice|null */
public ?AgentDevice $AgentDevice=null,
/** @var string|null */
public ?string $DeviceId=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['AgentDevice'])) $this->AgentDevice = JsonConverters::from('AgentDevice', $o['AgentDevice']);
if (isset($o['DeviceId'])) $this->DeviceId = $o['DeviceId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->AgentDevice)) $o['AgentDevice'] = JsonConverters::to('AgentDevice', $this->AgentDevice);
if (isset($this->DeviceId)) $o['DeviceId'] = $this->DeviceId;
return empty($o) ? new class(){} : $o;
}
}
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.
POST /v1/AgentDevice HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AgentDeviceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AgentDevice>
<AgentDeviceId>0</AgentDeviceId>
<DeviceId>String</DeviceId>
<Model>String</Model>
<Platform>String</Platform>
<UUID>String</UUID>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
</AgentDevice>
<DeviceId>String</DeviceId>
</AgentDeviceRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgentDeviceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AgentDevice>
<AgentDeviceId>0</AgentDeviceId>
<DeviceId>String</DeviceId>
<Model>String</Model>
<Platform>String</Platform>
<UUID>String</UUID>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
</AgentDevice>
<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>
</AgentDeviceResponse>