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}
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 .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"id":"String","name":"String","enabled":false,"allUnits":false,"clearUnits":false,"addUnits":["String"],"removeUnits":["String"],"clearGroups":false,"addGroups":["String"],"removeGroups":["String"],"clearEmailRecipients":false,"addEmailRecipients":["String"],"removeEmailRecipients":["String"],"clearSystemRecipients":false,"addSystemRecipients":["String"],"removeSystemRecipients":["String"],"clearSmsRecipients":false,"addSmsRecipients":["String"],"removeSmsRecipients":["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: text/jsonl
Content-Length: length

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