Trackunit API

<back to all web services

UpdateAlarm

The following routes are available for this service:
PUT/Alarm
PUT/Alarm/{Id}
GET POST/UpdateAlarm
GET POST/UpdateAlarm/{Id}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


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

    @DataMember
    open var name:String? = null

    @DataMember
    open var enabled:Boolean? = null

    @DataMember
    open var allUnits:Boolean? = null

    @DataMember
    open var clearUnits:Boolean? = null

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

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

    @DataMember
    open var clearGroups:Boolean? = null

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

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

    @DataMember
    open var clearEmailRecipients:Boolean? = null

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

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

    @DataMember
    open var clearSystemRecipients:Boolean? = null

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

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

    @DataMember
    open var clearSmsRecipients:Boolean? = null

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

    @DataMember
    open var removeSmsRecipients: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
}

@DataContract
open class UpdateAlarmResponse
{
    @DataMember
    open var responseStatus:ResponseStatus? = null
}

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

{"id":"String","name":"String","enabled":false,"allUnits":false,"clearUnits":false,"addUnits":["String"],"removeUnits":["String"],"clearGroups":false,"addGroups":["String"],"removeGroups":["String"],"clearEmailRecipients":false,"addEmailRecipients":["String"],"removeEmailRecipients":["String"],"clearSystemRecipients":false,"addSystemRecipients":["String"],"removeSystemRecipients":["String"],"clearSmsRecipients":false,"addSmsRecipients":["String"],"removeSmsRecipients":["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"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}