Versions Compared

Version Old Version 3 New Version 4
Changes made by

Ramya Raman

Ramya Raman

Saved on

Key

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

GET audio_alarm_notification_agents

Resource Information

Requires Authentication?

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 

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

Code Block
languagejson
[
    {
        "AudioAlarmNotificationAgent": {
            "id": 1,
            "title": "disp20",
            "is_for_display_only": 1,
            "ignore_acknowledged": 1,
            "alarm_duration": 20,
            "modified": "1618225794271",
            "created": "1618225794271"
        }
    },
    {
        "AudioAlarmNotificationAgent": {
            "id": 2,
            "title": "all20",
            "is_for_display_only": 0,
            "ignore_acknowledged": 1,
            "alarm_duration": 20,
            "modified": "1618225794275",
            "created": "1618225794275"
        }
    }
]

 

 

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 

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

Code Block
languagejson
{
    "AudioAlarmNotificationAgent": {
        "id": 1,
        "title": "disp20",
        "is_for_display_only": 1,
        "ignore_acknowledged": 1,
        "alarm_duration": 20,
        "modified": "1618225794271",
        "created": "1618225794271"
    }
}

 

 

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 

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

Body:

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

Response:

Code Block
{
    "AudioAlarmNotificationAgent": {
        "id": 8,
        "title": "allPerm_NEW1",
        "is_for_display_only": 0,
        "ignore_acknowledged": 0,
        "alarm_duration": 0,
        "modified": "1618327310928",
        "created": "1618327310928"
    }
}

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

Body:

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

Response:

code

0/audio_alarm_notification_agents/14/.json

Code Block
languagejson
{
    "AudioAlarmNotificationAgent": {
        "id": 15,
        "title": "allPerm_test_2",
        "is_for_display_only": 0,
        "ignore_acknowledged": 0,
        "alarm_duration": 0,
        "modified": "1618659485746",
        "created": "1618659485746"
    }
}
 
 
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 
  1. http://192.168.0.203/api/2.0/audio_alarm_notification_agents/14/.json
Body:
 Code Block
{
    "AudioAlarmNotificationAgent": {
        "is_for_display_only": "0",
        "alarm_duration": "20",
        "title": "allPerm_test_NEW"
    }
}

Response:
 Code Block
{
    "AudioAlarmNotificationAgent": {
        "id": 14,
        "title": "allPerm_test_NEW",
        "is_for_display_only": 0,
        "ignore_acknowledged": 0,
        "alarm_duration": 20,
        "modified": "1618660646427",
        "created": "1618659088474"
    }
}

 
 
 
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 
  1. http://192.168.0.203/api/2.0/audio_alarm_notification_agents/1/.json
 Code Block
{
    "success": true
}