Versions Compared

Version Old Version 3 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 display_notification_agents/meta

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of meta data used with Display agent.

Resource URL

http://{host}/api/2.0/display_notification_agents/meta/.format

Example Request

GET 

  1. http://44.235.52.211/api/2.0/display_notification_agents/meta/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "ActiveColors": {
        "1": "Red",
        "2": "Blue",
        "3": "Green",
        "4": "Orange",
        "5": "Yellow",
        "6": "Light Blue",
        "7": "Light Green",
        "8": "Pink",
        "9": "Black",
        "10": "White"
    },
    "BlinkColors": {
        "1": "Red",
        "2": "Blue",
        "3": "Green",
        "4": "Orange",
        "5": "Yellow",
        "6": "Light Blue",
        "7": "Light Green",
        "8": "Pink",
        "9": "Black",
        "10": "White"
    },
    "NonActiveColors": {
        "1": "Red",
        "2": "Blue",
        "3": "Green",
        "4": "Orange",
        "5": "Yellow",
        "6": "Light Blue",
        "7": "Light Green",
        "8": "Pink",
        "9": "Black",
        "10": "White"
    },
    "BorderColors": {
        "1": "Red",
        "2": "Blue",
        "3": "Green",
        "4": "Orange",
        "5": "Yellow",
        "6": "Light Blue",
        "7": "Light Green",
        "8": "Pink",
        "9": "Black",
        "10": "White"
    }
}

 

 

GET display_notification_agents

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a list of Display Agents configurations.

Resource URL

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

Example Request

GET 

  1. http://44.235.52.211/api/2.0/display_notification_agents/.json

Expand
titleRESPONSE
Code Block
languagejson
[
    {
        "DisplayNotificationAgent": {
            "id": 1,
            "title": "Red",
            "active_color_id": 1,
            "blink_color_id": 1,
            "nonactive_color_id": 9,
            "decay_time": 30,
            "draw_border": 1,
            "draw_text": 1,
            "border_color_id": 1,
            "modified": "1611142282208",
            "created": "1611142282208"
        }
    },
    {
        "DisplayNotificationAgent": {
            "id": 2,
            "title": "Blue",
            "active_color_id": 2,
            "blink_color_id": 2,
            "nonactive_color_id": 9,
            "decay_time": 30,
            "draw_border": 0,
            "draw_text": 1,
            "border_color_id": 1,
            "modified": "1611142282208",
            "created": "1611142282208"
        }
    }    
]

 

 

GET display_notification_agents/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

GET

Returns a single Display Agent configuration.

Resource URL

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

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired display agent.

Example Request

GET 

  1. http://44.235.52.211/api/2.0/display_notification_agents/2/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "DisplayNotificationAgent": {
        "id": 2,
        "title": "Blue",
        "active_color_id": 2,
        "blink_color_id": 2,
        "nonactive_color_id": 9,
        "decay_time": 30,
        "draw_border": 0,
        "draw_text": 1,
        "border_color_id": 1,
        "modified": "1611142282208",
        "created": "1611142282208"
    }
}

 

 

POST display_notification_agents

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Adds a new Display Agent.

Resource URL

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

Example Request

POST 

  1. http://44.235.52.211/api/2.0/display_notification_agents/.json

Expand
Body
titleBODY
Code Block
languagejson
{
    "DisplayNotificationAgent": {
        "active_color_id": "3",
        "border_color_id": "1",
        "blink_color_id": "2",
        "decay_time": "10",
        "draw_border": "0",
        "draw_text": "1",
        "nonactive_color_id": "9",
        "title": "Green_dc"
    }
}
Expand
title
Response
RESPONSE
Code Block
languagejson
{
    "DisplayNotificationAgent": {
        "active_color_id": "3",
        "border_color_id": "1",
        "decay_time": "10",
        "draw_border": "0",
        "draw_text": "1",
        "nonactive_color_id": "9",
        "title": "Green"
    }
}

 

 

POST display_notification_agents/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

POST

Copies an existing Display Agent configuration into a new agent.

Resource URL

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

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired Display Agent to be copied.

Example Request

POST 

  1. http://44.235.52.211/api/2.0/display_notification_agents/1/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "DisplayNotificationAgent": {
        "id": 9,
        "title": "Red_2",
        "active_color_id": 1,
        "blink_color_id": 1,
        "nonactive_color_id": 9,
        "decay_time": 30,
        "draw_border": 1,
        "draw_text": 1,
        "border_color_id": 1,
        "modified": "1619430440481",
        "created": "1619430440481"
    }
}

 

 

PUT display_notification_agents/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

PUT

Updates an existing Display Agent.

Resource URL

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

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired Display Agent to be updated.

Example Request

PUT 

  1. http://44.235.52.211/api/2.0/display_notification_agents/1/.json

Body
Expand
titleBODY
Code Block
languagejson
{
  "DisplayNotificationAgent": {
    "active_color_id": 1,
    "border_color_id": 1,
    "decay_time": 10,
    "draw_border": 1,
    "draw_text": 1,
    "id": 1,
    "nonactive_color_id": 9,
    "title": "EDIT_Red"
  }
}
Response
Expand
titleRESPONSE
Code Block
languagejson
{
  "DisplayNotificationAgent": {
    "active_color_id": 1,
    "border_color_id": 1,
    "decay_time": 10,
    "draw_border": 1,
    "draw_text": 1,
    "id": 1,
    "nonactive_color_id": 9,
    "title": "EDIT_Red"
  }
}

 

 

DELETE display_notification_agents/{id}

Resource Information

Requires Authentication?

Yes

Response Formats

json

HTTP Methods

DELETE

Deletes an existing Display Agent.

Resource URL

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

Parameters

Parameter

Data Type

Description

id
(required)

integer

The ID of the desired Display Agent to be deleted.

Example Request

DELETE 

  1. http://44.235.52.211/api/2.0/display_notification_agents/1/.json

Expand
titleRESPONSE
Code Block
languagejson
{
    "success": true
}