Versions Compared

Version Old Version 5 New Version Current
Changes made by

Ramya Raman (Unlicensed)

Ramya Raman (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GET audio_alarm_notification_agents

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of Audio Alarm Agents configuration data.

Resource URL

http://{host}/api/2.0/audio_alarm_notification_agents/.format

Example Request

GET 

http://192.168.0.203/api/2.0/audio_alarm_notification_agents/.json

Code Block

Expand
titleRESPONSE
Code Block
languagejson
[
    {
        "AudioAlarmNotificationAgent": {
            "id": 1,
            "title":

"disp20

"

, "is_for_display_only": 1

_5s_",
            "ignore_acknowledged": 1,

"alarm_duration

"

: 20, "

modified": "

1618225794271

1717765541753",
            "created": "

1618225794271

1717765541753"
        }
    },
    {
        "AudioAlarmNotificationAgent": {
            "id": 2,
            "title": "

all20", "is_for_display_only": 0

_60s_",
            "ignore_acknowledged": 1

, "alarm_duration": 20

,
            "modified": "

1618225794275

1717765541755",
            "created": "

1618225794275

1717765541755"
        }
    }
]

 

 

GET audio_alarm_notification_agents/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single specific Audio Alarm Agent configuration data.

Resource URL

http://{host}/api/2.0/audio_alarm_notification_agents/{id}/.format

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired Audio Alarm Agent to be viewed.

Example Request

GET 

http://192.168.0.203/api/2.0/audio_alarm_notification_agents/1/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "AudioAlarmNotificationAgent": {
        "id": 1,
        "title": "

disp20", "is_for_display_only": 1

_5s_",
        "ignore_acknowledged": 1

, "alarm_duration": 20

,
        "modified": "

1618225794271

1717765541753",
        "created": "

1618225794271

1717765541753"
    }
}

 

 

POST audio_alarm_notification_agents

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Adds a new Audio Alarm Agent.

Resource URL

http://{host}/api/2.0/audio_alarm_notification_agents/.format

Example Request

POST 

http://192.168.0.203/api/2.0/audio_alarm_notification_agents/.jsonBody:

Expand
titleBODY
Code Block
languagejson
{
    "AudioAlarmNotificationAgent": {
        "is_for_display_only": "0",
        "alarm_duration": "0",
        "title": "allPerm_test"
    }
}

Response:

 Expand
titleRESPONSE
 Code Block
{
    "AudioAlarmNotificationAgent": {
        "id": 
8
9,
        "title": "allPerm_
NEW1
test",
        "
is_for_display_only": 0,
        "
ignore_acknowledged
": 0,
        
"
alarm_duration"
: 0,
        "modified": "
1618327310928
1718790120182",
        "created": "
1618327310928
1718790120182"
    }
}
POST audio_alarm_notification_agents/{id}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
POST
Duplicates a single specific Audio Alarm Agent into a new one, preserving all original data except the title.
Resource URL
http://{host}/api/2.0/audio_alarm_notification_agents/{id}/.format
Parameters
Parameter
Data Type
Description
id
(required)
integer
The ID of the desired Audio Alarm Agent to be copied.
Example Request
POST
1. http://192.168.0.203/api/2.0/audio_alarm_notification_agents/14/.json
 Expand
titleBODY
 Code Block
languagejson
{
    "AudioAlarmNotificationAgent": {
        "
id": 15,
   
is_for_display_only": "0",
        "alarm_duration": "0",
        "title": "allPerm_test"
    }
}
 Expand
titleRESPONSE
 Code Block
languagejson
{
    "
title
AudioAlarmNotificationAgent": 
"allPerm_test_2",
{
        "
is_for_display_only
id": 
0
14,
        "
ignore_acknowledged
title": 
0
"allPerm_test_2",
        "
alarm
ignore_
duration
acknowledged": 0,
        "modified": "
1618659485746
1718790392679",
        "created": "
1618659485746
1718790392679"
    }
}
 
PUT audio_alarm_notification_agents/{id}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
PUT
Updates a single specific Audio Alarm Agent configuration.
Resource URL
http://{host}/api/2.0/audio_alarm_notification_agents/{id}/.format
Parameters
Parameter
Data Type
Description
id
(required)
integer
The ID of the desired Audio Alarm Agent to be updated.
Example Request
PUT 
http://192.168.0.203/api/2.0/audio_alarm_notification_agents/14/.jsonBody:
 Expand
titleBODY
 Code Block
languagejson
{
    "AudioAlarmNotificationAgent": {
        "is_for_display_only": "0",
        "alarm_duration": "
20
0",
        "title": "allPerm_test_
NEW
edited"
    }
}

}
Response:
 Expand
titleRESPONSE
 Code Block
languagejson
{
    "AudioAlarmNotificationAgent": {
        "id": 14,
        "title": "allPerm_test_
NEW",
        "is_for_display_only": 0
edited",
        "ignore_acknowledged": 0,
        
"alarm_duration
"
: 20,
        "
modified": "
1618660646427
1718790607621",
        "created": "
1618659088474
1718790392679"
    }
}
 
 
DELETE audio_alarm_notification_agents/{id}
Resource Information
Requires Authentication?
Yes
Response Formats
json
HTTP Methods
DELETE
Deletes a single specific Audio Alarm Agent.
Resource URL
http://{host}/api/2.0/audio_alarm_notification_agents/{id}/.format
Parameters
Parameter
Data Type
Description
id
(required)
integer
The ID of the desired Audio Alarm Agent to be deleted.
Example Request
DELETE 
http://192.168.0.203/api/2.0/audio_alarm_notification_agents/1/.json
 Expand
titleRESPONSE
 Code Block
languagejson
{
    "success": true
}