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

getInterfaceInformation (v1.0)

Estimated reading time: 2 minutes

This API provides information of the REST API interface provided by the server. This API must not include private information.

Syntax

http://<Base URL>/system

Authentication Level

none

Request

params' Elements
Not necessary.
JSON Example
{
    "method": "getInterfaceInformation",
    "id": 33,
    "params": [],
    "version": "1.0"
}

Response

result's Elements
An object composed of the following pair(s).
name type multiplicity default description
productCategory string 1 Category name of the device.
productName string 1 More detailed product information can be returned if productCategory is not enough.
modelName string 1 Model name.
serverName string 1 Server name. If the device can launch multiple REST API servers, return this server's name for the client to distinguish.
interfaceVersion string 1 Version for the client to change its behavior with regards to significant differences within productCategory. This version is managed/controlled within each productCategory. The composition of this parameter is "[X].[Y].[Z]", where [X], [Y], and [Z] are strings each representing an integer and concatenated with periods "." in between.
  • [X]: This value is assigned and incremented so that the client can distinguish any significant differences between devices or groups of devices within productCategory. How this value is assigned depends on each productCategory.
  • [Y]: This value represents the versions of API sets supported within [X]. This version must be incremented if supported APIs are added or deleted.
  • [Z]: This value must be incremented if any behavior of existing APIs is changed within [X.Y].
JSON Example
{
    "result": [{
        "modelName": "FW-55BZ35F",
        "serverName": "",
        "interfaceVersion": "5.0.1",
        "productName": "BRAVIA",
        "productCategory": "tv"
    }],
    "id": 33
}
Error Code
No additional error codes are defined. Refer to error code for common errors.

Appendix

Guide about Response

  • BRAVIA Professional Display returns fixed values for the following parameters.
name value
productCategory “tv”
productName “BRAVIA”
serverName ””
  • “interfaceVersion” is stored as below. This value should match with the version of the interface.
Software value
PKG6.5603.0175 “5.0.1”
Last modified: 26 Jul 2024