Trackunit API

<back to all web services

UpdateAlarm

namespace Trackunit.API

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type UpdateAlarmResponse() = 
        [<DataMember>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type TemperatureAlarmLimits() = 
        [<DataMember>]
        member val Temperature1LowerLimit:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val Temperature1UpperLimit:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val Temperature2LowerLimit:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val Temperature2UpperLimit:Nullable<Double> = new Nullable<Double>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ADVoltageAlarmLimits() = 
        [<DataMember>]
        member val ADVoltageLowerLimit:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val ADVoltageUpperLimit:Nullable<Double> = new Nullable<Double>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type Location() = 
        [<DataMember>]
        member val Latitude:Double = new Double() with get,set

        [<DataMember>]
        member val Longitude:Double = new Double() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type TimeOfDay() = 
        [<DataMember>]
        member val Hour:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Minute:Int32 = new Int32() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type UpdateAlarm() = 
        [<DataMember>]
        member val Id:String = null with get,set

        [<DataMember>]
        member val Name:String = null with get,set

        [<DataMember>]
        member val Enabled:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val AllUnits:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val ClearUnits:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val AddUnits:String[] = null with get,set

        [<DataMember>]
        member val RemoveUnits:String[] = null with get,set

        [<DataMember>]
        member val ClearGroups:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val AddGroups:String[] = null with get,set

        [<DataMember>]
        member val RemoveGroups:String[] = null with get,set

        [<DataMember>]
        member val ClearEmailRecipients:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val AddEmailRecipients:String[] = null with get,set

        [<DataMember>]
        member val RemoveEmailRecipients:String[] = null with get,set

        [<DataMember>]
        member val ClearSystemRecipients:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val AddSystemRecipients:String[] = null with get,set

        [<DataMember>]
        member val RemoveSystemRecipients:String[] = null with get,set

        [<DataMember>]
        member val ClearSmsRecipients:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val AddSmsRecipients:String[] = null with get,set

        [<DataMember>]
        member val RemoveSmsRecipients:String[] = null with get,set

        [<DataMember>]
        member val TemperatureLimits:TemperatureAlarmLimits = null with get,set

        [<DataMember>]
        member val ADVoltageLimits:ADVoltageAlarmLimits = null with get,set

        [<DataMember>]
        member val ADVoltageInputIndex:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val Threshold:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val BatteryLevel:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val Location:Location = null with get,set

        [<DataMember>]
        member val Radius:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val InputIndex:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val Interval:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val PointId:String = null with get,set

        [<DataMember>]
        member val ExpectedArrivalTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val PowerLevel:Nullable<Double> = new Nullable<Double>() with get,set

        [<DataMember>]
        member val Weekdays:String[] = null with get,set

        [<DataMember>]
        member val TimeStart:TimeOfDay = null with get,set

        [<DataMember>]
        member val TimeEnd:TimeOfDay = null with get,set

        [<DataMember>]
        member val ZoneId:String = null with get,set

F# UpdateAlarm DTOs

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

HTTP + SOAP12

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /soap12 HTTP/1.1 
Host: api.trackunit.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>

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

</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>

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

</soap12:Body>
</soap12:Envelope>