Trackunit API

<back to all web services

GetReportTrip

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

        // @DataMember
        /** @var string|null */
        public ?string $keyId=null,

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

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

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

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

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

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

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

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

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

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

        // @DataMember
        /** @var bool|null */
        public ?bool $finished=null,

        // @DataMember
        /** @var float|null */
        public ?float $maxSpeed=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['unitId'])) $this->unitId = $o['unitId'];
        if (isset($o['keyId'])) $this->keyId = $o['keyId'];
        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['startKm'])) $this->startKm = $o['startKm'];
        if (isset($o['startRun1'])) $this->startRun1 = $o['startRun1'];
        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['stopKm'])) $this->stopKm = $o['stopKm'];
        if (isset($o['stopRun1'])) $this->stopRun1 = $o['stopRun1'];
        if (isset($o['finished'])) $this->finished = $o['finished'];
        if (isset($o['maxSpeed'])) $this->maxSpeed = $o['maxSpeed'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->unitId)) $o['unitId'] = $this->unitId;
        if (isset($this->keyId)) $o['keyId'] = $this->keyId;
        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->startKm)) $o['startKm'] = $this->startKm;
        if (isset($this->startRun1)) $o['startRun1'] = $this->startRun1;
        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->stopKm)) $o['stopKm'] = $this->stopKm;
        if (isset($this->stopRun1)) $o['stopRun1'] = $this->stopRun1;
        if (isset($this->finished)) $o['finished'] = $this->finished;
        if (isset($this->maxSpeed)) $o['maxSpeed'] = $this->maxSpeed;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

        // @DataMember
        /** @var string|null */
        public ?string $keyId=null,

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

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

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

PHP GetReportTrip 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/trip HTTP/1.1 
Host: api.trackunit.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"unitId":"String","keyId":"String","dateFrom":"0001-01-01T00:00:00.0000000Z","dateTo":"0001-01-01T00:00:00.0000000Z"}

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

{"list":[{"unitId":"String","keyId":"String","startTime":"0001-01-01T00:00:00.0000000Z","startLocation":{"latitude":0,"longitude":0},"startAddress":{"country":"String","zipCode":"String","city":"String","streetAddress":"String"},"startKm":0,"startRun1":0,"stopTime":"0001-01-01T00:00:00.0000000Z","stopLocation":{"latitude":0,"longitude":0},"stopAddress":{"country":"String","zipCode":"String","city":"String","streetAddress":"String"},"stopKm":0,"stopRun1":0,"finished":false,"maxSpeed":0}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}