TANSS API 2.4.0

GET /api/v1/company/infos.{_format}

Gets the company infos

Documentation
Sandbox

Documentation

Gets the company infos

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v1/get/license/{licenseId}.{_format}

Gets the license for a given ID

Documentation
Sandbox

Documentation

Gets the license for a given ID

Requirements

Name	Requirement	Type	Description
licenseId	\d+	integer	id of the license
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v1/get/licensebundle.{_format}

Downloads the license bundle file for your company

Documentation
Sandbox

Documentation

Downloads the license bundle file for your company

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v1/get/licenses.{_format}

Gets all current licenses for this company

Documentation
Sandbox

Documentation

Gets all current licenses for this company

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v1/notification/get/{notificationId}.{_format}

gets a specific notifications with all infos

Documentation
Sandbox

Documentation

gets a specific notifications with all infos

Requirements

Name	Requirement	Type	Description
notificationId		int	ID of the notification to be fetched
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v1/notification/list/{tanssVersion}/{tanssBuild}/{subBuild}.{_format}

gets a list of available notifications and the modified timestamp of them

Documentation
Sandbox

Documentation

gets a list of available notifications and the modified timestamp of them

Requirements

Name	Requirement	Type	Description
tanssVersion		string	TANSS Version, i.e. 5.7
tanssBuild	\d+	integer	current TANSS Build
subBuild	\d+	integer	current TANSS Sub Build
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v1/push/send/{udid}/{type}/{badge}.{_format}

Sends a push message to an ios device

Documentation
Sandbox

Documentation

Sends a push message to an ios device

Requirements

Name	Requirement	Type	Description
udid		string	Unique ID of ios device
type	\d+	integer	type of notification used in app
badge	\d+	integer	badge number to display
message		string	message to be sent
_format	json\|xml\|html

Parameters

Parameter	Type	Required?	Description
customerVersion	boolean	false	if the notification is for the customer version, use 1 here
linkId	integer	false	define the link id for the notification (i.e. the id of the ticket)
devVersion	boolean	false	if the notification is for a development device

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v1/request/license/get/types.{_format}

Request all module types which can be requested for this company.

Documentation
Sandbox

Documentation

Request all module types which can be requested for this company. The types are defined in the "data" part of the response. The array contains arrays with the keys 'id', 'name'

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v1/request/license/{typeId}/{tanssUserId}.{_format}

Requests a demo license of a certain type

Documentation
Sandbox

Documentation

Requests a demo license of a certain type

Requirements

Name	Requirement	Type	Description
typeId	\d+	integer	id of the license type
tanssUserId	\d+	integer	id of TANSS user that requested the license
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v1/test/connection.{_format}

Tests the connection to the api

Documentation
Sandbox

Documentation

Tests the connection to the api

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v1/update/get/files/{tanssVersion}/{tanssBuild}/{toBuild}.{_format}

Gets the Patch Files for TANSS between "tanssBuild" and "toBuild" for version "tanssVersion"

Documentation
Sandbox

Documentation

Gets the Patch Files for TANSS between "tanssBuild" and "toBuild" for version "tanssVersion"

Requirements

Name	Requirement	Type	Description
tanssVersion		string	TANSS Version, i.e. 5.7
tanssBuild	\d+	integer	current TANSS Build
toBuild	\d+	integer	Update to TANSS Build
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v1/update/get/infos/{tanssVersion}/{tanssBuilds}.{_format}

Gets the Infos for TANSS Updates (Changelog). Builds are comma separated given as parameter "tanssBuilds", i.e. "6487,6586"

Documentation
Sandbox

Documentation

Gets the Infos for TANSS Updates (Changelog). Builds are comma separated given as parameter "tanssBuilds", i.e. "6487,6586"

Requirements

Name	Requirement	Type	Description
tanssVersion		string	TANSS Version, i.e. 5.7
tanssBuilds		string	comma seperated builds
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v1/update/get/queries/{tanssVersion}/{tanssBuild}/{toBuild}.{_format}

Gets the Queries for TANSS between "tanssBuild" and "toBuild" for version "tanssVersion"

Documentation
Sandbox

Documentation

Gets the Queries for TANSS between "tanssBuild" and "toBuild" for version "tanssVersion"

Requirements

Name	Requirement	Type	Description
tanssVersion		string	TANSS Version, i.e. 5.7
tanssBuild	\d+	integer	current TANSS Build
toBuild	\d+	integer	Update to TANSS Build
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v1/update/infos/{tanssVersion}/{tanssBuild}.{_format}

