| PUT | /Alarm | ||
|---|---|---|---|
| PUT | /Alarm/{Id} | ||
| GET POST | /UpdateAlarm | ||
| GET POST | /UpdateAlarm/{Id} |
"use strict";
export class UpdateAlarmResponse {
/** @param {{responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
}
export class TemperatureAlarmLimits {
/** @param {{temperature1LowerLimit?:number,temperature1UpperLimit?:number,temperature2LowerLimit?:number,temperature2UpperLimit?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
temperature1LowerLimit;
/** @type {?number} */
temperature1UpperLimit;
/** @type {?number} */
temperature2LowerLimit;
/** @type {?number} */
temperature2UpperLimit;
}
export class ADVoltageAlarmLimits {
/** @param {{adVoltageLowerLimit?:number,adVoltageUpperLimit?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
adVoltageLowerLimit;
/** @type {?number} */
adVoltageUpperLimit;
}
export class Location {
/** @param {{latitude?:number,longitude?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
latitude;
/** @type {number} */
longitude;
}
export class TimeOfDay {
/** @param {{hour?:number,minute?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
hour;
/** @type {number} */
minute;
}
export class UpdateAlarm {
/** @param {{id?:string,name?:string,enabled?:boolean,allUnits?:boolean,clearUnits?:boolean,addUnits?:string[],removeUnits?:string[],clearGroups?:boolean,addGroups?:string[],removeGroups?:string[],clearEmailRecipients?:boolean,addEmailRecipients?:string[],removeEmailRecipients?:string[],clearSystemRecipients?:boolean,addSystemRecipients?:string[],removeSystemRecipients?:string[],clearSmsRecipients?:boolean,addSmsRecipients?:string[],removeSmsRecipients?:string[],temperatureLimits?:TemperatureAlarmLimits,adVoltageLimits?:ADVoltageAlarmLimits,adVoltageInputIndex?:number,threshold?:number,batteryLevel?:number,location?:Location,radius?:number,inputIndex?:number,interval?:number,pointId?:string,expectedArrivalTime?:string,powerLevel?:number,weekdays?:string[],timeStart?:TimeOfDay,timeEnd?:TimeOfDay,zoneId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
id;
/** @type {string} */
name;
/** @type {?boolean} */
enabled;
/** @type {?boolean} */
allUnits;
/** @type {?boolean} */
clearUnits;
/** @type {string[]} */
addUnits;
/** @type {string[]} */
removeUnits;
/** @type {?boolean} */
clearGroups;
/** @type {string[]} */
addGroups;
/** @type {string[]} */
removeGroups;
/** @type {?boolean} */
clearEmailRecipients;
/** @type {string[]} */
addEmailRecipients;
/** @type {string[]} */
removeEmailRecipients;
/** @type {?boolean} */
clearSystemRecipients;
/** @type {string[]} */
addSystemRecipients;
/** @type {string[]} */
removeSystemRecipients;
/** @type {?boolean} */
clearSmsRecipients;
/** @type {string[]} */
addSmsRecipients;
/** @type {string[]} */
removeSmsRecipients;
/** @type {TemperatureAlarmLimits} */
temperatureLimits;
/** @type {ADVoltageAlarmLimits} */
adVoltageLimits;
/** @type {?number} */
adVoltageInputIndex;
/** @type {?number} */
threshold;
/** @type {?number} */
batteryLevel;
/** @type {Location} */
location;
/** @type {?number} */
radius;
/** @type {?number} */
inputIndex;
/** @type {?number} */
interval;
/** @type {string} */
pointId;
/** @type {?string} */
expectedArrivalTime;
/** @type {?number} */
powerLevel;
/** @type {string[]} */
weekdays;
/** @type {TimeOfDay} */
timeStart;
/** @type {TimeOfDay} */
timeEnd;
/** @type {string} */
zoneId;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<UpdateAlarm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<ADVoltageInputIndex>0</ADVoltageInputIndex>
<ADVoltageLimits>
<ADVoltageLowerLimit>0</ADVoltageLowerLimit>
<ADVoltageUpperLimit>0</ADVoltageUpperLimit>
</ADVoltageLimits>
<AddEmailRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AddEmailRecipients>
<AddGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AddGroups>
<AddSmsRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AddSmsRecipients>
<AddSystemRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AddSystemRecipients>
<AddUnits xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AddUnits>
<AllUnits>false</AllUnits>
<BatteryLevel>0</BatteryLevel>
<ClearEmailRecipients>false</ClearEmailRecipients>
<ClearGroups>false</ClearGroups>
<ClearSmsRecipients>false</ClearSmsRecipients>
<ClearSystemRecipients>false</ClearSystemRecipients>
<ClearUnits>false</ClearUnits>
<Enabled>false</Enabled>
<ExpectedArrivalTime>0001-01-01T00:00:00</ExpectedArrivalTime>
<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>
<RemoveEmailRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RemoveEmailRecipients>
<RemoveGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RemoveGroups>
<RemoveSmsRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RemoveSmsRecipients>
<RemoveSystemRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RemoveSystemRecipients>
<RemoveUnits xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RemoveUnits>
<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>
<Weekdays xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Weekdays>
<ZoneId>String</ZoneId>
</UpdateAlarm>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<UpdateAlarmResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<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>
</UpdateAlarmResponse>