API : IPTV : Subscription : Get

Introduction

This request will return the subscription settings for a customer with feature IPTVPRIVATE.

Request

URL	https://api.telecomx.dk/iptv/subscription
URL	https://api.telecomx.dk/iptv/subscription/CUSTOMER_ID
Method	GET
Access level	VIEWER, MANAGER or OWNER if customer has feature IPTVPRIVATE RESELLER if customer has IPTVPRIVATE ADMIN
Param	CUSTOMER_ID	Id of the customer the settings belongs to. Defaults to the users own customer if not specified.

Query examples

https://api.telecomx.dk/iptv/subscription
https://api.telecomx.dk/iptv/subscription/12345678901234567890ABCD

Response

JSON object
nPvr.override	Boolean	True to override resellers common nPvr settings.
nPvr.enabled	Boolean	Is nPVR enabled. Overrides resellers common setting, unless reseller does not offer nPVR.
nPvr.storage	Number	Number of hours the customer may store. Overrides resellers common settings.
nPvr.autoExpireDays	Number	Number of days before recordings are automatically deleted. Overrides resellers common settings.
resellerNPvr	Object	The resellers common nPVR settings - which can be overridden on the customer.
resellerNPvr.enabled	Boolean	True if nPVR is enabled.
resellerNPvr.storage	Number	Number of hours customer(s) may record.
resellerNPvr.autoExpireDays	Number	Number of days before recordings are automatically deleted.
resellerNPvr.autoExpireOverride	Boolean	True if customer(s) can reset the age of a recording to keep it past the autoExpireDays period.
scrub	Object	Scrubbing overrides
scrub.override	Boolean	True to override channels scrubbing settings.
scrub.forward	Boolean	True forward scrubbing is allowed.
scrub.backward	Boolean	True backward scrubbing is allowed.
scrub.pause	Boolean	True pausing is allowed.
packages	Array	List of packages the customer subscribes to.
packages[]._id	Id	Id of the package.
packages[].start	Date	Date and time the package starts, defaults to now.
packages[].end	Date	Date and time the package expires and is removed. Null if no end.

Note that properties holding no value may be omitted from the object.

Example

{
  nPvr: {
    override: true,
    enabled: true,
    storage: 25,
    autoExpireDays: 180
  },
  scrub: {
    override: true,
    forward: true,
    backward: true,
    pause: true
  },
  resellerNPvr: {
    enabled: true,
    storage: 10,
    autoExpireDays: 30,
    autoExpireOverride: true
  },
  packages: [
    {
      _id: '1234567890123457890CCCC',
      start: '2016-01-01T00:00:00.000Z',
      end: '2016-01-01T00:00:00.000Z'
    },
    {
      _id: '12345678901234567890DDDD',
      start: '2016-01-01T00:00:00.000Z',
    }
  ]
}

Errors

Error code	Message	Description
404	customer	Customer not found
404	customer	Customer does not have IPTV
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents

API : IPTV : Subscription : Get

Introduction

Request

Query examples

Response

Example

Errors