Trackunit API

<back to all web services

GetAlarm

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 .soap11 suffix or ?format=soap11

HTTP + SOAP11

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /soap11 HTTP/1.1 
Host: api.trackunit.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: GetAlarm

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>

<GetAlarm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Id>String</Id>
</GetAlarm>

</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>

<GetAlarmResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <List>
    <Alarm>
      <ADVoltageInputIndex>0</ADVoltageInputIndex>
      <ADVoltageLimits>
        <ADVoltageLowerLimit>0</ADVoltageLowerLimit>
        <ADVoltageUpperLimit>0</ADVoltageUpperLimit>
      </ADVoltageLimits>
      <AllUnits>false</AllUnits>
      <BatteryLevel>0</BatteryLevel>
      <Created>0001-01-01T00:00:00</Created>
      <EmailRecipients xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </EmailRecipients>
      <Enabled>false</Enabled>
      <ExpectedArrivalTime>0001-01-01T00:00:00</ExpectedArrivalTime>
      <Groups xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Groups>
      <Id>String</Id>
      <InputIndex>0</InputIndex>
      <Interval>0</Interval>
      <Location>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
      </Location>
      <Name>String</Name>
      <PointId>String</PointId>
      <PowerLevel>0</PowerLevel>
      <Radius>0</Radius>
      <SmsRecipients xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </SmsRecipients>
      <SystemRecipients xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </SystemRecipients>
      <TemperatureLimits>
        <Temperature1LowerLimit>0</Temperature1LowerLimit>
        <Temperature1UpperLimit>0</Temperature1UpperLimit>
        <Temperature2LowerLimit>0</Temperature2LowerLimit>
        <Temperature2UpperLimit>0</Temperature2UpperLimit>
      </TemperatureLimits>
      <Threshold>0</Threshold>
      <TimeEnd>
        <Hour>0</Hour>
        <Minute>0</Minute>
      </TimeEnd>
      <TimeStart>
        <Hour>0</Hour>
        <Minute>0</Minute>
      </TimeStart>
      <Type>String</Type>
      <Units xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Units>
      <Weekdays xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Weekdays>
      <ZoneId>String</ZoneId>
    </Alarm>
  </List>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</GetAlarmResponse>

</soap:Body>
</soap:Envelope>