Home > Develop > IP Control > REST API > API List

getSupportedApiInfo (v1.0)

Estimated reading time: 2 minutes

: This API provides the supported services and their information. This API is used in the initialization sequence to dynamically fetch the service compatibility of the server.

Syntax

: http://<Base URL>/guide

Authentication Level

: none

Request

params' Elements: An object composed of the following pair(s).

name	type	multiplicity	default	description
services	string-array	?	null	Services to fetch API information. Null or empty arrays are treated as all services.

JSON Example

{
    "method": "getSupportedApiInfo",
    "id": 5,
    "params": [{"services": [
        "system",
        "avContent"
    ]}],
    "version": "1.0"
}

Response

result's Elements: An array of objects composed of the following pairs.

name			type	multiplicity	default	description
service			string	1		Name of this service.
protocols			string-array	1		Supported transports.
apis			(object-array)	1		Supported APIs.
	name		string	1		Name of this API.
	versions		(object-array)	1		Detail of supported versions of this API.
		version	string	1		Version of this API.
		protocols	string-array	?	null	Transport for this API, if there are any exception from that of belonging service.
		authLevel	string	?	"none"	Authentication level of this API.
notifications			(object-array)	?	null	Supported Notification APIs.
	name		string	1		Name of this API.
	versions		(object-array)	1		Detail of supported versions of this API.
		version	string	1		Version of this API.
		authLevel	string	?	"none"	Authentication level of this API.

JSON Example

{
    "result": [[
        {
            "apis": [{
                "versions": [{"version": "1.0"}],
                "name": "getSystemInformation"
            }],
            "service": "system",
            "protocols": ["xhrpost:jsonizer"]
        },
        {
            "apis": [
                {
                    "versions": [{
                        "version": "1.0",
                        "authLevel": "generic"
                    }],
                    "name": "setPlayContent"
                },
                {
                    "versions": [
                        {"version": "1.1"},
                        {"version": "1.0"}
                    ],
                    "name": "getCurrentExternalInputsStatus"
                }
            ],
            "service": "avContent",
            "protocols": ["xhrpost:jsonizer"]
        }
    ]],
    "id": 5
}

Error Code: No additional error codes are defined. Refer to error code for common errors.

Last modified: 26 Jul 2024