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.*;

public class dtos
{

    @DataContract
    public static class GetAlarm
    {
        @DataMember
        public String id = null;
        
        public String getId() { return id; }
        public GetAlarm setId(String value) { this.id = value; return this; }
    }

    @DataContract
    public static class GetAlarmResponse
    {
        @DataMember
        public ArrayList<Alarm> list = null;

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

    @DataContract
    public static class Alarm
    {
        @DataMember
        public String id = null;

        @DataMember
        public Date created = null;

        @DataMember
        public String name = null;

        @DataMember
        public String type = null;

        @DataMember
        public Boolean enabled = null;

        @DataMember
        public Boolean allUnits = null;

        @DataMember
        public ArrayList<String> units = null;

        @DataMember
        public ArrayList<String> groups = null;

        @DataMember
        public ArrayList<String> emailRecipients = null;

        @DataMember
        public ArrayList<String> systemRecipients = null;

        @DataMember
        public ArrayList<String> smsRecipients = null;

        @DataMember
        public TemperatureAlarmLimits temperatureLimits = null;

        @DataMember
        public ADVoltageAlarmLimits adVoltageLimits = null;

        @DataMember
        public Integer adVoltageInputIndex = null;

        @DataMember
        public Double threshold = null;

        @DataMember
        public Double batteryLevel = null;

        @DataMember
        public Location location = null;

        @DataMember
        public Double radius = null;

        @DataMember
        public Integer inputIndex = null;

        @DataMember
        public Double interval = null;

        @DataMember
        public String pointId = null;

        @DataMember
        public Date expectedArrivalTime = null;

        @DataMember
        public Double powerLevel = null;

        @DataMember
        public ArrayList<String> weekdays = null;

        @DataMember
        public TimeOfDay timeStart = null;

        @DataMember
        public TimeOfDay timeEnd = null;

        @DataMember
        public String zoneId = null;
        
        public String getId() { return id; }
        public Alarm setId(String value) { this.id = value; return this; }
        public Date getCreated() { return created; }
        public Alarm setCreated(Date value) { this.created = value; return this; }
        public String getName() { return name; }
        public Alarm setName(String value) { this.name = value; return this; }
        public String getType() { return type; }
        public Alarm setType(String value) { this.type = value; return this; }
        public Boolean isEnabled() { return enabled; }
        public Alarm setEnabled(Boolean value) { this.enabled = value; return this; }
        public Boolean isAllUnits() { return allUnits; }
        public Alarm setAllUnits(Boolean value) { this.allUnits = value; return this; }
        public ArrayList<String> getUnits() { return units; }
        public Alarm setUnits(ArrayList<String> value) { this.units = value; return this; }
        public ArrayList<String> getGroups() { return groups; }
        public Alarm setGroups(ArrayList<String> value) { this.groups = value; return this; }
        public ArrayList<String> getEmailRecipients() { return emailRecipients; }
        public Alarm setEmailRecipients(ArrayList<String> value) { this.emailRecipients = value; return this; }
        public ArrayList<String> getSystemRecipients() { return systemRecipients; }
        public Alarm setSystemRecipients(ArrayList<String> value) { this.systemRecipients = value; return this; }
        public ArrayList<String> getSmsRecipients() { return smsRecipients; }
        public Alarm setSmsRecipients(ArrayList<String> value) { this.smsRecipients = value; return this; }
        public TemperatureAlarmLimits getTemperatureLimits() { return temperatureLimits; }
        public Alarm setTemperatureLimits(TemperatureAlarmLimits value) { this.temperatureLimits = value; return this; }
        public ADVoltageAlarmLimits getAdVoltageLimits() { return adVoltageLimits; }
        public Alarm setAdVoltageLimits(ADVoltageAlarmLimits value) { this.adVoltageLimits = value; return this; }
        public Integer getAdVoltageInputIndex() { return adVoltageInputIndex; }
        public Alarm setAdVoltageInputIndex(Integer value) { this.adVoltageInputIndex = value; return this; }
        public Double getThreshold() { return threshold; }
        public Alarm setThreshold(Double value) { this.threshold = value; return this; }
        public Double getBatteryLevel() { return batteryLevel; }
        public Alarm setBatteryLevel(Double value) { this.batteryLevel = value; return this; }
        public Location getLocation() { return location; }
        public Alarm setLocation(Location value) { this.location = value; return this; }
        public Double getRadius() { return radius; }
        public Alarm setRadius(Double value) { this.radius = value; return this; }
        public Integer getInputIndex() { return inputIndex; }
        public Alarm setInputIndex(Integer value) { this.inputIndex = value; return this; }
        public Double getInterval() { return interval; }
        public Alarm setInterval(Double value) { this.interval = value; return this; }
        public String getPointId() { return pointId; }
        public Alarm setPointId(String value) { this.pointId = value; return this; }
        public Date getExpectedArrivalTime() { return expectedArrivalTime; }
        public Alarm setExpectedArrivalTime(Date value) { this.expectedArrivalTime = value; return this; }
        public Double getPowerLevel() { return powerLevel; }
        public Alarm setPowerLevel(Double value) { this.powerLevel = value; return this; }
        public ArrayList<String> getWeekdays() { return weekdays; }
        public Alarm setWeekdays(ArrayList<String> value) { this.weekdays = value; return this; }
        public TimeOfDay getTimeStart() { return timeStart; }
        public Alarm setTimeStart(TimeOfDay value) { this.timeStart = value; return this; }
        public TimeOfDay getTimeEnd() { return timeEnd; }
        public Alarm setTimeEnd(TimeOfDay value) { this.timeEnd = value; return this; }
        public String getZoneId() { return zoneId; }
        public Alarm setZoneId(String value) { this.zoneId = value; return this; }
    }

