文档

停车场系统领域服务-服务模型定义

更新时间:
一键部署

服务模型相关说明 :

服务模型相关说明

服务模型名称

停车场系统领域模型

模型标识符

iotx_parking_service_model

发布模型版本

1.0

1. 停车场

1.1 查询停车场信息

停车场信息包含停车场名称、停车场ID、车位总数量、车位空位数量

定义

path

版本

是否需要登录

/parkingLotInfoGet

1.0.0

入参

无参数

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

objectList

停车场信息,可能是多个停车场信息

ParkingLotInfoDTO对象

字段

类型

备注

name

String

停车场名称

parkingLotId

String

停车场ID

totalCount

Integer

总车位数

unParkedCount

Integer

空余车位数

示例

{
  "code": 200,
  "data": [
    {
      "name":"户外停车场",
     "parkingLotId":"a34d9b3ld93lb",
     "totalCount":677,
     "unParkedCount":302
    },
  ],
  "message": null
}

1.2 查询停车场一级区域ID

定义

path

版本

是否需要登录

/parkingLotFirstAreaIdsGet

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

示例

{
   "parkingLotId": "a34d9b3ld93lb"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

Array

停车场区域编码列表

示例

{
  "code": 200,
  "data":[
        "area_id_1",
        "area_id_2",
        ...
  ],
  "message": null
}

1.3 查询停车场道闸信息

本接口就提供停车场道闸的查询功能

定义

path

版本

是否需要登录

/parkingLotBarriersInfoGet

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

示例

{
   "parkingLotId": "a34d9b3ld93lb"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

List

道闸的dto

BarrierDTO

barrierId

String

道闸ID

barrierName

String

道闸名称

direction

String

IN表示进场道闸,OUT表示出场道闸

示例

{
  "code": 200,
  "data": [
    {
    "barrierId":"道闸id",
    "barrierName":"道闸名称",
    "direction":"IN"
  },
    ],
  "message": null
}

1.4 校正停车系统通行记录上的车牌号

如果车辆通过的时候,系统识别出来的车牌号和实际车牌号不符,调用该接口校正对应的车牌号。这个接口校正的是本地系统上一次通行记录中对应的车牌号。这个接口是为了解决本地系统上,通行记录里的错误车牌号会影响收费计算的问题。

定义

path

版本

是否需要登录

/parkingLotPlateNumberUpdate

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

plateNumber

String

车牌号

recordId

String

车辆通行上报的通行事件ID。对应车辆通行数据模型

iot_park_pass_record

的recordId字段。

示例

{
  "parkingLotId":"xxxxxxxx",
  "plateNumber":"浙X XXXXX",
  "recordId":"a389FIUHDK"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{
  "code": 200,
  "data":"",
  "message": null
}

2. 停车区域

停车区域是存在层级结构的,区域下可以挂区域,根区域挂在停车场下。

2.1 查询停车区域信息

停车区域信息包含停车区域名称、区域ID、上层区域的ID、下一层区域ID的列表、空余车位数、总车位数。

定义

path

版本

是否需要登录

/parkingAreaInfoGet

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

areaId

String

停车区域ID

示例

{
   "parkingLotId":"停车场id",
    "areaId": "d4d984jdlafjek"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

Object

停车场信息

AreaDTO

name

String

停车区域名称

areaId

String

区域ID

parentAreaId

String

上层区域ID

subAreaList

List

下一层区域ID列表

unParkedCount

Integer

空余车位数

totalCount

Integer

总车位数

示例

{
  "code": 200,
  "data": {
    "name":"区域a",
    "areaId":"area1",
    "parentAreaId":"a34d9b3ld93lb",
    "SubAreaList":[
     "SubAreaId_1",
     "SubAreaId_2",
     "SubAreaId_3",
     ...
     ],
    "unParkedCount":30,
    "totalCount":67
  },
  "message": null
}

2.2 查询区域下的道闸列表

返回的是代表道闸的设备信息

定义

path

版本

是否需要登录

/parkingAreaBarriersInfoGet

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

车场ID

areaId

String

停车区域ID

示例

{
   "parkingLotId": "10",
   "areaId": "d4d984jdlafjek"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

List

返回的数据对象列表

BarrierDTO

barrierId

String

道闸ID

barriereName

String

道闸名称

direction

String

IN表示进场道闸,OUT表示出场道闸。不填不会更新这个属性。

示例

{
  "code": 200,
  "data": [
    {
     "barrierId":"4a70179d",
      "barriereName":"xxxx",
      "direction":"IN"
   },
   ],
  "message": null
}

2.3 查询区域车位列表

这是一个全量列表,返回的是车位在本地系统中的编码,这个编码用于同步停车位

定义

path

版本

是否需要登录

/parkingAreaParkspacesGet

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

车场ID

areaId

String

停车区域ID

示例

{
   "parkingLotId":"d4d984jdlaf",
   "areaId": "d4d984jdlafjek"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

Array

返回的都是车位的ID,放入数组里

示例

{
  "code": 200,
  "data": [
          "parkingSpaceId_1",
          "parkingSpaceId_2",
            ...
  ],
  "message": null
}

3. 道闸

3.1 查询道闸信息

定义

path

版本

是否需要登录

/parkingBarrierInfoGet

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

barrierId

String

道闸ID

示例

{
  "parkingLotId":"xxxx",
  "barrierId":"xxx"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

Object

道闸的信息

BarrierDTO

areaId

String

道闸所属区域ID

barrierId

String

道闸ID

status

String

open道闸打开,close道闸关闭

direction

String

in表示进场道闸,out表示出场道闸。不填不会更新这个属性。

barrierName

String

道闸名称

示例

{
  "code": 200,
  "data": {
     "areaIdBarrierId":"4a70179d",
      "barrierId":"xxxx",
      "status":"open",
      "direction":"in",
      "barrierName":"道闸名称"
  },
  "message": null
}

3.2 手动打开道闸栏杆

定义

path

版本

是否需要登录

/parkingBarrierOperate

1.0.0

入参

字段

类型

是否必传

备注

barrierId

String

道闸Id

command

String

选项:

open -- 打开

close -- 关闭

keepOpen -- 长开

示例

{
  "barrierId":"道闸唯一标识",
  "command":"open"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{
  "code": 200,
  "data":null,
  "message": null
}

4. 停车位

4.1 更新停车位

定义

path

版本

是否需要登录

/parkingAreaParkspaceUpdate

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

areaId

String

区域ID

parkingSpaceId

String

车位ID

userName

String

用户姓名

parkingSpaceType

String

车位类型:

private私人车位

public公共车位

consume消费车位

guest访客车位

selfdefined自定义

不填不更新

isSold

String

true 已售

false未售

property

String

guard人防

noguard非人防

不填不更新

ownerPhone

String

产权人手机号

不填不更新

ownerName

String

产权人姓名长度64字符

不填不更新

ownerId

String

产权人证件号

不填不更新

示例

{
  "parkingLotId": "ad8sdlfd",
  "parkingSpaceId": "ad8sdlfd",
  "userName":"用户姓名",
  "type": "A位",
  "isSold":"true/false",
  "property":"GUARD",
  "ownerPhone":"18967533306",
  "ownerName":"产权人姓名",
  "ownerId":"122345666"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{
  "code": 200,
  "data": null,
  "message": null
}

4.2 查询车位信息

定义

path

版本

是否需要登录

/parkingAreaParkspaceGet

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

areaId

String

区域ID

parkingSpaceId

String

车位ID

示例

{
  "parkingLotId":"28384949", 
  "areaId":"294949540",
  "parkingSpaceId": "vnidalwed746aosd"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

Object

车位信息

ParkingSpaceDTO

parkingSpaceId

String

车位的ID

name

String

车位名称

type

String

车位类型:

private私人车位

public公共车位

consume消费车位

guest访客车位

selfdefined自定义

isSold

Boolean

true 已售

false未售

property

String

guard人防

noguard非人防

ownerPhone

String

产权人手机号

ownerName

String

产权人姓名长度64字符

ownerId

String

产权人证件号

isParking

Boolean

true有车在停泊,false无车

plateNumber

String

停泊车的车牌号

示例

{
  "code": 200,
  "data": {
    "parkingSpaceId":"vnidalwed746aosd",
    "parkingLotId":"a34d9b3ld93lb",
    "type":"a34d9b3ld93lb",
    "isSold":"true",
    "property":"PRIVATE",
    "ownerPhone":"13939495959",
    "ownerName":"老王",
    "ownerId":"2839494",
    "isParking":"true",
    "plateNumber":"京N TR669"
  },
  "message": null
}

5. 车辆管理

5.1 添加车辆

定义

path

版本

是否需要登录

/parkingLotVehicleAdd

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

plateNumber

String

车牌号

userName

String

用于显示的车主名字

userPhone

String

车主联系电话

userId

String

车主证件号

示例

{
  "parkingLotId": "d4d984jdlafjek",
  "plateNumber":"京N TR666",
  "userName": "王生",
  "userPhone":"13888888888",
  "userId":"10xxxxxxxxxxxx9876X"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{
  "code": 200,
  "data":null,
  "message": null
}

5.2 删除车辆

定义

path

版本

是否需要登录

/parkingLotVehicleDelete

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

plateNumber

String

车牌号

示例

{
  "parkingLotId": "d4d984jdlafjek",
  "licenseNumber":"京N TR666"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{
  "code": 200,
  "data":null,
  "message": null
}

5.3 更新车辆信息

定义

path

版本

是否需要登录

/parkingLotVehicleUpdate

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场的ID,创建停车场时的ID

plateNumber

String

车牌号

userName

String

车主名字,不传不修改

userPhone

String

车主联系电话,不传不修改

userId

String

车主证件号,不传不修改

示例

{
  "parkingLotId": "d4d984jdlafjek",
  "plateNumber":"京N TR666",
  "userName": "王生",
  "userPhone":"13888888888",
  "userId":"10xxxxxxxxxxxx9876X"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{
  "code": 200,
  "data":null,
  "message": null
}

5.4 停车场内的车辆列表

返回车牌号的列表

定义

path

版本

是否需要登录

/parkingLotVehicleListInfoGet

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场Id

pageSize

Integer

分页查询,每页显示条数上限100

pageNum

Integer

分页查询,当前页数从1开始

示例

{
  "parkingLotId": "d4d984jdlafjek",
  "pageSize":20,
  "pageNum":20
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

List

车牌列表

车牌列表

plateNumberList

List

车牌列表

示例

{
  "code": 200,
  "data": [
        "浙A5566",
        "浙A5567",
        "浙A5568",
       ...
 ],
  "message": null
}

5.5查询停车场的车辆信息

定义

path

版本

是否需要登录

/parkingLotVehicleInfoGet

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

plateNumber

String

车牌号

示例

{
  "parkingLotId": "d4d984jdlafjek",
  "plateNumber":"京N TR666"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

Object

车辆信息

VehicleDTO

字段

类型

备注

parkingLotId

String

停车场的ID,创建车位的时候获取

userName

String

车主名字,不传不修改

userPhone

String

车主联系电话,不传不修改

userId

String

车主证件号,不传不修改

plateNumber

String

车牌号

parkingSpaceId

String

停泊的车位ID

示例

{
  "code": 200,
  "data":{
      "parkingLotId": "d4d984jdlafjek",
      "userName": "王生",
      "userPhone":"13888888888",
      "userId":"10xxxxxxxxxxxx9876X",
      "plateNumber":"京N TR666",
      "parkingSpaceId":"509x480"
  },
  "message": null
}

5.6 锁定车辆

定义

path

版本

是否需要登录

/parkingLotVehicleLock

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场的ID

plateNumber

String

车牌号

lockEffectiveDate

String

锁车的开始时间,时间格式 yyyy-MM-dd HH:mm:ss"

lockExpiredDate

String

锁车的结束时间,时间格式 yyyy-MM-dd HH:mm:ss"

示例

{
   "parkingLotId": "d4d984jdlafjek",
   "plateNumber":"京N TR666",
   "lockEffectiveDate":"2019-01-01 00:00:00",
   "lockExpiredDate":"2021-12-31 23:59:59"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{
  "code": 200,
  "message": null
}

5.7 查询车场中锁定车辆的信息

定义

path

版本

是否需要登录

/parkingLotVehicleLockGet

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

plateNumber

String

车牌号

示例

{
  "parkingLotId":"停车场id",
  "plateNumber":"京A 5938"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

Object

锁定车辆信息

VehicleDTO

字段

类型

备注

lockEffectiveDate

String

锁车的开始时间,时间格式 yyyy-MM-dd HH:mm:ss"

lockExpiredDate

String

锁车的结束时间,时间格式 yyyy-MM-dd HH:mm:ss"

{
  "code": 200,
  "data":{
    "lockEffectiveDate":"2019-01-01 00:00:00",
    "lockExpiredDate":"2021-12-31 23:59:59"
  },
  "message": null
}

5.8 取消锁定车辆

定义

path

版本

是否需要登录

/parkingLotVehicleUnlock

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

plateNumber

String

车牌号

示例

{
  "parkingLotId":"停车场id",
  "plateNumber":"京A 5938"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{  
  "code": 200,
  "data":null,
  "message": null
}

5.9 查询车辆入场时间

path

版本

是否需要登录

/parkingLotVehicleInTime

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

车场ID

plateNumber

String

车牌号

示例

{
 "parkingLotId":"349494590",
  "plateNumber":"京A384859"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

Object

VehicleDTO

VehicleInTimeDTO

字段

类型

备注

vehicleInTime

String

车辆入场时间,时间格式yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss

{  
  "code": 200,
  "data":{
      "2019-06-03 17:53:04"
  },
  "message": null
}

6 车辆权限

6.1 车辆对道闸授权

说明:

如权限已存在,则更新权限

定义

path

版本

是否需要登录

/parkingVehiclePermissionAdd

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

effectiveDate

String

车牌信息有效期的开始yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

expiryDate

String

车牌信息有效期的终止yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

plateNumber

String

车牌号

barrierList

List

道闸列表

示例

{
  "parkingLotId":"73849593",
  "effectiveDate": "2019-01-01 00:00:00",
  "expiryDate": "2019-01-01 00:00:00",
  "plateNumber": "京N12345",
  "barrierList": [
      "xxx"
  ]
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{
  "code": 200,
  "data":null,
  "message": null
}

6.2 车辆对道闸权限查询

定义

path

版本

是否需要登录

/vehicleBarrierPermissionGet

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

plateNumber

String

车牌号

示例

{
  "parkingLotId":"37484949",
  "plateNumber": "京N12345"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

List<VehiclePermissionDTO>

车辆权限信息

VehiclePermissionDTO

字段

类型

备注

plateNumber

String

车牌号

effectiveDate

String

车牌信息有效期的开始时间yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

expiryDate

String

车牌信息有效期的终止时yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

barrierId

String

道闸Id

示例

{
  "code": 200,
  "message": null,
  "data": {
    "plateNumber": "浙A54321",
    "expiryDate": "2019-06-03 17:53:04",
    "effectiveDate": "2019-06-03 17:53:04",
    "barrierId": "xxx"
  }
}

6.3 车辆对道闸权限修改

说明:

车辆对哪些道闸具有权限

定义

path

版本

是否需要登录

/vehicleBarrierPermissionUpdate

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

plateNumber

String

车牌号

effectiveDate

String

车牌信息有效期的开始yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

expiryDate

String

车牌信息有效期的终止yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

示例

{
  "parkingLotId":"23849499",
  "plateNumber": "京N12345",
  "effectiveDate": "2019-01-01 00:00:00",
  "expiryDate": "2020-01-01 00:00:00"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{
  "code": 200,
  "data":null,
  "message": null
}

6.4 车辆对道闸权限删除

定义

path

版本

是否需要登录

/vehicleBarrierPermissionDelete

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

plateNumber

String

车牌号

barrierId

String

道闸Id

示例

{
  "parkingLotId":"26374898",
  "plateNumber": "京N12345",
  "barrierId": "xxx"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{
  "code": 200,
  "data":"",
  "message": null
}

6.5 车辆对区域授权

1、对区域下所有设备增加权限

2、权限已存在则更新

3、设备为空返回失败

定义

path

版本

是否需要登录

/vehicleAreaPermissionAdd

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

effectiveDate

String

车牌信息有效期的开始yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

expiryDate

String

车牌信息有效期的终止yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

plateNumber

String

车牌号

areaIds

List

停车区域的列表

示例

{
  "parkingLotId":"6748488",
  "effectiveDate": "2019-01-01 00:00:00",
  "expiryDate": "2020-01-01 00:00:00",
  "plateNumber": "京N12345",
  "areaIds": [
      "xxx",
  ]
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{
  "code": 200,
  "data":null,
  "message": null
}

6.6 车辆对区域权限查询

定义

path

版本

是否需要登录

/vehicleAreaPermissionGet

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

plateNumber

String

车牌号

示例

{
  "parkingLotId":"6748488",
  "plateNumber": "京N12345"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

VehiclePermissionDTO

车辆权限信息

VehiclePermissionDTO

字段

类型

备注

plateNumber

String

车牌号

effectiveDate

String

车牌信息有效期的开始时间yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

expiryDate

String

车牌信息有效期的终止时yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

areaId

String

区域Id

示例

{
  "code": 200,
  "message": null,
  "data": {
    "plateNumber": "浙A54321",
    "expiryDate": "2019-06-03 17:53:04",
    "effectiveDate": "2019-06-03 17:53:04",
    "areaId": "xxx"
  }
}

6.7 车辆对区域权限修改

定义

path

版本

是否需要登录

/vehicleAreaPermissionUpdate

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

plateNumber

String

车牌号

effectiveDate

String

车牌信息有效期的开始yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

expiryDate

String

车牌信息有效期的终止yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

示例

{
  "parkingLotId":"6748488",
  "plateNumber": "京N12345",
  "effectiveDate": "2019-01-01 00:00:00",
  "expiryDate": "2020-01-01 00:00:00"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{
  "code": 200,
  "data":null,
  "message": null
}

6.8 车辆对区域权限删除

定义

path

版本

是否需要登录

/vehicleAreaPermissionDelete

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

plateNumber

String

车牌号

areaId

String

区域Id

示例

{
  "parkingLotId":"6748488",
  "plateNumber": "京N12345",
  "areaId": "xxx"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{
  "code": 200,
  "data":"",
  "message": null,
  "localizedMsg": null
}

6.9 停车区域车辆权限列表查询

定义

path

版本

是否需要登录

/vehicleListAreaPermissionGet

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场Id

areaId

String

区域Id,不传代表全部区域

pageNum

Integer

分页查询,当前页数从1开始

pageSize

Integer

分页查询,每页显示条数20条

示例

{
   "parkingLotId": "xxx",
    "areaId": "xxx",
    "pageNum":20,
   "pageSize":20
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

List

车辆权限信息

VehiclePermissionDTO

字段

类型

备注

plateNumber

String

车牌号

effectiveDate

String

车牌信息有效期的开始时间yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

expiryDate

String

车牌信息有效期的终止时间yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

parkingLotId

String

车场Id

areaId

String

区域Id

示例

{
  "code": 200,
  "message": null,
  "data": [{
    "expiryDate": "2019-06-03 17:53:04",
    "effectiveDate": "2019-06-03 17:53:04",
    "plateNumber": "浙A54321",
    "parkingLotId": "xxx",
    "areaId":"xxx"
  },{
    "expiryDate": "2019-06-03 17:53:04",
    "effectiveDate": "2020-06-03 17:53:04",
    "plateNumber": "京A54321",
    "parkingLotId": "xxx",
    "areaId":"xxx"
  }]
}

6.10 停车道闸车辆权限列表查询

定义

path

版本

是否需要登录

/vehicleBarrierPermissionInfoGet

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场Id

barrierId

String

道闸Id,不传代表全部区域

pageNum

Integer

分页查询,当前页数从1开始

pageSize

Integer

分页查询,每页显示条数20条

示例

{
   "parkingLotId": "xxx",
    "barrierId": "xxx",
    "pageNum":20,
   "pageSize":20
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

List

车辆权限信息

VehiclePermissionDTO

字段

类型

备注

plateNumber

String

车牌号

effectiveDate

String

车牌信息有效期的开始时间yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

expiryDate

String

车牌信息有效期的终止时间yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

parkingLotId

String

车场Id

barrierId

String

道闸Id

示例

{
  "code": 200,
  "message": null,
  "data": [{
    "expiryDate": "2019-06-03 17:53:04",
    "effectiveDate": "2019-06-03 17:53:04",
    "plateNumber": "浙A54321",
    "parkingLotId": "xxx",
    "barrierId":"xxx"
  },{
    "expiryDate": "2019-06-03 17:53:04",
    "effectiveDate": "2020-06-03 17:53:04",
    "plateNumber": "京A54321",
    "parkingLotId": "xxx",
    "barrierId":"xxx"
  }]
}

7 黑白名单

7.1 车辆加入安全黑/白名单

定义

path

版本

是否需要登录

/parkingLotVehicleListAdd

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

plateNumber

List

车牌号

areaId

List

区域Id

type

String

WHITELIST/BLACKLIST

白/黑名单

effectiveDate

String

黑白名单有效期的开始时间yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

expiryDate

String

黑白名单有效期的终止时间yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

示例

{
  "parkingLotId":"6748488",
  "plateNumber": [
    plateNumber1
  ],
  "areaId": [
    "xxx"
  ],
  "type": "WHITELIST",
  "effectiveDate":"2019-01-01 00:00:00",
  "expiryDate":"2020-01-01 00:00:00"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{
  "code": 200,
  "message": null
}

7.2 车辆从黑/白名单移除

定义

path

版本

是否需要登录

/parkingLotVehicleListRemove

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

plateNumber

String

车牌号

areaId

List

区域Id

示例

{
  "parkingLotId":"6748488",
  "plateNumber": "京N12345",
  "areaId": [
    "xxx",
  ],
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{
  "code": 200,
  "data":null,
  "message": null
}

7.3 车辆属于黑/白名单查询

定义

path

版本

是否需要登录

/parkingLotVehicleInListGet

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

plateNumber

String

车牌号

areaId

String

区域Id

示例

{
  "parkingLotId":"6748488",
  "plateNumber": "京N12345",
  "areaId": "xxx"
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

VehicleSecurityDTO

车辆权限信息

VehiclePermissionDTO

字段

类型

备注

plateNumber

String

车牌号

areaId

String

区域Id

type

String

whitelist 白名单

blacklist 黑名单

effectiveDate

String

黑白名单有效期的开始时间yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

expiryDate

String

黑白名单有效期的终止时间yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

示例

{
  "code": 200,
  "message": null,
  "data": {
    "plateNumber": "浙A54321",
    "areaId": "xxx",
    "type": "whitelist",
    "effectiveDate":"2019-01-01 00:00:00",
    "expiryDate":"2021-12-31 23:59:59"
  }
}

7.4 分页查询黑/白名单车辆

定义

path

版本

是否需要登录

/parkingLotVehicleListGet

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

pageNum

Integer

分页查询,当前页数从1开始

pageSize

Integer

分页查询,每页显示条数20条

areaId

String

区域Id

type

String

whitelist 白名单

blacklist 黑名单

示例

{
  "parkingLotId":"6748488",
  "areaId": "xxx",
  "type": "blacklist",
  "pageNum":20,
  "pageSize":20
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

data

List

车辆权限信息

VehicleSecurityDTO

字段

类型

备注

plateNumber

String

车牌号

areaId

String

区域空间Id

type

String

whitelist 白名单

blacklist 黑名单

effectiveDate

String

黑白名单有效期的开始时间yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

expiryDate

String

黑白名单有效期的终止时间yyyy-MM-dd HH:mm:ss 或 yyyy/MM/dd HH:mm:ss 等标准事件格式

示例

{
  "code": 200,
  "message": null,
  "localizedMsg": null,
  "data": [{
    "plateNumber": "浙A54321",
    "type": "whitelist",
    "areaId": "xxx",
    "effectiveDate":"2019-01-01 00:00:00",
    "expiryDate":"2021-12-31 23:59:59"
  },{
    "plateNumber": "京A54321",
    "type": "blacklist",
    "areaId": "xxx",
    "effectiveDate":"2019-01-01 00:00:00",
    "expiryDate":"2021-12-31 23:59:59"
  }]
}

8 订单系统

8.1 新增车辆订单

定义

path

版本

是否需要登录

/parkingLotVehicleOrderAdd

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

plateNumber

String

车牌号

inBarrierGateId

String

入场道闸Id

inTime

String-utc

入场时间

payStatus

Integer

支付结果:

0 - 支付完成

4 - 未支付

outBarrierGateId

String

出场道闸Id,场内支付则为空

outTime

String-utc

出场时间,场内支付则为空

示例

{
  "parkingLotId":"6748488",
  "plateNumber": "京N12345",
  "outBarrierGateId": "xxx",
  "inTime": "2020-01-02 00:00:00",
  "outBarrierGateId": "xxx",
  "outTIme": "2020-01-02 00:00:00",
  "orderStatus": 0
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{
  "code": 200,
  "message": null,
  "data":null
}

8.2 确认车辆订单

定义

path

版本

是否需要登录

/parkingLotVehicleOrderCompleted

1.0.0

入参

字段

类型

是否必传

备注

parkingLotId

String

停车场ID

areaId

String

停车区域Id

orderNumber

String

订单号

payStatus

Integer

支付结果:0 - 支付完成1 - 免费2 - 本地支付3 - 取消订单

示例

{
  "parkingLotId":"6748488",
  "orderNumber": "O4jRKfKLzpGWX4p4dcpZ000101",
  "areaId": "xxx",
  "payStatus": 1
}

出参

字段

类型

备注

code

Integer

返回码

message

String

返回信息

示例

{
  "code": 200,
  "data":null,
  "message": null
}

9 错误码定义

结果码

结果说明

0

成功

success

101

不存在停车场

There is no ParkingLot

102

停车场ID不存在

ParkingLot ID does not exist

103

订单号不存在

Order number does not exist

200

成功

success

200

车辆加入名单成功

Vehicle added to list successfully

200

车辆预约成功

Vehicle reservation successful

201

不存在停车区域

There is no Parking Area

202

停车区域ID不存在

Parking Area ID does not exist

301

不存在停车道闸

There is no Parking Barrier

302

停车道闸ID不存在

Parking Barrier ID does not exist

403

操作道闸失败

Barrier operation failed

401

不存在停车位

There is no Parking space

402

停车位ID不存在

Parking space ID does not exist

501

不存在车辆列表

There is no plate number list

502

车牌号不存在

Plate Number does not exist

503

车辆未锁定

The vehicle is not locked

504

停车场已存在该车辆

There is this vehicle in the parking lot already

601

通行事件ID不存在

Park Recorder ID does not exist

602

用户名不存在

User name does not exist

603

车辆权限不存在

There is no permission for this vehicle

604

该区域没有授权车辆列表

There is no vehicle permission list in the area

605

该道闸没有授权车辆列表

There is no vehicle permission list in the parking barrier

606

时间格式不正确

Date format error

607

起始时间晚于结束时间

EffectiveDate is later than expiryDate

701

车辆不在黑白名单里

There is no this vehicle in whitelist or blacklist

702

车辆已存在黑白名单中

There is this vehicle in whitelist or blacklist already

1000

未知错误

Unknown error

1001

请求忙

Timeout error

1002

请求参数无效

Input parameter is invalid

1003

道闸状态异常

Parking barrier is in abnormal status.

1004

设备不在线

Device is offline

  • 本页导读 (0)