Appearance
Query Device Business Attributes
API Address:/v2/binding/enduserapi/getDeviceBusinessAttributes
Request Method:GET
Request Data Type:application/x-www-form-urlencoded
Response Data Type:*/*
API Description:Query the values of the device's thing model
Request Parameters:
Parameter Name | Parameter Description | Request Type | Required | Data Type | Schema |
---|---|---|---|---|---|
dk | Device Key | query | true | string | |
pk | Product Key | query | true | string | |
codeList | Property identifiers to query Used in conjunction with query type, if querying multiple properties, separate with commas | query | false | string | |
gatewayDk | Gateway device's Device Key | query | false | string | |
gatewayPk | Gateway device's Product Key | query | false | string | |
type | Query type 1 Query device basic properties 2 Query thing model properties 3 Query location information Query type can be single or multiple, if you need to query multiple types of property values, separate with commas | query | false | string |
Response Status:
Status Code | Description | Schema |
---|---|---|
200 | Successfully queried device business attributes | Registration code response data«InnerApiDeviceDetailV2» |
5032 | Token verification failed | |
5041 | No permission | |
5047 | User authentication mismatch | |
5052 | Device not bound | |
5106 | Please enter token | |
5114 | DMP business attribute query failed | |
5471 | Please enter query type for property identifiers |
Response Parameters:
Parameter Name | Parameter Description | Type | Schema |
---|---|---|---|
code | Response status code | integer(int32) | integer(int32) |
data | Response data | InnerApiDeviceDetailV2 | InnerApiDeviceDetailV2 |
customizeTslInfo | Custom thing model data reporting list | array | Custom Thing Model Data |
abId | Function ID | integer | |
dataType | Data type | string | |
name | Function name | string | |
resourceCode | Function identifier | string | |
resourceValce | Function value | string | |
subType | Data operation type | string | |
type | Function type | string | |
deviceData | Resource thing model data list (battery, voltage, etc. Data available only when reported by device) | Device Resource Data | Device Resource Data |
battery | Battery level | number | |
cellId | Base station ID | integer | |
comProtocolVer | Communication protocol version | string | |
dataProtocolVer | Data protocol version | string | |
deviceKey | Device Key | string | |
iccid | ICCID number | string | |
lac | Location area code | integer | |
locator | Location support function | string | |
mcc | Mobile country code | integer | |
mcuVersion | MCU version | string | |
memoryFree | Remaining space | integer | |
mnc | Mobile network code | integer | |
phoneNum | Phone number | string | |
productKey | Product Key | string | |
rsrp | Reference Signal Received Power | integer | |
rsrq | LTE Reference Signal Received Quality | integer | |
sdkVersion | SDK version | string | |
signalStrength | Signal strength | integer | |
sim | SIM number | string | |
snr | Signal to Interference plus Noise Ratio | integer | |
type | Module model | string | |
version | Module version | string | |
voltage | Voltage | number | |
deviceLocateInfo | Device location information data | QdLocationLatest | QdLocationLatest |
createTime | Creation time | string | |
createTimeTs | integer | ||
deviceKey | Device key | string | |
hdop | Horizontal Dilution of Precision | string | |
lat | Latitude | string | |
latType | Latitude hemisphere N/S | string | |
lng | Longitude | string | |
lngType | Longitude hemisphere W/E | string | |
locateRaw | Raw data | string | |
locateStatus | Differential positioning/Non-differential positioning | string | |
locateTime | Positioning time | string | |
locateTimeTs | integer | ||
locateType | Positioning type | string | |
productKey | Product key | string | |
satellites | Current number of satellites | string | |
extMsg | Extended message | string | |
msg | Response message | string |
Response Example:
javascript
{
"code": 0,
"data": {
"customizeTslInfo": [
{
"abId": 0,
"dataType": "",
"name": "",
"resourceCode": "",
"resourceValce": "",
"subType": "",
"type": ""
}
],
"deviceData": {
"battery": 0,
"cellId": 0,
"comProtocolVer": "",
"dataProtocolVer": "",
"deviceKey": "",
"iccid": "",
"lac": 0,
"locator": "",
"mcc": 0,
"mcuVersion": "",
"memoryFree": 0,
"mnc": 0,
"phoneNum": "",
"productKey": "",
"rsrp": 0,
"rsrq": 0,
"sdkVersion": "",
"signalStrength": 0,
"sim": "",
"snr": 0,
"type": "",
"version": "",
"voltage": 0
},
"deviceLocateInfo": {
"createTime": "",
"createTimeTs": 0,
"deviceKey": "",
"hdop": "",
"lat": "",
"latType": "",
"lng": "",
"lngType": "",
"locateRaw": "",
"locateStatus": "",
"locateTime": "",
"locateTimeTs": 0,
"locateType": "",
"productKey": "",
"satellites": ""
}
},
"extMsg": "",
"msg": ""
}