Resource ia:queue-notifications

Overview

The ia:queue-notifications resource represents a subscription object and provides links to manage it.

Properties

The ia:queue-notifications resource has the following properties:

status	The status of the subscrition, the status can be "active" or "inactive"

status

The status of the subscrition, the status can be "active" or "inactive"

Link Relations

ia:queue	Link to the queue.
ia:subscribe-to-queue-notifications	Subscribe the user to notifications about queue changes.
ia:unsubscribe-from-queue-notifications	Unsubscribe the user from notifications about queue changes.

ia:queue

Link to the queue.

ia:subscribe-to-queue-notifications

Subscribe the user to notifications about queue changes.

ia:unsubscribe-from-queue-notifications

Unsubscribe the user from notifications about queue changes.

Description

The ia:queue-notifications resource represents a subscription object and provides links to manage it.

Examples

Example: ia:queue-notifications

 
{
    "status": "active",
    "_links": {
        "curies": [
            {
                "name": "ia",
                "href": "https://developer.avid.com/ctms/api/ia/linkrels/{rel}.html",
                "templated": true
            }
        ],
        "ia:queue": {
            "href": "https://host/.."
        },
        "ia:unsubscribe-from-queue-notifications": {
            "href": "https://host/.."
        },
        "self": {
            "href": "https://host/.."
        }
    }
}