    @DataContract
    public static class TemperatureAlarmLimits
    {
        @DataMember
        public Double temperature1LowerLimit = null;

        @DataMember
        public Double temperature1UpperLimit = null;

        @DataMember
        public Double temperature2LowerLimit = null;

        @DataMember
        public Double temperature2UpperLimit = null;
        
        public Double getTemperature1LowerLimit() { return temperature1LowerLimit; }
        public TemperatureAlarmLimits setTemperature1LowerLimit(Double value) { this.temperature1LowerLimit = value; return this; }
        public Double getTemperature1UpperLimit() { return temperature1UpperLimit; }
        public TemperatureAlarmLimits setTemperature1UpperLimit(Double value) { this.temperature1UpperLimit = value; return this; }
        public Double getTemperature2LowerLimit() { return temperature2LowerLimit; }
        public TemperatureAlarmLimits setTemperature2LowerLimit(Double value) { this.temperature2LowerLimit = value; return this; }
        public Double getTemperature2UpperLimit() { return temperature2UpperLimit; }
        public TemperatureAlarmLimits setTemperature2UpperLimit(Double value) { this.temperature2UpperLimit = value; return this; }
    }

    @DataContract
    public static class ADVoltageAlarmLimits
    {
        @DataMember
        public Double adVoltageLowerLimit = null;

        @DataMember
        public Double adVoltageUpperLimit = null;
        
        public Double getAdVoltageLowerLimit() { return adVoltageLowerLimit; }
        public ADVoltageAlarmLimits setAdVoltageLowerLimit(Double value) { this.adVoltageLowerLimit = value; return this; }
        public Double getAdVoltageUpperLimit() { return adVoltageUpperLimit; }
        public ADVoltageAlarmLimits setAdVoltageUpperLimit(Double value) { this.adVoltageUpperLimit = 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 TimeOfDay
    {
        @DataMember
        public Integer hour = null;

        @DataMember
        public Integer minute = null;
        
        public Integer getHour() { return hour; }
        public TimeOfDay setHour(Integer value) { this.hour = value; return this; }
        public Integer getMinute() { return minute; }
        public TimeOfDay setMinute(Integer value) { this.minute = value; return this; }
    }

}

Java GetAlarm DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<GetAlarm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Id>String</Id>
</GetAlarm>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<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>