X-Link API DocumentGet device info
get a list of devices associated with the user, paginate, and support querying by terminal number,only support admin user call,general user referGet the basic of the user's vehicle
API information
Url: /basic_api/v1/device/get_list
Method: GET
Content-Type:x-www-form-urlencoded
Request parameter
| field | type | required | desc |
|---|---|---|---|
| curPage | integer | Yes | Current page |
| pageNum | integer | Yes | Quantity per page |
| userGuid | integer | No | User ID. Only when you log in as the super administrator, the user needs to query the information about the specified management user |
| deviceNo | string | No | Device number |
| protocolType | integer | Yes | Protocol type :1:JT2013,2:JT2019 |
| isNotBound | bool | No | Not yet bound |
Response Data (type:object)
| field | type | desc |
|---|---|---|
| total | integer | total num |
| data | array(object) | Device list,jump to table 1 |
table 1:device info
| field | type | desc |
|---|---|---|
| deviceNo | string | Device number |
| protocolType | integer | Protocol type 1:JT808-2013,2:JT808-2019 |
| channelNum | integer | Channel num |
| channelValidFlag | integer | Channel valid flag,by bit,example:3:ch 1,2 is valid |
| guid | integer | Device id |
| adminGuid,omitempty | integer | Admin ID |
| createTime | string | Create time |
| updateTime | string | Update time |
Example
Request example
url
http://localhost:8080/basic_api/v1/device/get_list?curPage=1&pageNum=10&userGuid=1&deviceNo=13000000005&protocolType=1&isNotBound=truehttp://localhost:8080/basic_api/v1/device/get_list?curPage=1&pageNum=10&userGuid=1&deviceNo=13000000005&protocolType=1&isNotBound=trueResponse example
json
{
"hdr": {
"code": 200,
"message": "success"
},
"data":
{
"total":1,
"dataList":[{
"devicNo": "13000000005",
"protocolType": 1,
"channelNum": 1,
"channelValidFlag": 1,
"guid": 1,
"adminGuid": 1,
"createTime": "2023-11-04 10:12:50",
"updateTime": "2023-11-04 10:12:50"
}]
}
}{
"hdr": {
"code": 200,
"message": "success"
},
"data":
{
"total":1,
"dataList":[{
"devicNo": "13000000005",
"protocolType": 1,
"channelNum": 1,
"channelValidFlag": 1,
"guid": 1,
"adminGuid": 1,
"createTime": "2023-11-04 10:12:50",
"updateTime": "2023-11-04 10:12:50"
}]
}
}