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}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Trackunit.API;

namespace Trackunit.API
{
    [DataContract]
    public partial class ADVoltageAlarmLimits
    {
        [DataMember]
        public virtual double? ADVoltageLowerLimit { get; set; }

        [DataMember]
        public virtual double? ADVoltageUpperLimit { get; set; }
    }

    [DataContract]
    public partial class Location
    {
        [DataMember]
        public virtual double Latitude { get; set; }

        [DataMember]
        public virtual double Longitude { get; set; }
    }

    [DataContract]
    public partial class TemperatureAlarmLimits
    {
        [DataMember]
        public virtual double? Temperature1LowerLimit { get; set; }

        [DataMember]
        public virtual double? Temperature1UpperLimit { get; set; }

        [DataMember]
        public virtual double? Temperature2LowerLimit { get; set; }

        [DataMember]
        public virtual double? Temperature2UpperLimit { get; set; }
    }

    [DataContract]
    public partial class TimeOfDay
    {
        [DataMember]
        public virtual int Hour { get; set; }

        [DataMember]
        public virtual int Minute { get; set; }
    }

    [DataContract]
    public partial class UpdateAlarm
    {
        [DataMember]
        public virtual string Id { get; set; }

        [DataMember]
        public virtual string Name { get; set; }

        [DataMember]
        public virtual bool? Enabled { get; set; }

        [DataMember]
        public virtual bool? AllUnits { get; set; }

        [DataMember]
        public virtual bool? ClearUnits { get; set; }

        [DataMember]
        public virtual string[] AddUnits { get; set; }

        [DataMember]
        public virtual string[] RemoveUnits { get; set; }

        [DataMember]
        public virtual bool? ClearGroups { get; set; }

        [DataMember]
        public virtual string[] AddGroups { get; set; }

        [DataMember]
        public virtual string[] RemoveGroups { get; set; }

        [DataMember]
        public virtual bool? ClearEmailRecipients { get; set; }

        [DataMember]
        public virtual string[] AddEmailRecipients { get; set; }

        [DataMember]
        public virtual string[] RemoveEmailRecipients { get; set; }

        [DataMember]
        public virtual bool? ClearSystemRecipients { get; set; }

        [DataMember]
        public virtual string[] AddSystemRecipients { get; set; }

        [DataMember]
        public virtual string[] RemoveSystemRecipients { get; set; }

        [DataMember]
        public virtual bool? ClearSmsRecipients { get; set; }

        [DataMember]
        public virtual string[] AddSmsRecipients { get; set; }

        [DataMember]
        public virtual string[] RemoveSmsRecipients { get; set; }

        [DataMember]
        public virtual TemperatureAlarmLimits TemperatureLimits { get; set; }

        [DataMember]
        public virtual ADVoltageAlarmLimits ADVoltageLimits { get; set; }

        [DataMember]
        public virtual int? ADVoltageInputIndex { get; set; }

        [DataMember]
        public virtual double? Threshold { get; set; }

        [DataMember]
        public virtual double? BatteryLevel { get; set; }

        [DataMember]
        public virtual Location Location { get; set; }

        [DataMember]
        public virtual double? Radius { get; set; }

        [DataMember]
        public virtual int? InputIndex { get; set; }

        [DataMember]
        public virtual double? Interval { get; set; }

        [DataMember]
        public virtual string PointId { get; set; }

        [DataMember]
        public virtual DateTime? ExpectedArrivalTime { get; set; }

        [DataMember]
        public virtual double? PowerLevel { get; set; }

        [DataMember]
        public virtual string[] Weekdays { get; set; }

        [DataMember]
        public virtual TimeOfDay TimeStart { get; set; }

        [DataMember]
        public virtual TimeOfDay TimeEnd { get; set; }

        [DataMember]
        public virtual string ZoneId { get; set; }
    }

    [DataContract]
    public partial class UpdateAlarmResponse
    {
        [DataMember]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# UpdateAlarm 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 /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>