Trackunit API

<back to all web services

GetReportKeyHistory

The following routes are available for this service:
GET POST/report/keyhistory
<?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 KeyHistory implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string|null */
        public ?string $unitId=null,

        // @DataMember
        /** @var DateTime */
        public DateTime $time=new DateTime(),

        // @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 $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 $output3=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['unitId'])) $this->unitId = $o['unitId'];
        if (isset($o['time'])) $this->time = JsonConverters::from('DateTime', $o['time']);
        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['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['output3'])) $this->output3 = $o['output3'];
        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->unitId)) $o['unitId'] = $this->unitId;
        if (isset($this->time)) $o['time'] = JsonConverters::to('DateTime', $this->time);
        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->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->output3)) $o['output3'] = $this->output3;
        if (isset($this->batteryLevel)) $o['batteryLevel'] = $this->batteryLevel;
        if (isset($this->externalPower)) $o['externalPower'] = $this->externalPower;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class GetReportKeyHistoryResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var array<KeyHistory>|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('KeyHistory', $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('KeyHistory', $this->list);
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class GetReportKeyHistory implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string|null */
        public ?string $keyId=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['keyId'])) $this->keyId = $o['keyId'];
        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->keyId)) $o['keyId'] = $this->keyId;
        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;
    }
}

PHP GetReportKeyHistory DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /report/keyhistory HTTP/1.1 
Host: api.trackunit.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"keyId":"String","from":"0001-01-01T00:00:00.0000000Z","to":"0001-01-01T00:00:00.0000000Z"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"list":[{"unitId":"String","time":"0001-01-01T00:00:00.0000000Z","location":{"latitude":0,"longitude":0},"address":{"country":"String","zipCode":"String","city":"String","streetAddress":"String"},"heading":0,"speed":0,"km":0,"run1":0,"run2":0,"runOdo":0,"temperature1":0,"temperature2":0,"input1":false,"input2":false,"output3":false,"batteryLevel":0,"externalPower":0}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}