api:iptv:package:get
Table of Contents
API : IPTV : Package : Get
Introduction
This request will return the settings for the specified package.
A package is a collection of TV channels that a customer can subscribe to. It can contains as little as a single channel or as much as 1000 channels. The package also specifies how each channel should be received - base channel stream, DVB or via a locally available stream.
Request
| URL | https://api.telecomx.dk/iptv/package/PACKAGE_ID | |
|---|---|---|
| Method | GET | |
| Access level | VIEWER, MANAGER or OWNER if customer has feature IPTVBUSINESS RESELLER if customer has IPTVPRIVATE ADMIN |
|
| Param | PACKAGE_ID | Id of the package. |
Query example
https://api.telecomx.dk/iptv/package/12345678901234567890ABCD
Response
| JSON object | ||
|---|---|---|
| _id | Id | Unique id of the package. |
| name | String | Name of package. |
| main | Boolean | True if this package is a main package. A subscription can only contain 1 main package, and if a channel is in both a main package and an add-on package, the settings from the main package will be applied. |
| channels | Array | List of channels (see IpTvChannels) that are part of the package. |
| channels[].id | Id | Id of the channel. |
| channels[].type | String | Type of channel: BASE, DVB or LOCAL. |
Note that properties holding no value may be omitted from the object.
Example
{ _id: '12345678901234567890ABCD', name 'Local channels', main: true, channels: [ { type: 'BASE', id: '12345678901234567890BBBB' }, { type: 'DVB', id: '12345678901234567890CCCC' } ] }
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | id | Not found |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/iptv/package/get.txt · Last modified: 2017/01/19 15:50 by Per Møller