Subscribing devices to a topic

Request

To subscribe one or more devices to a topic, send a PUT request to:

http://<host>:<port>/mib/v1/topics/{topicName}/devices

Headers

• Content-Type: application/json

Mandatory fields

• topicName (in both URL and payload) – the name of the topic

• active – set to true to leave the topic active, or to activate it if it is not active. (true is the default.)

• devices – one object for each device to be subscribed, containing at least:

  • deviceId – the unique ID of the device

  • subscriptionStatus – set this to true to subscribe the device.

Example

A request with this payload subscribes the specified devices to a topic (and creates the topic if it does not already exist):

{
  "topicName": "New-Videos",
  "active": true,
  "devices": [
    {
      "deviceId": "59bb5fbbc6f9d5000801ae28",
      "subscriptionStatus": true
    },
    {
      "deviceId": "59bb5fbbc6f9d5000801ae29",
      "subscriptionStatus": true
    },
    {
      "deviceId": "59bb5fbbc6f9d5000801ae30",
      "subscriptionStatus": true
    }
  ]
}

Response

A successful request returns an HTTP 200 status.

An unsuccessful request returns an HTTP 404 status if the topic does not exist.

See also

For full details of this API, see the DMM API documentation.