Function prototype	interoperability_key_list (session)
API Version	2.7.29 and higher
Supported interfaces	SOAP, REST

Description

Returns the list of all the interoperability keys defined

Required permissions: The active user must be a super-administrator

Input parameters:

Output parameters:

result: array of interoperability keys.
- total: total number of interoperability keys
- keys: The information provided for each key is:
  - name: String with the name assigned to the key.
  - code: internal code that will be assigned to the key.
  - app_id: Id of the interoperability key.
  - private_key: private key of the interoperability key. This value should be kept secret and never be disclosed by the external system using this key.
  - comments: free text up to 512 characters.
  - language: a 2 letter ISO code of the language to be used as the default language when an external system interacts with the Linkcare platform
  - creation_date: date of creation (in the session local timezone) of the key.
  - modification_date: date of the last modification (in the session local timezone) of the key.
ErrorMsg: If any error occurs, then this value contains a description of the error translated to the current language
ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request example

interoperability_key_listCAAAAAAAAAAAA”)

The response format is XML when the function has been invoked via the SOAP API, and JSON when it has been invoked via the REST API

ERROR CODE

ERROR CODE
INVALID_TOKEN	The session token provided is not valid
INSUFFICIENT_PRIVILEGES	The session user does not have the necessary privileges to execute this function