Checks if an update is available

Documentation
Sandbox

Documentation

Checks if an update is available

Requirements

Name	Requirement	Type	Description
tanssVersion		string	TANSS Version, i.e. 5.7
tanssBuild		string	current TANSS Build, i.e. 17.8
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v1/wiki/login.{_format}

Gets access information to the wiki

Documentation
Sandbox

Documentation

Gets access information to the wiki

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/api/hotfix/{hash}/get.{_format}

Gets an api hotfixes

Documentation
Sandbox

Documentation

Gets an api hotfixes

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
hash

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/api/hotfix/{version}/{hash}/list.{_format}

Gets the list of api hotfixes

Documentation
Sandbox

Documentation

Gets the list of api hotfixes

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
version
hash

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/get/license/max/version.{_format}

Gets the maximum version for this company

Documentation
Sandbox

Documentation

Gets the maximum version for this company

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/get/license/{licenseId}/{versionId}.{_format}

Gets the license for a given ID and version

Documentation
Sandbox

Documentation

Gets the license for a given ID and version

Requirements

Name	Requirement	Type	Description
licenseId	\d+	integer	id of the license
versionId	\d+	integer	id of the version
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/get/licensebundle/{versionId}.{_format}

Downloads the license bundle file for your company for a specific version

Documentation
Sandbox

Documentation

Downloads the license bundle file for your company for a specific version

Requirements

Name	Requirement	Type	Description
versionId	\d+
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/get/licenses/{versionId}.{_format}

Gets all the licenses of a specific version

Documentation
Sandbox

Documentation

Gets all the licenses of a specific version

Requirements

Name	Requirement	Type	Description
versionId	\d+	integer	id of the version
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/hotfix/{hash}/get.{_format}

Gets the hotfix file, based on its hash

Documentation
Sandbox

Documentation

Gets the hotfix file, based on its hash

Requirements

Name	Requirement	Type	Description
hash	[0-9a-zA-Z]{10}
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/hotfix/{hash}/info.{_format}

Gets infos about the hotfix, such as associated queries / Date etc.

Documentation
Sandbox

Documentation

Gets infos about the hotfix, such as associated queries / Date etc.

Requirements

Name	Requirement	Type	Description
hash	[0-9a-zA-Z]{10}
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/hotfix/{version}/{build}/list.{_format}

Gets a list of available hotfixes for the current version / build

Documentation
Sandbox

Documentation

Gets a list of available hotfixes for the current version / build

Requirements

Name	Requirement	Type	Description
version	[0-9\.]+
build	[0-9\.]+
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/license/ioncube/{version}/download.{_format}

Downloads the current ioncube license file for the company

Documentation
Sandbox

Documentation

Downloads the current ioncube license file for the company

Requirements

Name	Requirement	Type	Description
version	[0-9\.]+
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/license/order.{_format}

Orders a license

Documentation
Sandbox

Documentation

Orders a license

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/license/{version}/{build}/detailList.{_format}

Gets detailled infos to installed licenses / history / maintenance

Documentation
Sandbox

Documentation

Gets detailled infos to installed licenses / history / maintenance

Requirements

Name	Requirement	Type	Description
version	[0-9\.]+
build	[0-9\.]+
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/release/api/{version}/download.{_format}

Downloads the current api package of the given version

Documentation
Sandbox

Documentation

Downloads the current api package of the given version

Requirements

Name	Requirement	Type	Description
version	[0-9\.]+
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/release/api/{version}/{build}/download.{_format}

Downloads the current api package of the given version

Documentation
Sandbox

Documentation

Downloads the current api package of the given version

Requirements

Name	Requirement	Type	Description
version	[0-9\.]+
build	[0-9\.]+
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/release/install/{version}/download.{_format}

Downloads the current release install package of the given version

Documentation
Sandbox

Documentation

Downloads the current release install package of the given version

Requirements

Name	Requirement	Type	Description
version	[0-9\.]+
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/release/update/{version}/download.{_format}

Downloads the current release update package of the given version

Documentation
Sandbox

Documentation

Downloads the current release update package of the given version

Requirements

Name	Requirement	Type	Description
version	[0-9\.]+
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/updater/version.{_format}

Gets the current version of the tanss updater

Documentation
Sandbox

Documentation

Gets the current version of the tanss updater

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set