| GET POST | /report/unithistory |
|---|
<?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};
// @DataContract
class Location implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var float */
public float $latitude=0.0,
// @DataMember
/** @var float */
public float $longitude=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['latitude'])) $this->latitude = $o['latitude'];
if (isset($o['longitude'])) $this->longitude = $o['longitude'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->latitude)) $o['latitude'] = $this->latitude;
if (isset($this->longitude)) $o['longitude'] = $this->longitude;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class Address implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $country=null,
// @DataMember
/** @var string|null */
public ?string $zipCode=null,
// @DataMember
/** @var string|null */
public ?string $city=null,
// @DataMember
/** @var string|null */
public ?string $streetAddress=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['country'])) $this->country = $o['country'];
if (isset($o['zipCode'])) $this->zipCode = $o['zipCode'];
if (isset($o['city'])) $this->city = $o['city'];
if (isset($o['streetAddress'])) $this->streetAddress = $o['streetAddress'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->country)) $o['country'] = $this->country;
if (isset($this->zipCode)) $o['zipCode'] = $this->zipCode;
if (isset($this->city)) $o['city'] = $this->city;
if (isset($this->streetAddress)) $o['streetAddress'] = $this->streetAddress;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class UnitHistory implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var DateTime */
public DateTime $time=new DateTime(),
// @DataMember
/** @var int */
public int $event=0,
// @DataMember
/** @var string|null */
public ?string $keyId=null,
// @DataMember
/** @var Location|null */
public ?Location $location=null,
// @DataMember
/** @var Address|null */
public ?Address $address=null,
// @DataMember
/** @var int|null */
public ?int $heading=null,
// @DataMember
/** @var float|null */
public ?float $speed=null,
// @DataMember
/** @var float|null */
public ?float $km=null,
// @DataMember
/** @var float|null */
public ?float $run1=null,
// @DataMember
/** @var float|null */
public ?float $run2=null,
// @DataMember
/** @var float|null */
public ?float $run3=null,
// @DataMember
/** @var float|null */
public ?float $run4=null,
// @DataMember
/** @var float|null */
public ?float $runOdo=null,
// @DataMember
/** @var float|null */
public ?float $temperature1=null,
// @DataMember
/** @var float|null */
public ?float $temperature2=null,
// @DataMember
/** @var bool|null */
public ?bool $input1=null,
// @DataMember
/** @var bool|null */
public ?bool $input2=null,
// @DataMember
/** @var bool|null */
public ?bool $input3=null,
// @DataMember
/** @var bool|null */
public ?bool $input4=null,
// @DataMember
/** @var bool|null */
public ?bool $input5=null,
// @DataMember
/** @var bool|null */
public ?bool $input6=null,
// @DataMember
/** @var bool|null */
public ?bool $input7=null,
// @DataMember
/** @var bool|null */
public ?bool $input8=null,
// @DataMember
/** @var bool|null */
public ?bool $input9=null,
// @DataMember
/** @var bool|null */
public ?bool $input10=null,
// @DataMember
/** @var bool|null */
public ?bool $output1=null,
// @DataMember
/** @var bool|null */
public ?bool $output2=null,
// @DataMember
/** @var bool|null */
public ?bool $output3=null,
// @DataMember
/** @var bool|null */
public ?bool $output4=null,
// @DataMember
/** @var bool|null */
public ?bool $output5=null,
// @DataMember
/** @var float|null */
public ?float $analogInput1=null,
// @DataMember
/** @var float|null */
public ?float $analogInput2=null,
// @DataMember
/** @var float|null */
public ?float $analogInput4=null,
// @DataMember
/** @var int|null */
public ?int $input1ChangeCounter=null,
// @DataMember
/** @var int|null */
public ?int $input2ChangeCounter=null,
// @DataMember
/** @var int|null */
public ?int $input3ChangeCounter=null,
// @DataMember
/** @var int|null */
public ?int $input4ChangeCounter=null,
// @DataMember
/** @var float|null */
public ?float $batteryLevel=null,
// @DataMember
/** @var float|null */
public ?float $externalPower=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['time'])) $this->time = JsonConverters::from('DateTime', $o['time']);
if (isset($o['event'])) $this->event = $o['event'];
if (isset($o['keyId'])) $this->keyId = $o['keyId'];
if (isset($o['location'])) $this->location = JsonConverters::from('Location', $o['location']);
if (isset($o['address'])) $this->address = JsonConverters::from('Address', $o['address']);
if (isset($o['heading'])) $this->heading = $o['heading'];
if (isset($o['speed'])) $this->speed = $o['speed'];
if (isset($o['km'])) $this->km = $o['km'];
if (isset($o['run1'])) $this->run1 = $o['run1'];
if (isset($o['run2'])) $this->run2 = $o['run2'];
if (isset($o['run3'])) $this->run3 = $o['run3'];
if (isset($o['run4'])) $this->run4 = $o['run4'];
if (isset($o['runOdo'])) $this->runOdo = $o['runOdo'];
if (isset($o['temperature1'])) $this->temperature1 = $o['temperature1'];
if (isset($o['temperature2'])) $this->temperature2 = $o['temperature2'];
if (isset($o['input1'])) $this->input1 = $o['input1'];
if (isset($o['input2'])) $this->input2 = $o['input2'];
if (isset($o['input3'])) $this->input3 = $o['input3'];
if (isset($o['input4'])) $this->input4 = $o['input4'];
if (isset($o['input5'])) $this->input5 = $o['input5'];
if (isset($o['input6'])) $this->input6 = $o['input6'];
if (isset($o['input7'])) $this->input7 = $o['input7'];
if (isset($o['input8'])) $this->input8 = $o['input8'];
if (isset($o['input9'])) $this->input9 = $o['input9'];
if (isset($o['input10'])) $this->input10 = $o['input10'];
if (isset($o['output1'])) $this->output1 = $o['output1'];
if (isset($o['output2'])) $this->output2 = $o['output2'];
if (isset($o['output3'])) $this->output3 = $o['output3'];
if (isset($o['output4'])) $this->output4 = $o['output4'];
if (isset($o['output5'])) $this->output5 = $o['output5'];
if (isset($o['analogInput1'])) $this->analogInput1 = $o['analogInput1'];
if (isset($o['analogInput2'])) $this->analogInput2 = $o['analogInput2'];
if (isset($o['analogInput4'])) $this->analogInput4 = $o['analogInput4'];
if (isset($o['input1ChangeCounter'])) $this->input1ChangeCounter = $o['input1ChangeCounter'];
if (isset($o['input2ChangeCounter'])) $this->input2ChangeCounter = $o['input2ChangeCounter'];
if (isset($o['input3ChangeCounter'])) $this->input3ChangeCounter = $o['input3ChangeCounter'];
if (isset($o['input4ChangeCounter'])) $this->input4ChangeCounter = $o['input4ChangeCounter'];
if (isset($o['batteryLevel'])) $this->batteryLevel = $o['batteryLevel'];
if (isset($o['externalPower'])) $this->externalPower = $o['externalPower'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->time)) $o['time'] = JsonConverters::to('DateTime', $this->time);
if (isset($this->event)) $o['event'] = $this->event;
if (isset($this->keyId)) $o['keyId'] = $this->keyId;
if (isset($this->location)) $o['location'] = JsonConverters::to('Location', $this->location);
if (isset($this->address)) $o['address'] = JsonConverters::to('Address', $this->address);
if (isset($this->heading)) $o['heading'] = $this->heading;
if (isset($this->speed)) $o['speed'] = $this->speed;
if (isset($this->km)) $o['km'] = $this->km;
if (isset($this->run1)) $o['run1'] = $this->run1;
if (isset($this->run2)) $o['run2'] = $this->run2;
if (isset($this->run3)) $o['run3'] = $this->run3;
if (isset($this->run4)) $o['run4'] = $this->run4;
if (isset($this->runOdo)) $o['runOdo'] = $this->runOdo;
if (isset($this->temperature1)) $o['temperature1'] = $this->temperature1;
if (isset($this->temperature2)) $o['temperature2'] = $this->temperature2;
if (isset($this->input1)) $o['input1'] = $this->input1;
if (isset($this->input2)) $o['input2'] = $this->input2;
if (isset($this->input3)) $o['input3'] = $this->input3;
if (isset($this->input4)) $o['input4'] = $this->input4;
if (isset($this->input5)) $o['input5'] = $this->input5;
if (isset($this->input6)) $o['input6'] = $this->input6;
if (isset($this->input7)) $o['input7'] = $this->input7;
if (isset($this->input8)) $o['input8'] = $this->input8;
if (isset($this->input9)) $o['input9'] = $this->input9;
if (isset($this->input10)) $o['input10'] = $this->input10;
if (isset($this->output1)) $o['output1'] = $this->output1;
if (isset($this->output2)) $o['output2'] = $this->output2;
if (isset($this->output3)) $o['output3'] = $this->output3;
if (isset($this->output4)) $o['output4'] = $this->output4;
if (isset($this->output5)) $o['output5'] = $this->output5;
if (isset($this->analogInput1)) $o['analogInput1'] = $this->analogInput1;
if (isset($this->analogInput2)) $o['analogInput2'] = $this->analogInput2;
if (isset($this->analogInput4)) $o['analogInput4'] = $this->analogInput4;
if (isset($this->input1ChangeCounter)) $o['input1ChangeCounter'] = $this->input1ChangeCounter;
if (isset($this->input2ChangeCounter)) $o['input2ChangeCounter'] = $this->input2ChangeCounter;
if (isset($this->input3ChangeCounter)) $o['input3ChangeCounter'] = $this->input3ChangeCounter;
if (isset($this->input4ChangeCounter)) $o['input4ChangeCounter'] = $this->input4ChangeCounter;
if (isset($this->batteryLevel)) $o['batteryLevel'] = $this->batteryLevel;
if (isset($this->externalPower)) $o['externalPower'] = $this->externalPower;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class GetReportUnitHistoryResponse implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var array<UnitHistory>|null */
public ?array $list=null,
// @DataMember
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['list'])) $this->list = JsonConverters::fromArray('UnitHistory', $o['list']);
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->list)) $o['list'] = JsonConverters::toArray('UnitHistory', $this->list);
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class GetReportUnitHistory implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $unitId=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $from=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $to=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['unitId'])) $this->unitId = $o['unitId'];
if (isset($o['from'])) $this->from = JsonConverters::from('DateTime', $o['from']);
if (isset($o['to'])) $this->to = JsonConverters::from('DateTime', $o['to']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->unitId)) $o['unitId'] = $this->unitId;
if (isset($this->from)) $o['from'] = JsonConverters::to('DateTime', $this->from);
if (isset($this->to)) $o['to'] = JsonConverters::to('DateTime', $this->to);
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 /report/unithistory HTTP/1.1
Host: api.trackunit.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetReportUnitHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<From>0001-01-01T00:00:00</From>
<To>0001-01-01T00:00:00</To>
<UnitId>String</UnitId>
</GetReportUnitHistory>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetReportUnitHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<List>
<UnitHistory>
<Address>
<City>String</City>
<Country>String</Country>
<StreetAddress>String</StreetAddress>
<ZipCode>String</ZipCode>
</Address>
<AnalogInput1>0</AnalogInput1>
<AnalogInput2>0</AnalogInput2>
<AnalogInput4>0</AnalogInput4>
<BatteryLevel>0</BatteryLevel>
<Event>0</Event>
<ExternalPower>0</ExternalPower>
<Heading>0</Heading>
<Input1>false</Input1>
<Input10>false</Input10>
<Input1ChangeCounter>0</Input1ChangeCounter>
<Input2>false</Input2>
<Input2ChangeCounter>0</Input2ChangeCounter>
<Input3>false</Input3>
<Input3ChangeCounter>0</Input3ChangeCounter>
<Input4>false</Input4>
<Input4ChangeCounter>0</Input4ChangeCounter>
<Input5>false</Input5>
<Input6>false</Input6>
<Input7>false</Input7>
<Input8>false</Input8>
<Input9>false</Input9>
<KeyId>String</KeyId>
<Km>0</Km>
<Location>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
</Location>
<Output1>false</Output1>
<Output2>false</Output2>
<Output3>false</Output3>
<Output4>false</Output4>
<Output5>false</Output5>
<Run1>0</Run1>
<Run2>0</Run2>
<Run3>0</Run3>
<Run4>0</Run4>
<RunOdo>0</RunOdo>
<Speed>0</Speed>
<Temperature1>0</Temperature1>
<Temperature2>0</Temperature2>
<Time>0001-01-01T00:00:00</Time>
</UnitHistory>
</List>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<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>
</Meta>
</ResponseError>
</Errors>
<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>
</Meta>
</ResponseStatus>
</GetReportUnitHistoryResponse>