getSupportedApiInfo (v1.0)
Estimated reading time: 1 minute
- 这个API提供受支持的服务及其信息。此API用于 动态获取服务器服务兼容性的初始化序列。
语法
- http://<Base URL>/guide
认证级别
- none
需求
- params' Elements
- 由下列对组成的对象。
name | type | multiplicity | default | description |
---|---|---|---|---|
services | string-array | ? | null | 获取API信息的服务。Null或空数组被视为所有服务。 |
- JSON Example
-
{ "method": "getSupportedApiInfo", "id": 5, "params": [{"services": [ "system", "avContent" ]}], "version": "1.0" }
反馈
- result's Elements
- 由以下对组成的对象数组。
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 | 此API支持的版本的详细信息。 | |||
version | string | 1 | Version of this API. | |||
protocols | string-array | ? | null | 如果属于服务的API有任何异常,则传输此API。 | ||
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 常见的错误。
Last modified: 13 Feb 2019