X-Link API DocumentGet vehicle info
Get the list of vehicles associated with the user, pagination, support by vehicle number query ,only support admin user call,general user referGet the basic of the user's vehicle
Request parameter
| field | type | required | desc |
|---|---|---|---|
| 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 |
| userType | integer | No | User type: 2: administrator (basic information can be changed) 3: General users; 5: Plate No. or device number login |
| vehicleNo | string | No | Plate No. |
| orgGuids | array(integer) | No | Group ID list |
| isUnboundOrg | bool | No | Unbound group |
| isUnboundUser | bool | No | Unbound user |
Response Data (type:object)
| field | type | desc |
|---|---|---|
| total | integer | Total number |
| dataList | array(object) | vehicle info, see Table 1 below the current page |
Table 1:Vehicle info
| field | type | desc |
|---|---|---|
| guid | integer | Vehicle ID |
| adminGuid | integer | Administrator ID Indicates the ID of an administrator |
| createTime | string | Creation time |
| updateTime | string | Update time |
| vehicleNo | string | Plate No. |
| vehicleNoColor | integer | License plate color |
| opState | bool | Running status: true: Running,false: Not running |
| deviceNo | string | Device number |
| password | string | Password, vehicle login password |
| orgGuid | integer | Group ID |
| mileageRatio | integer | Mileage factor 1/100 |
| note | string | remark |
| iconID | integer | Vehicle icon |
| deadlineTime | integer | Service expiration time,UTC time stamp |
| installDate | integer | Installation date |
| industryType | integer | Transport industry - Refer to front-end definitions |
| vehicleWeight | integer | Vehicle tonnage |
| vehicleType | integer | Vehicle type 0: Other; 1: Flatbed car; 2: tow crane; 3: Floor flat car; 4: anti-collision car; 5: Van; 91: basement trailer; 92: Forklift trailer |
Example
Request example
json
http://localhost:8080/basic_api/v1/vehicle/get_list
{
"userGuid":1,
"userType":1,
"vehicleNo":"1300212000",
"orgGuids":[1],
"isUnboundOrg":true,
"isUnboundUser":true
}http://localhost:8080/basic_api/v1/vehicle/get_list
{
"userGuid":1,
"userType":1,
"vehicleNo":"1300212000",
"orgGuids":[1],
"isUnboundOrg":true,
"isUnboundUser":true
}Response example
json
{
"hdr":{
"code":200,
"message":"success" //
},
"data":{
"total":1,
"dataList":[
{
"guid":1,
"adminGuid":1,
"createTime":"2023-11-01 12:12:12",
"updateTime":"2023-11-01 12:12:12",
"vehicleNo":"testA00001",
"vehicleNoColor":2,
"opState":true,
"deviceNo":"13000001",
"password":"",
"orgGuid":1,
"mileageRatio":102, //1.02 times
"note":"",
"iconID":1,
"deadlineTime":1566600015,
"installDate":156655552,
"industryType":1,
"vehicleWeight":1,
"vehicleType":0
}]
}
}{
"hdr":{
"code":200,
"message":"success" //
},
"data":{
"total":1,
"dataList":[
{
"guid":1,
"adminGuid":1,
"createTime":"2023-11-01 12:12:12",
"updateTime":"2023-11-01 12:12:12",
"vehicleNo":"testA00001",
"vehicleNoColor":2,
"opState":true,
"deviceNo":"13000001",
"password":"",
"orgGuid":1,
"mileageRatio":102, //1.02 times
"note":"",
"iconID":1,
"deadlineTime":1566600015,
"installDate":156655552,
"industryType":1,
"vehicleWeight":1,
"vehicleType":0
}]
}
}