API : IPTV : App whitelist : Get

Introduction

This will get a single whitelisted app

This whitelist is used to determine which apps can be assigned to a tablet profile.

Request

URL	https://api.telecomx.dk/iptv/appwhitelist/APP_ID
Method	GET
Access level	VIEWER, MANAGER, OWNER, RESELLER if customer has feature IPTVBUSINESS ADMIN
Param	APP_ID	Unique package name of the app
Query	full	String	If true, then customerWhitelist is returned as an array of customer objects instead of an array of IDs

Query examples

https://api.telecomx.dk/iptv/appwhitelist/com.example.myapp
https://api.telecomx.dk/iptv/appwhitelist/com.example.myapp?full=true

Response

JSON object
_id	String	Unique Android package name for the app
name	String	App name
icon	ObjectId	Id of the image
iconUrl	String	Default icon url, used for having a default icon for tablet profile
private	Boolean	Should be set if app is not in an app store
whitelistOnly	Boolean	True if app should not be installed nor validated for correct version
autoUpdateDefault	Boolean	Used to tell the automatic version fetcher that it should move default flag to newest version when one is found
androidTV	Boolean	Used to tell the automatic version fetcher that it should find the android TV version of the application
apks	Array	List of APKs for different versions of this app
apks[].url	String	URL to download Android package.
apks[]._id	ObjectId	Unique object ID
apks[].version	String	App version
apks[].default	String	True if this is chosen as the default version of the app.
apks[].file	ObjectId	File ID
apks[].fileName	String	File name
apks[].releaseDate	Date?	Date of addition of the version
customerWhitelist	Array	Array of customer IDs (ObjectIDs). If the list is empty, then the app is allowed to be added to all tablet profiles. If it's not empty, then the customers added to this list are the only ones allowed to use this app. Note that if a reseller is added to this list, then all of their customers are also allowed to access this app.

If full=true
customerWhitelist	Array	Array of customer objects
customerWhitelist[]._id	ObjectId	Id
customerWhitelist[].name	String	Customer name
customerWhitelist[].phoneNumber	String	Phone number
customerWhitelist[].emailAddress	String	Customer's email address.
customerWhitelist[].parentReseller	ObjectId	Id of the customer's parent reseller. If the customer is a reseller, then this is null or omitted.

Example

{
  _id: "com.fitnessapps.marafun",
  name: "MaraFUN",
  id: "1234567890ABCD1234567890",
  iconUrl: "https://fitnessapps.com/img/marafun200x200.png",
  androidTV: false,
  apks: [
         {
           _id: '1234567890ABCD1234657980',
           url: 'https://doc.telecomx.dk/1234567890ABCD1234567890'
           version: '1.0',
           default: true,
           file: '1224657890ABCD1234567980',
           fileName: 'Marathon V. 1.0'
         }
       ],
  customerWhitelist: [
    '1234567890ABCD1234567890',
    '7234567890ABCD1234567890
  ]
}

Example if full=true

{
  _id: "com.fitnessapps.marafun",
  name: "MaraFUN",
  iconUrl: "https://fitnessapps.com/img/marafun200x200.png",
  androidTV: false,
  apks: [
         {
           url: 'https://doc.telecomx.dk/1234567890ABCD1234567890'
           version: '1.0',
           default: true,
           file: '1224657890ABCD1234567980',
           fileName: 'Marathon V. 1.0'
         }
       ],
  customerWhitelist: [
    {
      _id: '1234567890ABCD1234567890',
      name: 'Hans Hansens Hestevæddeløbsbane ApS',
      phoneNumber: '+4560828313',
      parentReseller: '1234567890ABCD1234567890' 
    },
    {
      _id: '1234567890ABCD1234567890',
      name: 'Erik Erlangs Elektrikerfirma A/S',
      phoneNumber: '+4577828313',
      parentReseller: '1234567890ABCD1234567890' 
    },
  ]
}

Errors

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

WIKI

Table of Contents

API : IPTV : App whitelist : Get

Introduction

Request

Query examples

Response

Example

Example if full=true

Errors