Trackunit API

<back to all web services

CreateAlarm

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

public class dtos
{

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

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

        @DataMember
        public ResponseStatus responseStatus = null;
        
        public String getId() { return id; }
        public CreateAlarmResponse setId(String value) { this.id = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public CreateAlarmResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

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

{"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"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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