| Required roles: | Administrator, Administrator, Administrator | Requires any of the roles: | Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/Stations/{Id} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/StationsByLocation/{LocationId} | ||
| GET,POST,PUT,DELETE,OPTIONS | /v1/Stations |
<?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 Station implements JsonSerializable
{
public function __construct(
/** @var string */
public string $Id='',
/** @var string */
public string $LocationId='',
/** @var string|null */
public ?string $LocationName=null,
/** @var string|null */
public ?string $StationName=null,
/** @var bool|null */
public ?bool $Active=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['LocationId'])) $this->LocationId = $o['LocationId'];
if (isset($o['LocationName'])) $this->LocationName = $o['LocationName'];
if (isset($o['StationName'])) $this->StationName = $o['StationName'];
if (isset($o['Active'])) $this->Active = $o['Active'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->LocationId)) $o['LocationId'] = $this->LocationId;
if (isset($this->LocationName)) $o['LocationName'] = $this->LocationName;
if (isset($this->StationName)) $o['StationName'] = $this->StationName;
if (isset($this->Active)) $o['Active'] = $this->Active;
return empty($o) ? new class(){} : $o;
}
}
class StationsResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<Station>|null */
public ?array $Stations=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['Stations'])) $this->Stations = JsonConverters::fromArray('Station', $o['Stations']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->Stations)) $o['Stations'] = JsonConverters::toArray('Station', $this->Stations);
return empty($o) ? new class(){} : $o;
}
}
class StationsRequest implements JsonSerializable
{
public function __construct(
/** @var string */
public string $Id='',
/** @var string */
public string $LocationId='',
/** @var array<Station>|null */
public ?array $Stations=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['LocationId'])) $this->LocationId = $o['LocationId'];
if (isset($o['Stations'])) $this->Stations = JsonConverters::fromArray('Station', $o['Stations']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->LocationId)) $o['LocationId'] = $this->LocationId;
if (isset($this->Stations)) $o['Stations'] = JsonConverters::toArray('Station', $this->Stations);
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/Stations/{Id} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<StationsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Id>00000000-0000-0000-0000-000000000000</Id>
<LocationId>00000000-0000-0000-0000-000000000000</LocationId>
<Stations>
<Station>
<Active>false</Active>
<Id>00000000-0000-0000-0000-000000000000</Id>
<LocationId>00000000-0000-0000-0000-000000000000</LocationId>
<LocationName>String</LocationName>
<StationName>String</StationName>
</Station>
</Stations>
</StationsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<StationsResponse 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>
<Stations>
<Station>
<Active>false</Active>
<Id>00000000-0000-0000-0000-000000000000</Id>
<LocationId>00000000-0000-0000-0000-000000000000</LocationId>
<LocationName>String</LocationName>
<StationName>String</StationName>
</Station>
</Stations>
</StationsResponse>