车行管理服务
1 车行空间与设备
车行空间是对小区空间下的车辆出入口、停放区域的空间抽象,主要用于车辆权限分发,以及停车设备管理。
数字社区车行空间包括:
停车区域(parking_area):一个独立的停车场空间,有单独的进出口通道;
车道空间(parking_space_channel):车辆进出口空间,每个车道绑定一个停车设备。
一个小区可以划分多个停车区域,一个停车区域可以包含多个车道,每个车道绑定一个停车设备,如下图所示:
2 车辆通行记录
实时订阅车行数据,用于业务层做流程组装。
模型ID | 版本 |
iot_park_record_v2_model | 1.6 |
车行数据
字段名 | 类型 | 备注 |
direction | Integer | 车辆通行的方向:0:进场,1:出场 |
openType | Integer | 抬杆类型:0:正常抬杆,1:异常抬杆,2:手动抬杆 |
typePermission | Integer | 车辆的进出权限类型:0:普通车辆,1:临时车辆,2:白名单,3:黑名单,4:无牌车 |
tollProductKey | String | 车辆道闸设备productKey |
tollDeviceName | String | 车辆道闸设备deviceName |
plateNumber | String | 车牌号 |
areaSpaceId | String | 停车区域空间ID |
iotId | String | 设备iotId |
plateNumberType | String | 机动车号牌种类代码:01-大型汽车号牌;02-小型汽车号牌;03-使馆汽车号牌;04-领馆汽车号牌;05-境外汽车号牌;06-外籍汽车号牌;07-普通摩托车号牌;08 轻便摩托车号牌;09-使馆摩托车号牌;51-大型新能源车牌汽车; 52-小型新能源车牌车;99-其他 |
carColorNumber | String | 机动车颜色代码:A-白;B-灰;C-黄;D-粉;E-红;F-紫;G-绿;H-蓝;I-棕;J-黑;K-橙;L-青;M-银;N-藏青;Z-其他 |
hasPlate | Integer | 有无车牌:0:无车牌,1:有车牌 |
plateColorNumber | Integer | 机动车号牌颜色:0-白色、1-黄色、2-蓝色、3-黑色,4-其他,5-绿色、6-红色、7-黄绿双色, 8-渐变绿色,9-未识别 |
plateRecognitionReliability | Double | 车牌识别可信度:0~1浮点数 |
carLogoBrand | String | 车辆品牌标志 |
carEigenvaluesInfo | String | 车辆特征值信息,JSON字符串 |
carExtraInfo | String | 车辆扩展信息,JSON字符串 |
userExtraInfo | String | 用户扩展信息,JSON字符串 |
deviceExtraInfo | String | 设备扩展信息,JSON字符串 |
carImageKey | String | 车辆全景图像ID |
channelSpaceId | String | 车道空间ID(出入口) |
3 车行空间管理
3.1 新建车行空间
见“新建小区下区域”接口:
新建停车区域:选择空间类型代码“parking_area”;
新建车道空间:选择空间类型代码“parking_space_channel”,并指定车道方向(direction)。
3.2 修改车行空间
见“修改小区下区域”接口。
3.3 删除车行空间
见“删除小区下区域”接口。
3.4 查询车行空间
见“层级查询子空间”接口。
见“平铺查询子空间”接口
见“查询空间详情”接口。
4 车辆权限管理
4.1 添加(更新)车辆权限
Path路径 | /parking/paas/vehicle/permission/add |
请求方式 | post |
接口版本 | 1.0.0 |
请求参数
参数 | 类型 | 必填 | 描述 |
permList | JSONArray | 是 | |
- spaceId | String | 是 | 空间ID |
- plateNumber | String | 是 | 车牌号 |
- effectiveDate | String | 是 | 车辆有效期的开始时间:yyyy-MM-dd HH:mm:ss |
- expiryDate | String | 是 | 车辆有效期的终止时间:yyyy-MM-dd HH:mm:ss |
返回参数
参数 | 类型 | 描述 |
无 |
4.2 查询车辆权限
Path路径 | /parking/paas/vehicle/permission/query |
请求方式 | post |
接口版本 | 1.0.0 |
请求参数
参数 | 类型 | 必填 | 描述 |
spaceIds | List<String> | 是 | 空间ID |
plateNumbers | List<String> | 否 | 车牌号 |
status | String | 否 | 权限同步状态:
|
pageNo | Integer | 是 | 页码 |
pageSize | Integer | 是 | 页面大小 |
返回参数
参数 | 类型 | 描述 |
pageNo | Integer | 页码 |
pageSize | Integer | 页面大小 |
total | Integer | 总数 |
data | JSONArray | 权限列表 |
- plateNumber | String | 车牌号 |
- effectiveDate | String | 车辆有效期的开始时间:yyyy-MM-dd HH:mm:ss |
- expiryDate | String | 车辆有效期的终止时间:yyyy-MM-dd HH:mm:ss |
- spaceId | String | 空间ID |
- spaceName | String | 空间名称 |
- status | String | 权限同步状态:
|
4.3 删除车辆权限
Path路径 | /parking/paas/vehicle/permission/delete |
请求方式 | post |
接口版本 | 1.0.0 |
请求参数
参数 | 类型 | 必填 | 描述 |
permList | JSONArray | 是 | |
-spaceId | String | 是 | 空间ID |
-plateNumber | String | 是 | 车牌号 |
返回参数
参数 | 类型 | 描述 |
无 |
5 黑白名单管理
5.1 添加(更新)黑白名单
Path路径 | /parking/paas/vehicle/special/concerns/add |
请求方式 | post |
接口版本 | 1.0.0 |
请求参数
参数 | 类型 | 必填 | 描述 |
permList | JSONArray | 是 | |
- spaceId | String | 是 | 空间ID |
- plateNumber | String | 是 | 车牌号 |
- type | String | 是 | 车辆类型:
|
- brand | String | 否 | 车辆品牌 |
- color | Integer | 否 | 车身颜色: 0-其他 1-白 2-灰 3-黄 4-粉 5-红 6-紫 7-绿 8-蓝 9-棕 10-黑 11-青 |
返回参数
参数 | 类型 | 描述 |
无 |
5.2 删除黑白名单
Path路径 | /parking/paas/vehicle/special/concerns/delete |
请求方式 | post |
接口版本 | 1.0.1 |
请求参数
参数 | 类型 | 必填 | 描述 |
permList | JSONArray | 是 | |
- spaceId | String | 是 | 空间ID |
- plateNumber | String | 是 | 车牌号 |
返回参数
参数 | 类型 | 描述 |
无 |
5.3 查询黑白名单
Path路径 | /parking/paas/vehicle/special/concerns/query |
请求方式 | post |
接口版本 | 1.0.0 |
请求参数
参数 | 类型 | 必填 | 描述 |
spaceIds | List<String> | 是 | 空间ID |
plateNumbers | List<String> | 否 | 车牌号 |
type | String | 是 | 车辆类型:
|
pageNo | Integer | 是 | 页码 |
pageSize | Integer | 是 | 页面大小 |
返回参数
参数 | 类型 | 描述 |
pageNo | Integer | 页码 |
pageSize | Integer | 页面大小 |
total | Integer | 总数 |
data | JSONArray | 权限列表 |
- plateNumber | String | 车牌号 |
- brand | String | 车辆品牌 |
- color | Integer | 车身颜色: 0-其他 1-白 2-灰 3-黄 4-粉 5-红 6-紫 7-绿 8-蓝 9-棕 10-黑 11-青 |
- spaceId | String | 空间ID |
- status | String | 黑白名单同步状态:
|
6 停车设备管理
6.1 绑定停车设备
Path路径 | /parking/paas/toll/bind |
请求方式 | post |
接口版本 | 1.0.0 |
请求参数
参数 | 类型 | 必填 | 描述 |
iotId | String | 是 | 设备唯一标识 |
spaceId | String | 是 | 车道空间ID |
返回参数
参数 | 类型 | 描述 |
无 |
6.2 解绑停车设备
Path路径 | /parking/paas/toll/unbind |
请求方式 | post |
接口版本 | 1.0.0 |
请求参数
参数 | 类型 | 必填 | 描述 |
iotId | String | 是 | 设备唯一标识 |
返回参数
参数 | 类型 | 描述 |
无 |
6.3 查询停车设备
Path路径 | /parking/paas/toll/query |
请求方式 | post |
接口版本 | 1.0.0 |
请求参数
参数 | 类型 | 必填 | 描述 |
spaceId | String | 是 | 车道空间ID |
getDeviceStatus | Boolean | 否 | 是否查询设备状态:
|
返回参数
参数 | 类型 | 描述 |
iotId | String | 设备iotId |
name | String | 设备名称 |
productKey | String | 设备productKey |
status | Integer | 设备状态:
|
7 远程开关道闸
见“触发物的服务”接口。
请求参数
参数 | 类型 | 必填 | 备注 |
iotId | String | 是 | 设备唯一标识 |
args | map | 是 | {"OperatType": 1}
|
identifier | String | 是 | 固定值:OperatGate |
返回结果
字段名 | 类型 | 备注 |
无 | 无 | 无 |
8 车道视频直播
见“查询推流地址”接口。
9 LED内容下发
9.1 LED内容下发模式
见“获取物的属性”接口,属性标识为“LedNoticeMode”,支持以下属性值:
0:设备支持分离下发模式,可分别下发提示语音、提示显示、默认显示;
1:设备仅支持混合下发提示信息,屏幕不支持单行刷新。
9.2 提示语音下发
见“触发物的服务”接口。
请求参数
参数 | 类型 | 必填 | 备注 |
iotId | String | 是 | 设备唯一标识 |
args | Map | 是 | {"VoiceContent": "语音提示信息","PlaySpeed":1} |
-VoiceContent | String | 是 | 语音播报内容,数据长度2048 |
-PlaySpeed | Integer | 否 | 语音播报速度,取值范围:1 - 10,步长:1 |
identifier | String | 是 | 固定值:NoticeBroadcast |
返回结果
字段名 | 类型 | 备注 |
无 | 无 | 无 |
9.3 提示显示下发
见“触发物的服务”接口。
请求参数
参数 | 类型 | 必填 | 备注 |
iotId | String | 是 | 设备唯一标识 |
args | Map | 是 | {"DisplayContent": "提示显示信息","RowNumber":1} |
-DisplayContent | String | 是 | 显示内容,数据长度2048 |
-RowNumber | Integer | 是 | 屏幕行号,取值范围:1 - 100 |
-MovingSpeed | Integer | 否 | 文字移动速度,取值范围:1 - 10,步长:1 |
-DisplayTime | Integer | 否 | 显示时长,取值范围:1 - 3600,单位:秒 |
-MovingType | Integer | 否 | 文字移动方式:
|
identifier | String | 是 | 固定值:NoticeDisplay |
返回结果
字段名 | 类型 | 备注 |
无 | 无 | 无 |
9.4 默认显示下发
见“触发物的服务”接口。
请求参数
参数 | 类型 | 是否必填 | 备注 |
iotId | String | 是 | 设备唯一标识 |
args | Map | 是 | {"DisplayContent": "提示显示信息", "RowNumber":1, "DefaultSituation":0} |
-DisplayContent | String | 是 | 显示内容,数据长度2048 |
-RowNumber | Integer | 是 | 屏幕行号,取值范围:1 - 100 |
-DefaultSituation | Integer | 是 | 默认显示场景:
|
identifier | String | 是 | 固定值:DefaultDisplay |
返回结果
字段名 | 类型 | 备注 |
无 | 无 | 无 |
9.5 LED内容混合下发
不支持“提示语音”、“提示显示”分离下发的设备,使用以下接口混合下发提示信息。
Path路径 | /parking/paas/led/content/download |
请求方式 | post |
接口版本 | 1.0.0 |
请求参数
参数 | 类型 | 必填 | 描述 |
iotId | String | 是 | 车行摄像头的设备ID |
type | Integer | 是 | 下发场景类型:
|
situation | Integer | 否 | 固定场景种类:
|
showTime | Integer | 否 | 内容持续显示时长,单位:秒,默认值:10 |
audioContextInfo | String | 否 | 自定义语音播报内容 |
screenLineNum | Integer | 是 | 屏幕显示行数,默认值:4 |
contextList | JSONArray | 是 | 屏幕显示内容,每个元素表示一行 |
- runType | Integer | 否 | 文字滚动方式:
|
- colorType | Integer | 否 | 文字颜色:
|
- customContext | String | 是 | 自定义内容,长度0-128。内容支持以下通配符:
|
- audio | Integer | 否 | 是否进行语音播报:
|
返回参数
参数 | 类型 | 描述 |
无 |
10 手动触发车牌识别
见“触发物的服务”接口。
请求参数
参数 | 类型 | 是否必填 | 备注 |
iotId | String | 是 | 设备唯一标识 |
args | Map | 是 | {} |
identifier | String | 是 | 固定值:TriggerRecognition |
返回结果
字段名 | 类型 | 备注 |
无 | 无 | 无 |
11 二维码下发
11.1 是否支持二维码
见“获取物的属性”接口,属性标识为“IsSurportQrCode”,支持以下属性值:
0:不支持
1:支持
11.2 二维码下发
见“触发物的服务”接口。
请求参数
参数 | 类型 | 是否必填 | 备注 |
iotId | String | 是 | 设备唯一标识 |
args | Map | 是 | {"QrCode":"二维码文本信息"} |
identifier | String | 是 | 固定值:QrCodeDisplay |
返回结果
字段名 | 类型 | 备注 |
无 | 无 | 无 |