Trackunit API

<back to all web services

GetAlarm

The following routes are available for this service:
GET POST/GetAlarm
GET POST/GetAlarm/{Id}
GET/Alarm
GET/Alarm/{Id}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class GetAlarm
{
    @DataMember
    open var id:String? = null
}

@DataContract
open class GetAlarmResponse
{
    @DataMember
    open var list:ArrayList<Alarm>? = null

    @DataMember
    open var responseStatus:ResponseStatus? = null
}

@DataContract
open class Alarm
{
    @DataMember
    open var id:String? = null

    @DataMember
    open var created:Date? = null

    @DataMember
    open var name:String? = null

    @DataMember
    @SerializedName("type") open var Type:String? = null

    @DataMember
    open var enabled:Boolean? = null

    @DataMember
    open var allUnits:Boolean? = null

    @DataMember
    open var units:ArrayList<String>? = null

    @DataMember
    open var groups:ArrayList<String>? = null

    @DataMember
    open var emailRecipients:ArrayList<String>? = null

    @DataMember
    open var systemRecipients:ArrayList<String>? = null

    @DataMember
    open var smsRecipients:ArrayList<String>? = null

    @DataMember
    open var temperatureLimits:TemperatureAlarmLimits? = null

    @DataMember
    open var adVoltageLimits:ADVoltageAlarmLimits? = null

    @DataMember
    open var adVoltageInputIndex:Int? = null

    @DataMember
    open var threshold:Double? = null

    @DataMember
    open var batteryLevel:Double? = null

    @DataMember
    open var location:Location? = null

    @DataMember
    open var radius:Double? = null

    @DataMember
    open var inputIndex:Int? = null

    @DataMember
    open var interval:Double? = null

    @DataMember
    open var pointId:String? = null

    @DataMember
    open var expectedArrivalTime:Date? = null

    @DataMember
    open var powerLevel:Double? = null

    @DataMember
    open var weekdays:ArrayList<String>? = null

    @DataMember
    open var timeStart:TimeOfDay? = null

    @DataMember
    open var timeEnd:TimeOfDay? = null

    @DataMember
    open var zoneId:String? = null
}

@DataContract
open class TemperatureAlarmLimits
{
    @DataMember
    open var temperature1LowerLimit:Double? = null

    @DataMember
    open var temperature1UpperLimit:Double? = null

    @DataMember
    open var temperature2LowerLimit:Double? = null

    @DataMember
    open var temperature2UpperLimit:Double? = null
}

@DataContract
open class ADVoltageAlarmLimits
{
    @DataMember
    open var adVoltageLowerLimit:Double? = null

    @DataMember
    open var adVoltageUpperLimit:Double? = null
}

@DataContract
open class Location
{
    @DataMember
    open var latitude:Double? = null

    @DataMember
    open var longitude:Double? = null
}

@DataContract
open class TimeOfDay
{
    @DataMember
    open var hour:Int? = null

    @DataMember
    open var minute:Int? = null
}

Kotlin GetAlarm 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 /GetAlarm HTTP/1.1 
Host: api.trackunit.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"list":[{"id":"String","created":"0001-01-01T00:00:00.0000000Z","name":"String","type":"String","enabled":false,"allUnits":false,"units":["String"],"groups":["String"],"emailRecipients":["String"],"systemRecipients":["String"],"smsRecipients":["String"],"temperatureLimits":{"temperature1LowerLimit":0,"temperature1UpperLimit":0,"temperature2LowerLimit":0,"temperature2UpperLimit":0},"adVoltageLimits":{"adVoltageLowerLimit":0,"adVoltageUpperLimit":0},"adVoltageInputIndex":0,"threshold":0,"batteryLevel":0,"location":{"latitude":0,"longitude":0},"radius":0,"inputIndex":0,"interval":0,"pointId":"String","expectedArrivalTime":"0001-01-01T00:00:00.0000000Z","powerLevel":0,"weekdays":["String"],"timeStart":{"hour":0,"minute":0},"timeEnd":{"hour":0,"minute":0},"zoneId":"String"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}