API列表
请求方式 |
API |
描述 |
POST |
/v1.0/iot-02/third/parking/cars |
注册车辆 |
POST |
/v1.0/iot-02/third/parking/cars/batch |
批量注册车辆 |
PUT |
/v1.0/iot-02/third/parking/cars/{car_id} |
修改车辆 |
DELETE |
/v1.0/iot-02/third/parking/cars/{car_id} |
删除车辆 |
GET |
/v1.0/iot-02/third/parking/cars/{car_id} |
车辆详情 |
GET |
/v1.0/iot-02/third/parking/cars |
查询车辆 |
注册车辆
功能描述
注册车辆
接口地址
POST /v1.0/iot-02/third/parking/cars
请求参数
参数名 |
类型 |
参数类型 |
说明 |
是否必需 |
owner_id |
String |
body |
车主用户 id,不超过 32 个字符 |
false |
mobile |
String |
body |
车主手机号,不超过 32 个字符 |
false |
user_name |
String |
body |
车主名,不超过 64 个字符 |
false |
organization |
String |
body |
所属机构,不超过 100 个字符 |
false |
plate_number |
String |
body |
车牌号,不超过 64 个字符 |
true |
type |
String |
body |
车辆类型,(fixed_car:固定车;temporary_car:临时车;visitor_car:访客(预约)车;white_list_car:白名单车;ownership_car:产权车;blank_list_car:黑名单车;other_car:其它类型车;month_card_car:月卡车) |
true |
prove_image_list |
String[] |
body |
车辆证明图 |
false |
space_type |
String |
body |
空间类型,车辆关联的是车组/车位,(parking_group:车组;parking_spot:车位) |
false |
space_id |
String |
body |
空间 id,车组/车位 id,不超过 32 个字符 |
false |
status |
int |
body |
车辆初始状态 |
false |
返回参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13 位 |
result |
String |
车辆 id |
result 参数说明
请求示例
POST /v1.0/iot-02/third/parking/cars
{
"owner_id": "nqnQjucyHC",
"mobile": "1777777777",
"user_name": "张三",
"organization": "涂鸦",
"plate_number": "浙A12345",
"type": "fixed_car",
"prove_image_list": [
"pweeEnI364"
],
"space_type": "parking_group",
"space_id": "sqgxb9BLvN",
"status": 1
}
响应示例
{
"success": true,
"t": 1573441137,
"result": "qiSK8qiiDr"
}
批量注册车辆
功能描述
批量注册车辆
接口地址
POST /v1.0/iot-02/third/parking/cars/batch
请求参数
参数名 |
类型 |
参数类型 |
说明 |
是否必需 |
car_list |
Object[] |
body |
车辆列表 |
true |
- owner_id |
String |
body |
车主用户 id,不超过 32 个字符 |
false |
- mobile |
String |
body |
车主手机号,不超过 32 个字符 |
true |
- user_name |
String |
body |
车主名,不超过 64 个字符 |
true |
- organization |
String |
body |
所属机构,不超过 100 个字符 |
false |
- plate_number |
String |
body |
车牌号,不超过 64 个字符 |
true |
- type |
String |
body |
车辆类型,(fixed_car:固定车;temporary_car:临时车;visitor_car:访客(预约)车;white_list_car:白名单车;ownership_car:产权车;blank_list_car:黑名单车;other_car:其它类型车;month_card_car:月卡车) |
false |
- prove_image_list |
String[] |
body |
车辆证明图 |
false |
- space_type |
String |
body |
空间类型,车辆关联的是车组/车位,(parking_group:车组;parking_spot:车位) |
false |
- space_id |
String |
body |
空间 id,车组/车位 id,不超过 32 个字符 |
false |
- status |
int |
body |
车辆初始状态 |
false |
返回参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13 位 |
result |
String[] |
车辆 id 列表 |
请求示例
POST /v1.0/iot-02/third/parking/cars/batch
{
"car_list": [
{
"owner_id": "MIARbioGCS",
"mobile": "17777777",
"user_name": "张三",
"organization": "涂鸦",
"plate_number": "浙A12345",
"type": "fixed_car",
"prove_image_list": [
"ez5dfCMRT2"
],
"space_type": "parking_group",
"space_id": "DjuAmZcViq",
"status": 1
}
]
}
响应示例
{
"success": true,
"t": 1573441137,
"result": []
}
修改车辆
功能描述
修改车辆
接口地址
PUT /v1.0/iot-02/third/parking/cars/{car_id}
请求参数
参数名 |
类型 |
参数类型 |
说明 |
是否必需 |
car_id |
String |
url |
车辆 id |
true |
owner_id |
String |
body |
车主用户 id,不超过 32 个字符 |
false |
mobile |
String |
body |
车主手机号,不超过 32 个字符 |
false |
user_name |
String |
body |
车主名,不超过 64 个字符 |
false |
organization |
String |
body |
所属机构,不超过 100 个字符 |
false |
prove_image_list |
String[] |
body |
车辆证明图 |
false |
space_type |
String |
body |
空间类型,车辆关联的是车组/车位,(parking_group:车组;parking_spot:车位) |
false |
space_id |
String |
body |
空间 id,车组/车位 id,不超过 32 个字符 |
false |
status |
int |
body |
车辆状态 |
false |
返回参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13 位 |
result |
boolean |
成功、失败 |
请求示例
PUT /v1.0/iot-02/third/parking/cars/{car_id}
{
"owner_id": "cE0nvxMEMQ",
"mobile": "1777777777",
"user_name": "张三",
"organization": "涂鸦",
"prove_image_list": [
"S8bwbuggbq"
],
"space_type": "parking_group",
"space_id": "8JvrYa9FTP",
"status": 267632
}
响应示例
{
"success": true,
"t": 1573441137,
"result": false
}
删除车辆
功能描述
删除车辆
接口地址
DELETE /v1.0/iot-02/third/parking/cars/{car_id}
请求参数
参数名 |
类型 |
参数类型 |
说明 |
是否必需 |
car_id |
String |
url |
车 id |
true |
返回参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13 位 |
result |
boolean |
成功、失败 |
请求示例
DELETE /v1.0/iot-02/third/parking/cars/{car_id}
响应示例
{
"success": true,
"t": 1573441137,
"result": false
}
车辆详情
功能描述
车辆详情
接口地址
GET /v1.0/iot-02/third/parking/cars/{car_id}
请求参数
参数名 |
类型 |
参数类型 |
说明 |
是否必需 |
car_id |
String |
url |
车辆 id |
true |
car_id |
String |
query |
车辆 id |
true |
返回参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13 位 |
result |
Object |
车辆信息 |
result 参数说明
参数名 |
类型 |
说明 |
project_id |
String |
项目 id |
creator |
String |
创建者 |
modifier |
String |
修改者 |
gmt_create |
long |
创建时间(毫秒) |
gmt_modified |
long |
修改时间(毫秒) |
car_id |
String |
车辆 id |
plate_number |
String |
车牌号 |
type |
String |
车辆性质 |
organization |
String |
所属机构 |
owner_id |
String |
车主 id |
mobile |
String |
车主手机号 |
user_name |
String |
车主名 |
source |
String |
来源 |
prove_image_list |
String[] |
车辆证明图 |
status |
int |
车辆状态 |
请求示例
GET /v1.0/iot-02/third/parking/cars/{car_id}?car_id=Qd2QHD1jHD
响应示例
{
"success": true,
"t": 1573441137,
"result": {
"project_id": "PocxMLCgTc",
"creator": "Ask0cgMgc5",
"modifier": "efa7mb4OHf",
"gmt_create": 484897,
"gmt_modified": 957624,
"car_id": "zhcXXcOhQF",
"plate_number": "浙A12345",
"type": "Wh9KHcC36R",
"organization": "ppIRuBcRwC",
"owner_id": "iHXHc4Z9zd",
"mobile": "17777777",
"user_name": "张三",
"source": "odidG8fJJd",
"prove_image_list": ["AyyJNY8P8I"],
"status": 1
}
}
查询车辆
功能描述
查询车辆
接口地址
GET /v1.0/iot-02/third/parking/cars
请求参数
参数名 |
类型 |
参数类型 |
说明 |
是否必需 |
page_no |
int |
query |
页码,最小值 1 |
false |
page_size |
int |
query |
页大小,最小值 1,最大值 1000 |
false |
owner_id |
String |
query |
车主用户 id |
false |
mobile |
String |
query |
车主手机号(模糊搜索) |
false |
user_name |
String |
query |
车主名(模糊搜索) |
false |
plate_number |
String |
query |
车牌号 |
false |
organization |
String |
query |
所属机构 |
false |
type |
String |
query |
车辆类型,(fixed_car:固定车;temporary_car:临时车;visitor_car:访客(预约)车;white_list_car:白名单车;ownership_car:产权车;blank_list_car:黑名单车;other_car:其它类型车;month_card_car:月卡车) |
false |
status |
int |
query |
车辆状态,(0:待审核;1:审核通过;2:审核不通过) |
false |
返回参数
参数名 |
类型 |
说明 |
code |
Integer |
响应码(详情见错误码章节),成功时为空 |
success |
Boolean |
是否成功:(true:成功,false:失败) |
msg |
String |
请求失败的信息,成功时为空 |
t |
Long |
返回时间戳,13 位 |
result |
Object |
车辆分页信息 |
result 参数说明
参数名 |
类型 |
说明 |
total |
int |
总数 |
data |
Object[] |
当前页数据 |
project_id |
String |
项目 id |
creator |
String |
创建者 |
modifier |
String |
修改者 |
gmt_create |
long |
创建时间(毫秒) |
gmt_modified |
long |
修改时间(毫秒) |
car_id |
String |
车辆 id |
plate_number |
String |
车牌号 |
type |
String |
车辆性质 |
organization |
String |
所属机构 |
owner_id |
String |
车主 id |
mobile |
String |
车主手机号 |
user_name |
String |
车主名 |
source |
String |
来源 |
prove_image_list |
String[] |
车辆证明图 |
status |
int |
车辆状态 |
请求示例
GET /v1.0/iot-02/third/parking/cars?page_no=1&page_size=100&owner_id=Onmvk1dha7&mobile=1777777777&user_name=张三&plate_number=浙A12345&organization=涂鸦&type=fixed_car&status=0
响应示例
{
"success": true,
"t": 1573441137,
"result": {
"total": 1,
"data": [
{
"project_id": "GGu4xoNVPH",
"creator": "WnAw4gbaNj",
"modifier": "V0YHMmd4vI",
"gmt_create": 247896,
"gmt_modified": 104018,
"car_id": "InqEZT45v7",
"plate_number": "浙A12345",
"type": "XlcQGjtsQC",
"organization": "2lflS7lhT0",
"owner_id": "thqJuV4paE",
"mobile": "17777777",
"user_name": "张三",
"source": "lf9e9Huwmb",
"prove_image_list": ["14srsLajYk"],
"status": 1
}
]
}
}