Updated on 2022-02-24 GMT+08:00

Querying Information About a Device

Typical Scenario

If an NA needs to view detailed information (such as the manufacturer, model, version, status, and service attributes) of a device that has been registered on the IoT platform, the NA can call this API to obtain the information.

API Function

This API is used by an NA to query detailed information of a specified device based on the device ID on the IoT platform, such as configuration, status and service attributes.

API Prototype

Method

GET

URL

https://server:port/iocm/app/dm/v1.4.0/devices/{deviceId}?appId={appId}&select={select}

Transport Protocol

HTTPS

Request Parameters

Parameter

Mandatory or Optional

Type

Location

Description

app_key

Mandatory

String

header

Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform.

Authorization

Mandatory

String

header

Indicates the authentication information for accessing the IoT platform. The value is Bearer {accessToken}, in which {accessToken} indicates the access token returned by the Authentication API.

deviceId

Mandatory

String

path

Uniquely identifies a device. The value of this parameter is allocated by the IoT platform during device registration.

appId

Optional

String

query

Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform. Set this parameter to the value of appId of the authorized application.

select

Optional

String

query

Indicates the query condition. The value can be IMSI.

Response Parameters

Status Code: 200 OK

Parameter

Type

Description

deviceId

String(256)

Uniquely identifies a device. The value of this parameter is allocated by the IoT platform during device registration.

gatewayId

String(256)

Identifies a gateway. The gateway ID is the same as the device ID if the device is a directly connected device. If the device is an indirectly connected device, the gateway ID is the device ID of the directly connected device (that is, the gateway) with which it associates.

nodeType

Enum

Indicates the node type. The value options are ENDPOINT, GATEWAY, and UNKNOW.

createTime

String(256)

Indicates the time when the device is created. The value is in the format of yyyyMMdd'T'HHmmss'Z'. An example value is 20151212T121212Z.

lastModifiedTime

String(256)

Indicates the last time when the device is modified.

deviceInfo

DeviceInfoQueryDTO

Indicates the device data.

services

List<DeviceService>

Indicates the service list.

alarmInfo

AlarmInfoDTO

Indicates the device alarm details.

DeviceInfoQueryDTO structure

Parameter

Type

Description

nodeId

String(256)

Uniquely identifies a device.

name

String(256)

Indicates the device name.

description

String(2048)

Indicates the device description.

manufacturerId

String(256)

Uniquely identifies a manufacturer.

manufacturerName

String(256)

Indicates the manufacturer name.

mac

String(256)

Indicates the MAC address of the device.

location

String(2048)

Indicates the device location.

deviceType

String(256)

Indicates the device type. The upper camel case is used, for example, MultiSensor, ContactSensor, and CameraGateway.

model

String(256)

Indicates the device model.

swVersion

String(256)

Indicates the software version of the device.

fwVersion

String(256)

Indicates the firmware version of the device.

hwVersion

String(256)

Indicates the hardware version of the device.

imsi

String

Indicates the IMSI of an NB-IoT device.

protocolType

String(256)

Indicates the protocol used by the device.

radiusIp

String

Indicates the RADIUS address.

bridgeId

String(256)

Identifies the bridge through which the device accesses the IoT platform.

status

String

Indicates whether the device is online. The value options are ONLINE, OFFLINE, INACTIVE, and ABNORMAL.

  • Before the device is connected to the IoT platform for the first time, the device is in the INACTIVE state.
  • If the device does not report data or send messages to the IoT platform within 25 hours (default value), the device status is ABNORMAL (default value). If the device does not report data or send messages to the IoT platform within 49 hours, the device is in the OFFLINE state.

statusDetail

String(256)

Indicates the device status details, which vary according to the value of status.

  • When status is ONLINE, the value can be NONE, CONFIGURATION_PENDING, UE_REACHABILITY, or AVAILABILITY_AFTER_DDN_FAILURE.
  • When status is OFFLINE, the value can be NONE, COMMUNICATION_ERROR, CONFIGURATION_ERROR, BRIDGE_OFFLINE, FIRMWARE_UPDATING, DUTY_CYCLE, NOT_ACTIVE, LOSS_OF_CONNECTIVITY, or TIME_OUT.
  • When status is INACTIVE, the value can be NONE or NOT_ACTIVE.

mute

String

