AlarmAcknowledgementItem

Represents an instance of an alarm acknowledgement.

This is what an Alarm Acknowledgment is.

AlarmAcknowledgementItem Properties

AlarmAcknowledgementItem

Field Type Inherited from Description
CloseEvent Boolean AlarmAcknowledgementItem Gets or sets a value indicating whether [close event].Possible Values (true, false)
Comment String AlarmAcknowledgementItem Gets or sets the comment.
CreatedOn Nullable<DateTime> AlarmAcknowledgementItem Gets or sets when the entry was made. Will be set by the server regardless of the value supplied on the POST
HasImage Boolean AlarmAcknowledgementItem Gets or sets a value indicating whether this alarm acknowledgemant has an image.Possible Values (true, false)
Key String AlarmAcknowledgementItem Gets or sets the key.
User ObjectLinkItem AlarmAcknowledgementItem Gets or sets the user making the entry. Will be set by the serve regardless of the value supplied on the POST.

JSON Structure of AlarmAcknowledgementItem

{
   "CloseEvent"	:	"Boolean",
   "Comment"	:	"String",
   "CreatedOn"	:	"Nullable\<DateTime\>",
   "HasImage"	:	"Boolean",
   "Key"	:	"String",
   "User"	:	"[ObjectLinkItem](/object-model/objectlinkitem)"
}

Add Alarm Acknowledgement Async

Example in C#

// Returns: AlarmAcknowledgementItem
var alarmAcknowledgementItem = await client.AddAlarmAcknowledgementAsync(EventMessageData eventMessage, AlarmAcknowledgementItem acknowledgement)

Example in CURL



           curl -X POST \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/events/EVENT.KEY/acknowledgements \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -D '{
                       "$type":"Feenics.Keep.WebApi.Model.AlarmAcknowledgementItem, Feenics.Keep.WebApi.Model",
                       "Key":null,
                       "CloseEvent":false,
                       "Comment":null,
                       "HasImage":false,
                       "CreatedOn":null,
                       "User":null
                   }'
            

Add Alarm Acknowledgement Image Async

Example in C#

// Returns: nothing
await client.AddAlarmAcknowledgementImageAsync(EventMessageData eventMessage, String acknowledgementKey, Byte image)

Example in CURL



           curl -X POST \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/events/EVENT.KEY/acknowledgements/ACKNOWLEDGEMENTS.KEY/image \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -D '{
                       "$type":"Feenics.Keep.WebApi.Model.AlarmAcknowledgementItem, Feenics.Keep.WebApi.Model",
                       "Key":null,
                       "CloseEvent":false,
                       "Comment":null,
                       "HasImage":false,
                       "CreatedOn":null,
                       "User":null
                   }'
            

Get Alarm Acknowledgement Image Async

Example in C#

// Returns: Byte
var item = await client.GetAlarmAcknowledgementImageAsync(EventMessageData eventMessage, String acknowledgementKey)

Example in CURL



           curl -X GET \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/events/EVENT.KEY/acknowledgements/ACKNOWLEDGEMENTS.KEY/image \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'