API : IPTV : App whitelist : Update

Introduction

This will update a 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	POST
Access level	ADMIN
Param	APP_ID	Unique package name of 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[].file	ObjectId	ID of the Android package
	apks[].version	String	App version
	apks[].default	String	True if this is chosen as the default version of the app.
	apks[].releaseDate	Date?	Date of when version was released
	apks[].bundle	Array	Array of files from apk bundle
	apks[].bundle[].file	ObjectId	Unique id of the bundle file
	apks[].bundle[].url	String	Url where file is located
	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.

Query examples

https://api.telecomx.dk/iptv/appwhitelist/com.fitnesscompany.runningapp

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[].version	String	App version
apks[].default	String	True if this is chosen as the default version of the app.
apks[].releaseDate	Date?	Date of when version was released
apks[].bundle	Array	Array of files from apk bundle
apks[].bundle[].file	ObjectId	Unique id of the bundle file
apks[].bundle[].url	String	Url where file is located
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.

Example

{
  _id: "com.fitnessapps.marafun",
  name: "MaraFUN",
  icon: '1234567890ABCD1234567890',
  iconUrl: "https://fitnessapps.com/img/marafun200x200.png",
  androidTV: false,
  apks: [
         {
           _id: '1234567890ABCD1234657890',
           url: 'https://doc.telecomx.dk/4434567890ABCD1234567890',
           file: '4434567890ABCD1234567980',
           version: '1.0',
           default: true,
           bundle: [
               {
                   file: '1234567890ABCD1234657890',
                   url: 'https://doc.telecomx.dk/4434567890ABCD1234567890'
               },
               {
                   file: '1234567890ABCD1234657890',
                   url: 'https://doc.telecomx.dk/4434567890ABCD1234567890'
               }
           ]
         },
         {
           _id: '1234567890ABCD1234657890',
           url: 'https://doc.telecomx.dk/4434567890ABCD1234567890',
           file: '4434567890ABCD1234567980',
           version: '1.0',
           default: false
         }
  ],
  customerWhitelist: []
}

Errors

Error code	Message	Description
403	access_denied	Insufficient access level
403	id	An app already exists with this id
404	id	App not found
500	internal_error	<Unspecified>

WIKI

Table of Contents

API : IPTV : App whitelist : Update

Introduction

Request

Query examples

Response

Example

Errors