Help Center> ROMA Connect> Developer Guide> Developer Guide for Device Integration> MQTT Topic Specifications> Response for Querying Gateway Information
View PDF

Response for Querying Gateway Information

Topic

Topic

/v1/devices/{gatewayId}/queryResponse

Publisher

IoT platform

Subscriber

Edge device

Parameter Description

Field

Mandatory/Optional

Type

Description

mid

Mandatory

Integer

Command ID.

statusCode

Mandatory

Integer

Result code for request processing. The options are as follows:

  • 0: success
  • non-0: failure

statusDesc

Optional

String

Response status description.

data

Optional

List<DeviceInfo>

Device information.

count

Optional

String

Device quantity.

marker

Optional

String

Tag.
Table 1 DeviceInfo structure

Field

Mandatory/Optional

Type

Description

deviceId

Mandatory

String

Unique device ID generated by the IoT platform, which corresponds to the device client ID.

nodeId

Mandatory

String

Device identifier.

The value must contain 2 to 64 characters and can consist of only uppercase and lowercase letters, digits, and hyphens (-).

name

Mandatory

String

Device name.

The value must contain 2 to 64 characters and can consist of only uppercase and lowercase letters, digits, hyphens (-), and number signs (#).

description

Optional

String

Device description.

The value length cannot exceed 200 characters.

manufactureId

Mandatory

String

Manufacturer ID.

The value must contain 2 to 50 characters and can consist of only uppercase and lowercase letters, digits, hyphens (-), and underscores (_).

model

Mandatory

String

Product model.

The value must contain 2 to 50 characters and can consist of only uppercase and lowercase letters, digits, hyphens (-), and underscores (_).

Example

{
	"mid": 2,
	"statusCode": 0,
	"statusDesc": "",
        "marker": "",
        "count": "1",
	"data": [
		{
			"deviceId": "D59eGSxy",
			"nodeId": "test123",
			"name": "n-device",
			"description": "addsSubDevice",
			"manufacturerId": "Test_n",
			"model": "A_n"
		}
	]
}