ホーム > 開発 > IP コントロール > REST API > APIリスト

getSystemInformation (v1.0)

Estimated reading time: 2 minutes

: This API provides general information on the device.

Syntax

: http://<Base URL>/system

Authentication Level

: private

Request

params' Elements: Not necessary.

JSON Example

{
    "method": "getSystemInformation",
    "id": 33,
    "params": [],
    "version": "1.0"
}

Response

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

name	type	multiplicity	default	description
product	string	1		Device category. The following values are currently defined.
language	string	?	""	Language code of the device, represented by ISO-639 alpha-3. The default value is "", and if the server device cannot send this parameter, an empty string is returned.
model	string	1		Name of the product. This must be unique within each product. The actual value is defined by each product and is outside the scope of this document.
serial	string	?	""	Serial ID assigned to each device. The default value is "", and if the server device cannot send this parameter, an empty string is returned.The actual value is defined by each product and outside the scope of this document.
macAddr	string	?	""	Ethernet MAC address. Default value is "" and in case server device can not send this parameter, empty string is returned.
name	string	1		Product name. This must be unique within each category.
generation	string	?	""	Represents the rough age and season of the device in the market. The parameter is composed of "[X].[Y].[Z]", where [X], [Y], and [Z] are strings each representing an integer, concatenated with periods "." in between. This must be unique within each category. The default value is, "" and if the server device cannot send this parameter, an empty string is returned.

JSON Example

{
    "result": [{
        "generation": "5.0.1",
        "product": "TV",
        "serial": "1000001",
        "name": "BRAVIA",
        "language": "eng",
        "model": "FW-55BZ35F",
        "macAddr": "04:5D:4B:AD:6D:E1"
    }],
    "id": 33
}

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

Appendix

Guide about Response

The BRAVIA Professional Display returns fixed values for the following parameters.

name	value
product	“TV”
name	“BRAVIA”

The BRAVIA Professional Display also extends ISO-639 alpha-3 on “language”.
“macAddr” stores valid MAC addresses of active NICs. The format must be “xx:xx:xx:xx:xx:xx”. In the BRAVIA Professional Display, only one NIC is active.
“generation” stores same values as interfaceVersion in getInterfaceInformation.

Last modified: 26 Jul 2024