Trackunit API

<back to all web services

GetReportUnitSummary

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

        // @DataMember
        /** @var DateTime|null */
        public ?DateTime $startTime=null,

        // @DataMember
        /** @var Location|null */
        public ?Location $startLocation=null,

        // @DataMember
        /** @var Address|null */
        public ?Address $startAddress=null,

        // @DataMember
        /** @var DateTime|null */
        public ?DateTime $stopTime=null,

        // @DataMember
        /** @var Location|null */
        public ?Location $stopLocation=null,

        // @DataMember
        /** @var Address|null */
        public ?Address $stopAddress=null,

        // @DataMember
        /** @var int */
        public int $input1ChangeCounter=0,

        // @DataMember
        /** @var int */
        public int $input2ChangeCounter=0,

        // @DataMember
        /** @var float */
        public float $run1=0.0,

        // @DataMember
        /** @var float */
        public float $run2=0.0,

        // @DataMember
        /** @var float */
        public float $run3=0.0,

        // @DataMember
        /** @var float */
        public float $run4=0.0,

        // @DataMember
        /** @var float */
        public float $runOdo=0.0,

        // @DataMember
        /** @var float */
        public float $km=0.0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['unitId'])) $this->unitId = $o['unitId'];
        if (isset($o['startTime'])) $this->startTime = JsonConverters::from('DateTime', $o['startTime']);
        if (isset($o['startLocation'])) $this->startLocation = JsonConverters::from('Location', $o['startLocation']);
        if (isset($o['startAddress'])) $this->startAddress = JsonConverters::from('Address', $o['startAddress']);
        if (isset($o['stopTime'])) $this->stopTime = JsonConverters::from('DateTime', $o['stopTime']);
        if (isset($o['stopLocation'])) $this->stopLocation = JsonConverters::from('Location', $o['stopLocation']);
        if (isset($o['stopAddress'])) $this->stopAddress = JsonConverters::from('Address', $o['stopAddress']);
        if (isset($o['input1ChangeCounter'])) $this->input1ChangeCounter = $o['input1ChangeCounter'];
        if (isset($o['input2ChangeCounter'])) $this->input2ChangeCounter = $o['input2ChangeCounter'];
        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['km'])) $this->km = $o['km'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->unitId)) $o['unitId'] = $this->unitId;
        if (isset($this->startTime)) $o['startTime'] = JsonConverters::to('DateTime', $this->startTime);
        if (isset($this->startLocation)) $o['startLocation'] = JsonConverters::to('Location', $this->startLocation);
        if (isset($this->startAddress)) $o['startAddress'] = JsonConverters::to('Address', $this->startAddress);
        if (isset($this->stopTime)) $o['stopTime'] = JsonConverters::to('DateTime', $this->stopTime);
        if (isset($this->stopLocation)) $o['stopLocation'] = JsonConverters::to('Location', $this->stopLocation);
        if (isset($this->stopAddress)) $o['stopAddress'] = JsonConverters::to('Address', $this->stopAddress);
        if (isset($this->input1ChangeCounter)) $o['input1ChangeCounter'] = $this->input1ChangeCounter;
        if (isset($this->input2ChangeCounter)) $o['input2ChangeCounter'] = $this->input2ChangeCounter;
        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->km)) $o['km'] = $this->km;
        return empty($o) ? new class(){} : $o;
    }
}

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

// @DataContract
class GetReportUnitSummary implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string|null */
        public ?string $unitId=null,

        // @DataMember
        /** @var DateTime|null */
        public ?DateTime $date=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['unitId'])) $this->unitId = $o['unitId'];
        if (isset($o['date'])) $this->date = JsonConverters::from('DateTime', $o['date']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->unitId)) $o['unitId'] = $this->unitId;
        if (isset($this->date)) $o['date'] = JsonConverters::to('DateTime', $this->date);
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetReportUnitSummary DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /report/unitsummary HTTP/1.1 
Host: api.trackunit.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"unitId":"String","date":"0001-01-01T00:00:00.0000000Z"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"list":[{"unitId":"String","startTime":"0001-01-01T00:00:00.0000000Z","startLocation":{"latitude":0,"longitude":0},"startAddress":{"country":"String","zipCode":"String","city":"String","streetAddress":"String"},"stopTime":"0001-01-01T00:00:00.0000000Z","stopLocation":{"latitude":0,"longitude":0},"stopAddress":{"country":"String","zipCode":"String","city":"String","streetAddress":"String"},"input1ChangeCounter":0,"input2ChangeCounter":0,"run1":0,"run2":0,"run3":0,"run4":0,"runOdo":0,"km":0}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}