Indicates whether the device is in the frozen state. Based on the value of this parameter, the IoT platform determines whether to manage and store data reported by the device.

  • TRUE: The device is in the frozen state.
  • FALSE: The device is not in the frozen state.

supportedSecurity

String

Indicates whether the security mode is supported.

  • TRUE: The security mode is supported.
  • FALSE: The security mode is not supported.

isSecurity

String

Indicates whether the security mode is enabled.

  • TRUE: The security mode is enabled.
  • FALSE: The security mode is disabled.

signalStrength

String(256)

Indicates the signal strength of the device.

sigVersion

String(256)

Indicates the SIG version of the device.

serialNumber

String(256)

Indicates the serial number of the device.

batteryLevel

String(256)

Indicates the battery level of the device.

NOTE:

When the device status information is reported over the southbound API, status and statusDetail must be included at the same time. In addition, it is recommended that statusDetail not be used for logical determination.

DeviceService structure

Parameter

Type

Description

serviceId

String(256)

Identifies a service.

serviceType

String(256)

Indicates the service type.

serviceInfo

ServiceInfo

Indicates the service information.

data

ObjectNode(2097152)

Indicates an attribute-value pair (AVP).

eventTime

String(256)

The value is in the format of yyyyMMdd'T'HHmmss'Z'. An example value is 20151212T121212Z.

ServiceInfo structure

Parameter

Type

Description

muteCmds

List<String>

Indicates the list of shielded device commands.

AlarmInfoDTO structure

Parameter

Type

Description

alarmSeverity

String

Indicates the alarm severity.

alarmStatus

Boolean

Indicates the alarm status.

alarmTime

String

Indicates the time when the alarm is reported.

Request Example

Method: GET
Request:
https://server:port/iocm/app/dm/v1.4.0/devices/{deviceId}?select=imsi
Header:
app_key: ******
Authorization: Bearer *****
Content-Type: application/json

Response Example

Response:
Status Code: 200 OK
Content-Type: application/json
Body:
{
  "deviceId": "xxxxx",
  "gatewayId": "xxxxx",
  "nodeType": "xxxxx",
  "deviceInfo": {
    "nodeId": "123456",
    "name": "Sensor_12",
    "manufacturerName": "wulian",
    "deviceType": "gateway",
    "model": "90",
    "mac": "C7EA1904004B1204",
    "swVersion": "th",
    "fwVersion": "seu",
    "hwVersion": "sru",
    "protocolType": "zigbee",
    "description": "smockdetector",
    "imsi": "xxxxx"
  },
  "services": [
    {
      "serviceType": "air_conditioner",
      "serviceId": "1",
      "data"{
        "battery_low": 1
      }
    },
    {
      "serviceType": "air_conditioner",
      "serviceId": "jkh",
      "data": {
        "battery_low": "jhj"
      }
    }
  ]
}

Error Codes

HTTP Status Code

Error Codes

Error Description

Remarks

400

100405

The request parameter is invalid.

The request message contains invalid parameters.

Recommended handling: Check whether parameters in the API request are correct by referring to the request parameter description.

403

100203

The application is not existed.

The application does not exist.

Recommended handling:

  • Check whether appId carried in the HTTP request header is correct.
  • Check whether appId in the request path (URL) is correct.

403

100217

The application hasn't been authorized.

The application has not been authorized.

Recommended handling: In scenarios where applications are not authorized, ensure that request parameter appId is null.

403

1010009

app throttle exceed.

The NA calls the API at a frequency that exceeds the flow control threshold (100 calls per minute by default).

Recommended handling: Contact IoT platform maintenance personnel to adjust the flow control threshold or control the API call frequency.

403

1010005

App_key or access_token is invalid.

The access token is invalid.

Recommended handling: Check whether accessToken carried in the API request is correct.

404

100403

The device is not existed.

The device does not exist.

Recommended handling: Check whether deviceId is correct.

404

100418

The deviceData is not existed.

The device data does not exist.

Recommended handling:

  • If deviceId carried in the request is incorrect, check whether deviceId belongs to appId or whether deviceId is incorrect.
  • Check whether appId carried in the header contains deviceId.
  • If the URL contains the optional parameter appId, check whether the value of appId is correct.

500

100203

The application is not existed.

The application does not exist.

Recommended handling:

  • Check whether appId carried in the HTTP request header is correct.
  • Check whether appId in the request path (URL) is correct.

500

50252

Internal server error.

An internal server error occurs.

Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel.