API : IPTV : MQTT broker : List

Introduction

This will list the MQTT broker configurations defined for IPTV / FlexCare.

Each configuration identifies an MQTT broker (host, port and protocol) together with an optional topic prefix, and belongs to a reseller. This endpoint returns a reduced view of each configuration, showing its id, name, the name of the owning reseller and the topic prefix.

Only configurations whose reseller resolves to an existing customer are returned; the result is not sorted.

Request

URL	https://api.telecomx.dk/iptv/brokerconfig
Method	GET
Access level	RESELLER admin (with the TV employee feature) ADMIN
Query	offset	`[optional]` Index of the first configuration to return, default 0, min 0, max 1000000.
	limit	`[optional]` The number of configurations to return, default 100, min 1, max 500.
	filter	`[optional]` Filters the configurations on name.
	reseller	`[optional]` ObjectId of a reseller. When given, only configurations owned by that reseller are returned.

Invalid query parameters are not rejected: out-of-range numbers are clamped, non-numeric offset/limit fall back to their defaults, and an invalid reseller id is ignored.

Query examples

https://api.telecomx.dk/iptv/brokerconfig
https://api.telecomx.dk/iptv/brokerconfig?offset=25&limit=50&filter=home
https://api.telecomx.dk/iptv/brokerconfig?reseller=1234567890ABCD1234567890

Response

JSON object
offset	Index of the first configuration returned.
limit	Number of configurations requested. Note that the actual number of configurations returned may be lower.
total	Number of configurations that match the query when offset and limit are not considered. This is to be used for paging through the data.
configs	Array of configurations, see definition below.

Configuration
_id	ObjectId	Unique id of the broker configuration
name	String	Name of the broker configuration
resellerName	String	Name of the reseller (customer) that owns the configuration
topicPrefix	String	Prefix applied to MQTT topics (may be an empty string)

Example

{
   offset: 0,
   limit: 100,
   total: 1,
   configs: [
     {
       _id: "1234567890ABCD1234567890",
       name: "Main broker",
       resellerName: "Acme Reseller A/S",
       topicPrefix: "acme/"
     }
   ]
}

Errors

Error code	Message	Description
403	access_denied	Insufficient access level — minimum RESELLER admin required, or the RESELLER admin does not have the TV employee feature.
500	internal_error	<Unspecified>

WIKI

Table of Contents