Skip to content

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 NameParameter DescriptionRequest TypeRequiredData TypeSchema
dkDevice Keyquerytruestring
pkProduct Keyquerytruestring
codeListProperty identifiers to query
Used in conjunction with query type, if querying multiple properties, separate with commas
queryfalsestring
gatewayDkGateway device's Device Keyqueryfalsestring
gatewayPkGateway device's Product Keyqueryfalsestring
typeQuery 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
queryfalsestring

Response Status:

Status CodeDescriptionSchema
200Successfully queried device business attributesRegistration code response data«InnerApiDeviceDetailV2»
5032Token verification failed
5041No permission
5047User authentication mismatch
5052Device not bound
5106Please enter token
5114DMP business attribute query failed
5471Please enter query type for property identifiers

Response Parameters:

Parameter NameParameter DescriptionTypeSchema
codeResponse status codeinteger(int32)integer(int32)
dataResponse dataInnerApiDeviceDetailV2InnerApiDeviceDetailV2
  customizeTslInfoCustom thing model data reporting listarrayCustom Thing Model Data
    abIdFunction IDinteger
    dataTypeData typestring
    nameFunction namestring
    resourceCodeFunction identifierstring
    resourceValceFunction valuestring
    subTypeData operation typestring
    typeFunction typestring
  deviceDataResource thing model data list (battery, voltage, etc. Data available only when reported by device)Device Resource DataDevice Resource Data
    batteryBattery levelnumber
    cellIdBase station IDinteger
    comProtocolVerCommunication protocol versionstring
    dataProtocolVerData protocol versionstring
    deviceKeyDevice Keystring
    iccidICCID numberstring
    lacLocation area codeinteger
    locatorLocation support functionstring
    mccMobile country codeinteger
    mcuVersionMCU versionstring
    memoryFreeRemaining spaceinteger
    mncMobile network codeinteger
    phoneNumPhone numberstring
    productKeyProduct Keystring
    rsrpReference Signal Received Powerinteger
    rsrqLTE Reference Signal Received Qualityinteger
    sdkVersionSDK versionstring
    signalStrengthSignal strengthinteger
    simSIM numberstring
    snrSignal to Interference plus Noise Ratiointeger
    typeModule modelstring
    versionModule versionstring
    voltageVoltagenumber
  deviceLocateInfoDevice location information dataQdLocationLatestQdLocationLatest
    createTimeCreation timestring
    createTimeTsinteger
    deviceKeyDevice keystring
    hdopHorizontal Dilution of Precisionstring
    latLatitudestring
    latTypeLatitude hemisphere N/Sstring
    lngLongitudestring
    lngTypeLongitude hemisphere W/Estring
    locateRawRaw datastring
    locateStatusDifferential positioning/Non-differential positioningstring
    locateTimePositioning timestring
    locateTimeTsinteger
    locateTypePositioning typestring
    productKeyProduct keystring
    satellitesCurrent number of satellitesstring
extMsgExtended messagestring
msgResponse messagestring

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": ""
}