API清单
编号 |
API名称 |
请求路径 |
请求方法 |
版本 |
1 |
车位查询接口 |
/v2/smart-parkinglot/xlink-park/car-place?data={data} |
GET |
v1.0.0 |
2 |
员工离职,白名单失效 |
/v2/smart-parkinglot/xlink-park/white-list/disableWhiteMember |
POST |
|
3 |
查询黑白名单配置 |
/v2/smart-parkinglot/xlink-park/applyConfig |
GET |
|
4 |
修改黑白名单配置 |
/v2/smart-parkinglot/xlink-park/applyConfig |
POST |
|
5 |
查询审批记录 |
/v2/smart-parkinglot/xlink-park/apply-log?data={data} |
GET |
|
6 |
同步车场数据到车场服务 |
/v2/smart-parkinglot/xlink-park/sync/basic |
POST |
1.车位查询接口
请求路径
GET /v2/smart-parkinglot/xlink-park/car-place?data={data}
请求参数
字段 |
是否必须 |
字段类型 |
描述 |
备注 |
id |
否 |
string |
ID |
|
project_id |
是 |
string |
项目ID |
|
parkinglot_id |
否 |
string |
停车场ID |
|
user_id |
是 |
string |
用户ID |
回调参数
字段 |
是否必须 |
字段类型 |
描述 |
备注 |
id |
是 |
string |
ID |
|
project_id |
否 |
string |
项目ID |
|
project_name |
否 |
string |
项目名称 |
|
parkinglot_id |
是 |
string |
停车场ID |
|
parkinglot_no |
是 |
string |
停车场编码 |
|
area_id |
否 |
string |
区域ID |
|
area_no |
否 |
string |
区域编码 |
|
area_name |
否 |
string |
区域名称 |
|
parking_space_no |
是 |
string |
车位编码 |
|
parking_space_type |
是 |
int |
车位类型 |
0:标准车位;1:子母车位; |
parking_space_location |
是 |
int |
车位类型 ; |
0:室内车位;1:室外车位 |
parking_space_status |
是 |
int |
车位使用状态 |
0:空闲;1:已租赁;2:已出售 |
is_energy_space |
是 |
int |
是否有充电桩 |
0:否;1:有; |
is_activated |
是 |
int |
是否已激活 |
0:否;1:有; |
2.员工离职,白名单失效
请求路径
- POST /v2/smart-parkinglot/xlink-park/white-list/disableWhiteMember
请求参数
字段 |
是否必须 |
字段类型 |
描述 |
备注 |
contact |
否 |
String |
员工姓名 |
三个参数不同时为空 |
contactNo |
否 |
String |
员工工号 |
三个参数不同时为空 |
contactTel |
否 |
String |
员工手机号 |
三个参数不同时为空 |
返回参数
字段 |
是否必须 |
字段类型 |
描述 |
备注 |
status |
true |
int |
HTTP状态码 |
|
code |
true |
string |
错误码,000000表示请求成功 |
|
msg |
true |
string |
提示内容 |
3.查询黑白名单配置
请求路径
- GET /v2/smart-parkinglot/xlink-park/applyConfig
请求参数
字段 |
是否必须 |
字段类型 |
描述 |
备注 |
projectId |
是 |
String |
项目ID |
|
parkinglotId |
否 |
String |
车场ID |
返回参数
字段 |
是否必须 |
字段类型 |
描述 |
备注 |
status |
true |
int |
HTTP状态码 |
|
code |
true |
string |
错误码,000000表示请求成功 |
|
msg |
true |
string |
提示内容 |
|
data |
true |
Object |
返回内容 |
|
data.list |
true |
Array |
返回列表 |
|
data.list[].maxSize |
true |
Integer |
最大发行量 |
|
data.list[].disable |
true |
Boolean |
是否禁用(默认true,失效状态) |
|
data.list[].effectDate |
true |
Date |
最大有效期限制 |
|
data.list[].configType |
true |
Integer |
类型(0-员工 1-VIP 2-黑名单) |
4.修改黑白名单配置
请求路径
- POST /v2/smart-parkinglot/xlink-park/applyConfig
请求参数
字段 |
是否必须 |
字段类型 |
描述 |
备注 |
id |
是 |
String |
配置ID |
|
maxSize |
否 |
Integer |
车场ID |
查询所有车场时传空 |
disable |
否 |
Boolean |
是否禁用(默认true,禁用状态) |
|
effectDate |
否 |
Date |
最大有效期限制 |
返回参数
字段 |
是否必须 |
字段类型 |
描述 |
备注 |
status |
true |
int |
HTTP状态码 |
|
code |
true |
string |
错误码,000000表示请求成功 |
|
msg |
true |
string |
提示内容 |
5.查询审批记录
请求路径
GET /v2/smart-parkinglot/xlink-park/apply-log?data={data}
请求参数
字段 |
是否必须 |
字段类型 |
描述 |
备注 |
id |
否 |
string |
ID |
|
project_id |
是 |
string |
项目ID |
|
parkinglot_id |
是 |
string |
停车场ID |
|
car_plate_no |
是 |
string |
用户ID |
返回参数
{
"code": "000000",
"msg": "请求成功",
"data": {
"list": [
{
"apply_id": "49a12cdc305aa22c272baf5ae623f8af",
"car_id": null,
"car_plate_no": "粤ALLM02",
"pass_type": 0,
"effective_date_begin": "2021-06-21T16:00:00.000Z",
"effective_date_end": "2021-06-30T15:59:59.000Z",
"contact": "FDSA",
"contact_type": "1",
"contact_no": "",
"contact_tel": "15032112322",
"reason": "同意",
"operator": null,
"remark": "",
"apply_type": 2,
"apply_date": null,
"apply_status": 1,
"is_approval": true,
"file_url": null,
"file_list_count": 1,
"vip_type": "4",
"id": "d1530828fe3eda9a2fdec87f9b088d7b",
"project_id": "21322153",
"project_name": "美的时代花园",
"parkinglot_id": "50267639",
"parkinglot_no": "50267639",
"parkinglot_name": "时代花园大车场",
"create_date": "2021-06-22T06:32:34.619Z",
"update_date": "2021-06-22T06:32:34.619Z",
"deleted": false,
"create_by": "系统",
"create_by_id": null,
"update_by": "系统",
"update_by_id": null,
"delete_date": null
}
],
"count": 1
},
"status": 200
}
6.同步车场数据到车场服务
请求路径
- POST /v2/smart-parkinglot/xlink-park/sync/basic
请求参数
字段 |
是否必须 |
字段类型 |
描述 |
备注 |
parkinglot_id |
否 |
String |
车场id |
车场id为空时,同步项目下所有的车场 |
project_id |
是 |
String |
项目id |
|
sync_data_type |
是 |
int |
同步类型 |
1:同步车场基本信息; 2:同步区域(dataArea=12) 3:同步通道 4:同步设备 5:同步车场区域(dataArea=23) 6:同步进场/出场数据 7:同步异常进出 8:同步临停账单 |
sync_date |
有些类型必须 |
String |
同步日期 |
格式:2021-07-05T16:00:00.000Z sync_data_type=6 、7、8时,同步日期必传 |
返回参数
字段 |
是否必须 |
字段类型 |
描述 |
备注 |
status |
true |
int |
HTTP状态码 |
|
code |
true |
string |
错误码,000000表示请求成功 |
|
msg |
true |
string |
提示内容 |