| Requires any of the roles: | Worker, Agent, Administrator |
| GET,OPTIONS | /v1/Agent/Dropdown |
|---|
<?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 AgentDD implements JsonSerializable
{
public function __construct(
/** @var int */
public int $AgentId=0,
/** @var string|null */
public ?string $AgentName=null,
/** @var string|null */
public ?string $AgentStatus=null,
/** @var int */
public int $ContactCount=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['AgentId'])) $this->AgentId = $o['AgentId'];
if (isset($o['AgentName'])) $this->AgentName = $o['AgentName'];
if (isset($o['AgentStatus'])) $this->AgentStatus = $o['AgentStatus'];
if (isset($o['ContactCount'])) $this->ContactCount = $o['ContactCount'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->AgentId)) $o['AgentId'] = $this->AgentId;
if (isset($this->AgentName)) $o['AgentName'] = $this->AgentName;
if (isset($this->AgentStatus)) $o['AgentStatus'] = $this->AgentStatus;
if (isset($this->ContactCount)) $o['ContactCount'] = $this->ContactCount;
return empty($o) ? new class(){} : $o;
}
}
class AgentDropdownResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<AgentDD>|null */
public ?array $Agents=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['Agents'])) $this->Agents = JsonConverters::fromArray('AgentDD', $o['Agents']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->Agents)) $o['Agents'] = JsonConverters::toArray('AgentDD', $this->Agents);
return empty($o) ? new class(){} : $o;
}
}
class AgentDropdownRequest implements JsonSerializable
{
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
return empty($o) ? new class(){} : $o;
}
}
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/Agent/Dropdown 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
}
},
Agents:
[
{
AgentId: 0,
AgentName: String,
AgentStatus: String,
ContactCount: 0
}
]
}