Trackunit API

<back to all web services

GetAlarmLog

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

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

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

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

        // @DataMember
        /** @var bool|null */
        public ?bool $delivered=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['contactId'])) $this->contactId = $o['contactId'];
        if (isset($o['sentVia'])) $this->sentVia = $o['sentVia'];
        if (isset($o['phoneNumber'])) $this->phoneNumber = $o['phoneNumber'];
        if (isset($o['email'])) $this->email = $o['email'];
        if (isset($o['delivered'])) $this->delivered = $o['delivered'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->contactId)) $o['contactId'] = $this->contactId;
        if (isset($this->sentVia)) $o['sentVia'] = $this->sentVia;
        if (isset($this->phoneNumber)) $o['phoneNumber'] = $this->phoneNumber;
        if (isset($this->email)) $o['email'] = $this->email;
        if (isset($this->delivered)) $o['delivered'] = $this->delivered;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

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

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

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

        // @DataMember
        /** @var array<AlarmRecipient>|null */
        public ?array $recipients=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['alarmId'])) $this->alarmId = $o['alarmId'];
        if (isset($o['unitId'])) $this->unitId = $o['unitId'];
        if (isset($o['triggeredAt'])) $this->triggeredAt = JsonConverters::from('DateTime', $o['triggeredAt']);
        if (isset($o['address'])) $this->address = JsonConverters::from('Address', $o['address']);
        if (isset($o['location'])) $this->location = JsonConverters::from('Location', $o['location']);
        if (isset($o['recipients'])) $this->recipients = JsonConverters::fromArray('AlarmRecipient', $o['recipients']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->alarmId)) $o['alarmId'] = $this->alarmId;
        if (isset($this->unitId)) $o['unitId'] = $this->unitId;
        if (isset($this->triggeredAt)) $o['triggeredAt'] = JsonConverters::to('DateTime', $this->triggeredAt);
        if (isset($this->address)) $o['address'] = JsonConverters::to('Address', $this->address);
        if (isset($this->location)) $o['location'] = JsonConverters::to('Location', $this->location);
        if (isset($this->recipients)) $o['recipients'] = JsonConverters::toArray('AlarmRecipient', $this->recipients);
        return empty($o) ? new class(){} : $o;
    }
}

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

// @DataContract
class GetAlarmLog implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string|null */
        public ?string $unitId=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['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->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 GetAlarmLog 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 /GetAlarmLog HTTP/1.1 
Host: api.trackunit.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

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

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

{"list":[{"alarmId":"String","unitId":"String","triggeredAt":"0001-01-01T00:00:00.0000000Z","address":{"country":"String","zipCode":"String","city":"String","streetAddress":"String"},"location":{"latitude":0,"longitude":0},"recipients":[{"contactId":"String","sentVia":"String","phoneNumber":"String","email":"String","delivered":false}]}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}