Trackunit API

<back to all web services

GetAlarmLog

The following routes are available for this service:
GET/alarmLog
GET POST/GetAlarmLog
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class GetAlarmLog
    {
        @DataMember
        public String unitId = null;

        @DataMember
        public Date dateFrom = null;

        @DataMember
        public Date dateTo = null;
        
        public String getUnitId() { return unitId; }
        public GetAlarmLog setUnitId(String value) { this.unitId = value; return this; }
        public Date getDateFrom() { return dateFrom; }
        public GetAlarmLog setDateFrom(Date value) { this.dateFrom = value; return this; }
        public Date getDateTo() { return dateTo; }
        public GetAlarmLog setDateTo(Date value) { this.dateTo = value; return this; }
    }

    @DataContract
    public static class GetAlarmLogResponse
    {
        @DataMember
        public ArrayList<AlarmLog> list = null;

        @DataMember
        public ResponseStatus responseStatus = null;
        
        public ArrayList<AlarmLog> getList() { return list; }
        public GetAlarmLogResponse setList(ArrayList<AlarmLog> value) { this.list = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetAlarmLogResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    @DataContract
    public static class AlarmLog
    {
        @DataMember
        public String alarmId = null;

        @DataMember
        public String unitId = null;

        @DataMember
        public Date triggeredAt = null;

        @DataMember
        public Address address = null;

        @DataMember
        public Location location = null;

        @DataMember
        public ArrayList<AlarmRecipient> recipients = null;
        
        public String getAlarmId() { return alarmId; }
        public AlarmLog setAlarmId(String value) { this.alarmId = value; return this; }
        public String getUnitId() { return unitId; }
        public AlarmLog setUnitId(String value) { this.unitId = value; return this; }
        public Date getTriggeredAt() { return triggeredAt; }
        public AlarmLog setTriggeredAt(Date value) { this.triggeredAt = value; return this; }
        public Address getAddress() { return address; }
        public AlarmLog setAddress(Address value) { this.address = value; return this; }
        public Location getLocation() { return location; }
        public AlarmLog setLocation(Location value) { this.location = value; return this; }
        public ArrayList<AlarmRecipient> getRecipients() { return recipients; }
        public AlarmLog setRecipients(ArrayList<AlarmRecipient> value) { this.recipients = value; return this; }
    }

    @DataContract
    public static class Address
    {
        @DataMember
        public String country = null;

        @DataMember
        public String zipCode = null;

        @DataMember
        public String city = null;

        @DataMember
        public String streetAddress = null;
        
        public String getCountry() { return country; }
        public Address setCountry(String value) { this.country = value; return this; }
        public String getZipCode() { return zipCode; }
        public Address setZipCode(String value) { this.zipCode = value; return this; }
        public String getCity() { return city; }
        public Address setCity(String value) { this.city = value; return this; }
        public String getStreetAddress() { return streetAddress; }
        public Address setStreetAddress(String value) { this.streetAddress = value; return this; }
    }

    @DataContract
    public static class Location
    {
        @DataMember
        public Double latitude = null;

        @DataMember
        public Double longitude = null;
        
        public Double getLatitude() { return latitude; }
        public Location setLatitude(Double value) { this.latitude = value; return this; }
        public Double getLongitude() { return longitude; }
        public Location setLongitude(Double value) { this.longitude = value; return this; }
    }

    @DataContract
    public static class AlarmRecipient
    {
        @DataMember
        public String contactId = null;

        @DataMember
        public String sentVia = null;

        @DataMember
        public String phoneNumber = null;

        @DataMember
        public String email = null;

        @DataMember
        public Boolean delivered = null;
        
        public String getContactId() { return contactId; }
        public AlarmRecipient setContactId(String value) { this.contactId = value; return this; }
        public String getSentVia() { return sentVia; }
        public AlarmRecipient setSentVia(String value) { this.sentVia = value; return this; }
        public String getPhoneNumber() { return phoneNumber; }
        public AlarmRecipient setPhoneNumber(String value) { this.phoneNumber = value; return this; }
        public String getEmail() { return email; }
        public AlarmRecipient setEmail(String value) { this.email = value; return this; }
        public Boolean isDelivered() { return delivered; }
        public AlarmRecipient setDelivered(Boolean value) { this.delivered = value; return this; }
    }

}

Java 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"}}}