API : FlexCare : App whitelist : Create

API : FlexCare : App whitelist : Create

Introduction

This will whitelist an app.

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

A new app is created without any releases. Releases (APK versions) are added afterwards with the Create release endpoint.

Request

URL	https://api.telecomx.dk/flexcare/appwhitelist
Method	POST
Access level	ADMIN, or RESELLER admin with the TV employee feature
body	packageName	String	`[required]` Android package name for the app
	name	String	`[required]` App name
	description	String	`[optional]` App description. Default empty.
	icon	ObjectId	`[optional]` Id of the icon image. Default null.
	iconUrl	String	`[optional]` Default icon url, used for having a default icon for tablet profile. May be null.
	private	Boolean	`[optional]` Should be set if app is not in an app store. Default false.
	whitelistOnly	Boolean	`[optional]` True if app should not be installed nor validated for correct version. Default false.
	autoUpdateDefault	Boolean	`[optional]` Used to tell the automatic version fetcher that it should move the default flag to the newest version when one is found. Default false.
	androidTV	Boolean	`[optional]` Used to tell the automatic version fetcher that it should find the Android TV version of the application. Default false.
	minimumVersion	Number	`[optional]` Minimum build version wanted. Default 0.
	customerWhitelist	Array	`[optional]` 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. Default empty.

apks is not accepted on create. If sent, it is ignored and the app is created with an empty release list. Use the Create release endpoint to add releases.

Query examples

https://api.telecomx.dk/flexcare/appwhitelist

Body example

{
  packageName: "com.fitnessapps.marafun",
  name: "MaraFUN",
  icon: "1234567890ABCD1234567890",
  iconUrl: "https://fitnessapps.com/img/marafun200x200.png",
  private: false,
  whitelistOnly: false,
  autoUpdateDefault: true,
  androidTV: false,
  minimumVersion: 0,
  customerWhitelist: []
}

Response

The created app is returned in full, with the server-assigned _id. apks is always an empty array.

JSON object
_id	ObjectId	Unique id of the app (generated by the server)
packageName	String	Android package name
name	String	App name
description	String	App description
icon	ObjectId	Id of the icon image (null if none)
iconUrl	String	Icon URL (present only if supplied on create; it is not derived from `icon`). May be null.
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 the default flag to the 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
minimumVersion	Number	Minimum build version wanted
apks	Array	List of APKs for different versions of this app. Always empty on create; releases are added with the Create release endpoint.
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: "ABCDEF1234567890ABCDEF12",
  packageName: "com.fitnessapps.marafun",
  name: "MaraFUN",
  description: "",
  icon: "1234567890ABCD1234567890",
  iconUrl: "https://fitnessapps.com/img/marafun200x200.png",
  private: false,
  whitelistOnly: false,
  autoUpdateDefault: true,
  androidTV: false,
  minimumVersion: 0,
  apks: [],
  customerWhitelist: []
}

Errors

Error code	Message	Description
422	<field>	Invalid or missing body field (e.g. `packageName`, `name`, `icon`, `customerWhitelist`).
403	access_denied	Insufficient access level, or the reseller admin lacks the TV employee feature.
500	internal_error	<Unspecified>

Table of Contents