Trackunit API

CreateAlarm

The following routes are available for this service:
POST	/Alarm
GET POST	/CreateAlarm

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Trackunit.API

Namespace Global

    Namespace Trackunit.API

        <DataContract>
        Public Partial Class ADVoltageAlarmLimits
            <DataMember>
            Public Overridable Property ADVoltageLowerLimit As Double?

            <DataMember>
            Public Overridable Property ADVoltageUpperLimit As Double?
        End Class

        <DataContract>
        Public Partial Class CreateAlarm
            <DataMember>
            Public Overridable Property Name As String

            <DataMember>
            Public Overridable Property Type As String

            <DataMember>
            Public Overridable Property Enabled As Boolean?

            <DataMember>
            Public Overridable Property AllUnits As Boolean?

            <DataMember>
            Public Overridable Property Units As String()

            <DataMember>
            Public Overridable Property Groups As String()

            <DataMember>
            Public Overridable Property EmailRecipients As String()

            <DataMember>
            Public Overridable Property SystemRecipients As String()

            <DataMember>
            Public Overridable Property SmsRecipients As String()

            <DataMember>
            Public Overridable Property TemperatureLimits As TemperatureAlarmLimits

            <DataMember>
            Public Overridable Property ADVoltageLimits As ADVoltageAlarmLimits

            <DataMember>
            Public Overridable Property ADVoltageInputIndex As Integer?

            <DataMember>
            Public Overridable Property Threshold As Double?

            <DataMember>
            Public Overridable Property BatteryLevel As Double?

            <DataMember>
            Public Overridable Property Location As Location

            <DataMember>
            Public Overridable Property Radius As Double?

            <DataMember>
            Public Overridable Property InputIndex As Integer?

            <DataMember>
            Public Overridable Property Interval As Double?

            <DataMember>
            Public Overridable Property PointId As String

            <DataMember>
            Public Overridable Property ExpectedArrivalTime As Date?

            <DataMember>
            Public Overridable Property PowerLevel As Double?

            <DataMember>
            Public Overridable Property Weekdays As String()

            <DataMember>
            Public Overridable Property TimeStart As TimeOfDay

            <DataMember>
            Public Overridable Property TimeEnd As TimeOfDay

            <DataMember>
            Public Overridable Property ZoneId As String
        End Class

        <DataContract>
        Public Partial Class CreateAlarmResponse
            <DataMember>
            Public Overridable Property Id As String

            <DataMember>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        <DataContract>
        Public Partial Class Location
            <DataMember>
            Public Overridable Property Latitude As Double

            <DataMember>
            Public Overridable Property Longitude As Double
        End Class

        <DataContract>
        Public Partial Class TemperatureAlarmLimits
            <DataMember>
            Public Overridable Property Temperature1LowerLimit As Double?

            <DataMember>
            Public Overridable Property Temperature1UpperLimit As Double?

            <DataMember>
            Public Overridable Property Temperature2LowerLimit As Double?

            <DataMember>
            Public Overridable Property Temperature2UpperLimit As Double?
        End Class

        <DataContract>
        Public Partial Class TimeOfDay
            <DataMember>
            Public Overridable Property Hour As Integer

            <DataMember>
            Public Overridable Property Minute As Integer
        End Class
    End Namespace
End Namespace

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

<CreateAlarm 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>
  <AllUnits>false</AllUnits>
  <BatteryLevel>0</BatteryLevel>
  <EmailRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EmailRecipients>
  <Enabled>false</Enabled>
  <ExpectedArrivalTime>0001-01-01T00:00:00</ExpectedArrivalTime>
  <Groups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Groups>
  <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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SmsRecipients>
  <SystemRecipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1: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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Units>
  <Weekdays xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Weekdays>
  <ZoneId>String</ZoneId>
</CreateAlarm>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateAlarmResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Id>String</Id>
  <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>
</CreateAlarmResponse>