停车场服务API手册

更新时间：2019-07-24 10:47:09

使用说明

停车管理使用文档

关于API的


接口文档

接口以阿里云IoT统一网关HTTP接口的形式提供，使用方法参考API网关客户端。
访问域名：api.link.aliyun.com，接口协议：HTTPS。

1. 停车场

1.1 创建停车场空间

停车场是整个系统的基本单元，停车业务初始工作就是创建停车场

定义

path 版本 是否需要登录
/parking/paas/edge/park/add 2.0.0 否

入参

字段 类型 是否必传 备注
gatewayProductKey String 如不传gatewayIotId，此处必填 边缘网关设备的productKey
gatewayDeviceName String 如不传gatewayIotId，此处必填 边缘网关设备的deviceName
gatewayIotId String 如不传gatewayProductKey和gatewayDeviceName，此处必填 边缘网关的iotId，
productKey String 是 停车场的ProductKey
deviceName String 是 停车场的deviceName
name String 是 停车场的别名。支持中文、英文、数字、下划线，4-32个字符。

示例

{
  "gatewayProductKey": "xxxxxxxx",
  "gatewayDeviceName": "xxxxxxxx",
  "productKey": "xxxxxxxx",
  "deviceName":"xxxxxxxxx",
  "name": "小区停车场"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data String 停车场的空间id

示例

{
  "code": 200,
  "data": "a34d9b3ld93lb",
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "message": null,
  "localizedMsg": null
}

1.2 删除停车场空间

删除停车场的时候，关联到这个停车场的停车区域、道闸、车位、车辆信息也会一起删除。

定义

path 版本 是否需要登录
/parking/paas/edge/park/delete 2.0.0 否

入参

字段 类型 是否必传 备注
spaceId String 是 停车场的spaceId，创建停车场的时候获取

示例

{
   "spaceId": "a34d9b3ld93lb"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":null,
  "message": null,
  "localizedMsg": null
}

1.3 修改停车场名称

定义

path 版本 是否需要登录
/parking/paas/edge/park/update 2.0.0 否

入参

字段 类型 是否必传 备注
spaceId String 是 停车场的spaceId，创建停车场的时候获取
name String 是 支持中文、英文、数字、下划线，4-32个字符。不填不更新。

示例

{
   "spaceId": "a34d9b3ld93lb",
   "name":"小区备用停车场"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":null,
  "message": null,
  "localizedMsg": null
}

1.4 查询停车场信息

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

定义

path 版本 是否需要登录
/parking/paas/edge/park/get 2.0.0 否

入参

字段 类型 是否必传 备注
spaceId String 是 停车场的spaceId，创建停车场的时候获取

示例

{
   "spaceId": "a34d9b3ld93lb"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data Object 停车场信息

MainParkInfoDTO对象

字段 类型 备注
name String 停车场名称
spaceId String 停车场空间id
unParkedCount Integer 空余车位数
lotCount Integer 总车位数

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data": {
      "name":"户外停车场",
    "spaceId":"a34d9b3ld93lb",
    "unParkedCount":302,
    "lotCount":677
  },
  "message": null,
  "localizedMsg": null
}

1.5 查询停车场本地停车区域编码

对接存量停车系统的时候，需要先拉出本地停车区域的ID，用这个ID为停车区域创建空间，做到线上线下打通。本接口就提供停车场停车区域的查询功能

定义

path 版本 是否需要登录
/parking/paas/edge/local/area/url/get 2.0.1 否

入参

字段 类型 是否必传 备注
spaceId String 是 停车场的spaceId，创建停车场的时候获取
type String 是 ROOT 表示查根节点，SUB1表示停车场空间下的第一层级的停车区域

示例

{
   "spaceId": "a34d9b3ld93lb",
   "type":"ROOT"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data String 停车场区域本地编码列表的下载地址

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data": "http://xxxxxxxxxxxxxx",
  "message": null,
  "localizedMsg": null
}

本地编码文件的格式

{
  "AreaList":[
        "area_id_1",
        "area_id_2",
        ...
      ]
}

1.6 查询停车场本地系统中的道闸信息

对接存量停车系统的时候，需要先拉出本地道闸ID，用这个ID创建道闸的空间，做到线上线下打通。本接口就提供停车场道闸的查询功能

定义

path 版本 是否需要登录
/parking/paas/edge/local/toll/url/get 2.0.0 否

入参

字段 类型 是否必传 备注
spaceId String 是 停车场的spaceId，创建停车场的时候获取

示例

{
   "spaceId": "a34d9b3ld93lb"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data String 车闸本地系统信息下载地址

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data": "http://xxxxxxxxxxxxxxxxxx",
  "message": null,
  "localizedMsg": null
}

本地道闸编码文件格式

{
  "BarrierList":[
      {"AreaId": "mmm", "BarrierId": "xxx", "BarriereName": "yyy", "direction": 0/1}, // 0表示进库，1表示出库
      {"AreaId": "mmm", "BarrierId": "xxx", "BarriereName": "yyy", "direction": 0/1},
      {"AreaId": "mmm", "BarrierId": "xxx", "BarriereName": "yyy", "direction": 0/1},
      ...
   ]
}

1.7 停车场的停车区域、车位列表

查询一个停车场内云端创建的停车区域列表、车位列表需要指定父空间id，每次查出来的是父节点匹配条件的所有空间。返回对应空间的spaceId列表

定义

path 版本 是否需要登录
/parking/paas/edge/park/space/query 2.0.0 否

入参

字段 类型 是否必传 备注
parkSpaceId String 是 停车场的spaceId，创建停车场的时候获取
parentSpaceId String 是 父空间id，查询只查指定父空间下一级空间列表
likelyName String 否 支持昵称模糊查询
pageSize Integer 是 分页查询一页内的记录数，上限100
pageNo Integer 是 分页数，从1开始
subSpaceType String 是 AREA停车区域，LOT车位
tag String 否 支持按tag搜索，如不填这个值表示匹配任意tag

示例

{
   "parkSpaceId": "a34d9b3ld93lb",
   "parentSpaceId":"a34d9b3ld93lb",
   "likelyName":"区",
   "pageSize":10,
   "pageNo":1,
   "subSpaceType":"AREA",
   "tag":"gate"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data Object 停车场区域本地编码列表

PageDTO

pageSize Integer 传入的pageSize
pageNo Integer 传入的pageNo
total Long 总记录数
data List 待查的空间列表

SpaceDescriptionDTO

spaceId String 空间id
name String 空间名称

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data": {
          "pageSize":10,
        "pageNo":1,
        "total":2,
      "data":[
        {
            "spaceId":"ade83jkasdf84",
          "name":"a区"
        },{
          "spaceId":"a048ukdaluhdd",
          "name":"b区"
        }
      ]
      }
    },
  "message": null,
  "localizedMsg": null
}

1.8 停车场内的单元添加标签

打标签后可以用标签来检索空间

定义

path 版本 是否需要登录
/parking/paas/edge/tag/add 2.0.0 否

入参

字段 类型 是否必传 备注
parkSpaceId String 是 停车场的spaceId，创建停车场的时候获取
targetSpaceId String 是 待打标签的空间id
subSpaceType String 是 AREA停车区域，LOT车位
tags List 是 待设置的标签列表，最多50个

示例

{
   "parkSpaceId": "a34d9b3ld93lb",
    "targetSpaceId": "a6dosnfme6s3u",
   "subSpaceType":"AREA",
   "tags":[
       "gate"
   ]
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":null,
  "message": null,
  "localizedMsg": null
}

1.9 停车场内的单元删除标签

删除指定标签

定义

path 版本 是否需要登录
/parking/paas/edge/tag/delete 2.0.0 否

入参

字段 类型 是否必传 备注
parkSpaceId String 是 停车场的spaceId，创建停车场的时候获取
targetSpaceId String 是 待删标签的空间id
subSpaceType String 是 AREA停车区域，LOT车位
tags List 是 待删除的标签，最多50个

示例

{
   "parkSpaceId": "a34d9b3ld93lb",
   "targetSpaceId":"a6dosnfme6s3u",
   "subSpaceType":"AREA",
   "tags":[
       "tag1",
       "tag2"
   ]
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":null,
  "message": null,
  "localizedMsg": null
}

1.10 停车场内的单元标签替换

替换标签会把原有标签全部删除

定义

path 版本 是否需要登录
/parking/paas/edge/tag/cover 2.0.0 否

入参

字段 类型 是否必传 备注
parkSpaceId String 是 停车场的spaceId，创建停车场的时候获取
targetSpaceId String 是 待替换标签的空间id
subSpaceType String 是 AREA停车区域，LOT车位
tags List 是 待设置的标签列表，50个

示例

{
   "parkSpaceId": "a34d9b3ld93lb",
   "targetSpaceId":"a6dosnfme6s3u",
   "subSpaceType":"AREA",
   "tags":[
       "gate"
   ]
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":null,
  "message": null,
  "localizedMsg": null
}

1.11 停车场内单元标签查询

定义

path 版本 是否需要登录
/parking/paas/edge/tag/query 2.0.0 否

入参

字段 类型 是否必传 备注
parkSpaceId String 是 停车场的spaceId，创建停车场的时候获取
targetSpaceId String 是 待查询标签的空间id
subSpaceType String 是 AREA停车区域，LOT车位

示例

{
   "parkSpaceId": "a34d9b3ld93lb",
   "targetSpaceId":"alk4895ujdu2",
   "subSpaceType":"AREA"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data List 标签列表

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":[
      "gate"
  ],
  "message": null,
  "localizedMsg": null
}

1.12 租户的停车场列表

返回停车场空间id

定义

path 版本 是否需要登录
/parking/paas/edge/park/query 2.0.0 否

入参

字段 类型 是否必传 备注
pageSize Integer 是 分页查询一页内的记录数，上限100
pageNo Integer 是 分页数，从1开始
likelyName String 否 模糊查询的条件，停车场名称

示例

{
   "pageSize":10,
   "pageNo":1,
   "likelyName":"场"
   ]
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data Object 停车场区域本地编码列表

PageDTO

pageSize Integer 传入的pageSize
pageNo Integer 传入的pageNo
total Long 总记录数
data List 停车场列表

ParkDTO

parkSpaceId String 空间id
name String 停车场的名称

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data": {
          "pageSize":10,
        "pageNo":1,
        "total":1,
      "data":[
        {
            "parkSpaceId":"a34d9b3ld93lb",
          "name":"停车场"
        }
      ]
      }
    },
  "message": null,
  "localizedMsg": null
}

2. 停车区域

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

2.1 为停车区域创建空间

定义

path 版本 是否需要登录
/parking/paas/edge/area/add 2.0.0 否

入参

字段 类型 是否必传 备注
productKey String 是 停车区域的ProductKey
deviceName String 是 停车区域的DeviceName
name String 是 支持中文、英文、数字、下划线，4-32个字符
parkSpaceId String 是 停车场的空间id
parentSpaceId String 是 上层空间spaceId
areaId String 是 停车区域的本地编码

示例

{
  "productKey": "xxxxxxxx",
  "deviceName": "xxxxxxx",
  "name": "B区",
  "parkSpaceId":"ad83mfisdnf3",
  "parentSpaceId":"ad83mfisdnf3",
  "areaId":"area1"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data String 停车区域的空间id

示例

{
  "code": 200,
  "data": "d4d984jdlafjek",
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "message": null,
  "localizedMsg": null
}

2.2 停车区域空间删除

删除停车区域的时候，关联到这个停车区域的道闸、车位也会一起删除。

定义

path 版本 是否需要登录
/parking/paas/edge/area/delete 2.0.0 否

入参

字段 类型 是否必传 备注
areaSpaceId String 是 停车区域的spaceId，创建停车区域的时候获取

示例

{
   "areaSpaceId": "d4d984jdlafjek"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "data": null,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "message": null,
  "localizedMsg": null
}

2.3 修改停车区域名称

定义

path 版本 是否需要登录
/parking/paas/edge/area/update 2.0.0 否

入参

字段 类型 是否必传 备注
areaSpaceId String 是 停车区域的spaceId，创建停车区域的时候获取
name String 是 支持中文、英文、数字、下划线，4-32个字符

示例

{
   "areaSpaceId": "d4d984jdlafjek",
   "name":"a区"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":null,
  "message": null,
  "localizedMsg": null
}

2.4 查询停车区域信息

停车区域信息包含停车区域名称、空间id、车位总数量、车位空位数量、本地系统中区域ID、本地系统中父级ID、本地系统中子区域ID列表、空余车位数、总车位数等。

定义

path 版本 是否需要登录
/parking/paas/edge/area/get 2.0.0 否

入参

字段 类型 是否必传 备注
areaSpaceId String 是 停车区域的spaceId，创建停车区域的时候获取

示例

{
   "areaSpaceId": "d4d984jdlafjek"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data Object 停车场信息

AreaDTO

spaceId String 停车区域的空间id
parkSpaceId String 停车场空间id
parentSpaceId String 上层空间id
name String 停车区域名称
areaId String 本地系统id
parentId String 上层空间本地id
subLocalSpaceIdsUrl String 下一层区域id（本地系统的区域id）列表的下载地址
unParkedCount Integer 空余车位数
lotCount Integer 总车位数

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data": {
    "spaceId":"d4d984jdlafjek",
    "parkSpaceId":"a34d9b3ld93lb",
    "parentSpaceId":"a34d9b3ld93lb",
    "iotId":"dasfei7daso9f84uoi",
    "productKey":"ad3ansdfi",
    "deviceName":"000d475i000",
    "name":"区域a",
    "areaId":"area1",
    "parentId":"00001",
    "subLocalSpaceIdsUrl":"http://xxxxx",
    "unParkedCount":30,
    "lotCount":67
  },
  "message": null,
  "localizedMsg": null
}

停车区域本地空间id列表文件格式

{
  "SubAreaList":[
    "SubAreaId_1",
    "SubAreaId_2",
    "SubAreaId_3",
    ...
  ]
}

2.5 查询区域下的道闸列表

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

定义

path 版本 是否需要登录
/parking/paas/area/toll/query 2.0.0 否

入参

字段 类型 是否必传 备注
areaSpaceId String 是 停车区域的spaceId
pageSize Integer 是 分页查询一页内的记录数，上限100
pageNo Integer 是 分页数，从1开始

示例

{
   "areaSpaceId": "d4d984jdlafjek",
   "pageSize": 10,
   "pageNo":1
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data Object 返回的分页数据对象

PageDTO

pageSize Integer 传入的pageSize
pageNo Integer 传入的pageNo
total Long 总记录数
data List 车闸对象列表

TollDTO

productKey String 车闸的pk
deviceName String 车闸的dn
iotId String 车闸的iotId

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data": {
    "pageSize":10,
    "pageNo":1,
    "total":1,
    "data":[
      {
          "procuctKey":"xxxxxxx",
        "deviceName":"xxxxxx",
        "iotId":"xxxxxx"
      }
    ]
  },
  "message": null,
  "localizedMsg": null
}

2.6 查询区域车位的本地编码列表

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

定义

path 版本 是否需要登录
/parking/paas/edge/area/local/lot/query 2.0.0 否

入参

字段 类型 是否必传 备注
areaSpaceId String 是 停车区域的spaceId，创建停车区域的时候获取

示例

{
   "areaSpaceId": "d4d984jdlafjek"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data String 停车区域中车位的本地编码列表的下载地址

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data": [
      "lot1",
    "lot2"
  ],
  "message": null,
  "localizedMsg": null
}

停车区域中车位的本地编码列表文件格式

{
  "ParkingSpaceList":[
          "parkingSpaceId_1",
          "parkingSpaceId_2",
            ...
    ]
}

3. 道闸

3.1 绑定道闸到空间

道闸只能绑定到停车区域

定义

path 版本 是否需要登录
/parking/paas/edge/toll/bind 2.0.0 否

入参

字段 类型 是否必传 备注
productKey String 是 道闸的ProductKey
deviceName String 是 道闸的DeviceName
spaceId String 是 道闸需要绑定到的目标空间的空间spaceId
direction String 是 IN表示进场道闸，OUT表示出场道闸
tollId String 是 道闸本地id

示例

{
  "productKey": "xxxxxxxx",
  "deviceName": "xxxxxxxxx",
  "spaceId":"ad83mfisdnf3",
  "direction":"IN",
  "tollId":"toll1"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data String 道闸的iotId

示例

{
  "code": 200,
  "data": "edmeuj820984u90",
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "message": null,
  "localizedMsg": null
}

3.2 解除道闸绑定的空间

定义

path 版本 是否需要登录
/parking/paas/edge/toll/unbind 2.0.0 否

入参

字段 类型 是否必传 备注
productKey String 是 道闸的ProductKey
deviceName String 是 道闸的DeviceName

示例

{
   "productKey": "aja4uasodf",
   "deviceName": "edmeuj820984u90"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "data": null,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "message": null,
  "localizedMsg": null
}

3.3 更新道闸属性

定义

path 版本 是否需要登录
/parking/paas/edge/toll/update 2.0.0 否

入参

字段 类型 是否必传 备注
productKey String 是 道闸的ProductKey
deviceName String 是 道闸的DeviceName
direction String 是 IN表示进场道闸，OUT表示出场道闸。不填不会更新这个属性。

示例

{
   "productKey": "aja4uasodf",
   "deviceName": "edmeuj820984u90",
   "direction":"IN"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "data": null,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "message": null,
  "localizedMsg": null
}

3.4 查询道闸信息

定义

path 版本 是否需要登录
/parking/paas/edge/toll/get 2.0.0 否

入参

字段 类型 是否必传 备注
productKey String 是 道闸的ProductKey
deviceName String 是 道闸的DeviceName

示例

{
   "tollIotId": "edmeuj820984u90"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data Object 道闸的信息

TollDTO

productKey String 道闸的ProductKey
deviceName String 道闸的DeviceName
iotId String 道闸的iotId
parkSpaceId String 停车场空间id
spaceId String 道闸所属空间id
tollId String 道闸在本地系统的id
status String OPEN道闸打开，CLOSE道闸关闭
direction String IN表示进场道闸，OUT表示出场道闸。不填不会更新这个属性。

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data": {
    "productKey":"ada470aduf",
    "deviceName":"0000347i0000",
    "iotId":"edmeuj820984u90",
    "parkSpaceId":"a34d9b3ld93lb",
    "spaceId":"34d9b3ld93lb",
    "tollId":"toll1",
    "status":"CLOSE",
    "direction":"IN"
  },
  "message": null,
  "localizedMsg": null
}

3.5 手动打开道闸栏杆

定义

path 版本 是否需要登录
/cloud/thing/properties/set 2.0.0 否

入参

字段 类型 是否必传 备注
tollIotId String 是 道闸的iotId，创建道闸的时候获取
items Object 是 固定值
{
"BarrierState":1
}

示例

{
  "iotId":"ne8dksa3nf3la5nfke",
  "items":{
      "BarrierState":1
  }
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":null,
  "message": null,
  "localizedMsg": null
}

4. 停车位

4.1 为停车位绑定空间

定义

path 版本 是否需要登录
/parking/paas/edge/lot/add 2.0.0 否

入参

字段 类型 是否必传 备注
productKey String 是 车位的ProductKey
deviceName String 是 车位的deviceName
name String 是 支持中文、英文、数字、下划线，4-32个字符，一个中文算2个字符
lotId String 是 车位的本地编号
parkSpaceId String 是 停车场空间id
parentSpaceId String 是 上层空间spaceId
type String 是 车位类型：PRIVATE私人车位、PUBLIC公共车位、CONSUME消费车位、GUEST访客车位、SELFDEFINED自定义
isSold Boolean 是 ture 已售，false未售
property String 否 GUARD人防，NOGUARD非人防
ownerPhone String 否 产权人手机号
ownerName String 否 产权人姓名，长度64字符
ownerId String 否 产权人证件号

示例

{
  "productKey": "ad8sdlfd",
  "deviceName":"00004hsjdkfl00",
  "name": "A位",
  "parkSpaceId":"sd47ojaisdfn",
  "parentSpaceId":"ad83mfisdnf3",
  "lotId":"lotA",
  "type":"PRIVATE",
  "isSold":false
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data String 车位的空间id

示例

{
  "code": 200,
  "data": "vnidalwed746aosd",
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "message": null,
  "localizedMsg": null
}

4.2 停车位和空间解绑

定义

path 版本 是否需要登录
/parking/paas/edge/lot/delete 2.0.0 否

入参

字段 类型 是否必传 备注
lotSpaceId String 是 车位的spaceId，创建车位的时候获取

示例

{
   "lotSpaceId": "vnidalwed746aosd"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "data": null,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "message": null,
  "localizedMsg": null
}

4.3 更新停车位

定义

path 版本 是否需要登录
/parking/paas/edge/lot/update 2.0.0 否

入参

字段 类型 是否必传 备注
lotSpaceId String 是 车位的spaceId，创建车位的时候获取
name String 否 昵称，不传不更新
type String 否 车位类型：PRIVATE私人车位、PUBLIC公共车位、CONSUME消费车位、GUEST访客车位、SELFDEFINED自定义。不填不更新。
isSold Boolean 否 true 已售，false未售
property String 否 GUARD人防，NOGUARD非人防。不填不更新。
ownerPhone String 否 产权人手机号。不填不更新。
ownerName String 否 产权人姓名，长度64字符。不填不更新。
ownerId String 否 产权人证件号。不填不更新。

示例

{
  "productKey": "ad8sdlfd",
  "deviceName":"00004hsjdkfl00",
  "name": "A位",
  "parkSpaceId":"sd47ojaisdfn",
  "parentSpaceId":"ad83mfisdnf3",
  "lotId":"lotA",
  "type":"PRIVATE",
  "isSold":false
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "data": null,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "message": null,
  "localizedMsg": null
}

4.4 查询车位信息

定义

path 版本 是否需要登录
/parking/paas/edge/lot/get 2.0.0 否

入参

字段 类型 是否必传 备注
lotSpaceId String 是 车位的spaceId，创建车位的时候获取

示例

{
   "lotSpaceId": "vnidalwed746aosd"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data Object 车位信息

LotDTO

lotSpaceId String 车位的空间id
parkSpaceId String 停车场空间id
parentSpaceId String 上层空间id
name String 车位名称
type String 车位类型：PRIVATE私人车位、PUBLIC公共车位、CONSUME消费车位、GUEST访客车位、SELFDEFINED自定义。
isSold Boolean ture 已售，false未售
property String GUARD人防，NOGUARD非人防。
ownerPhone String 产权人手机号。
ownerName String 产权人姓名，长度64字符。
ownerId String 产权人证件号。
isParking Boolean true有车在停泊，false无车
licenseNumber String 停泊车的车牌号

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data": {
    "lotSpaceId":"vnidalwed746aosd",
    "parkSpaceId":"a34d9b3ld93lb",
    "parentSpaceId":"a34d9b3ld93lb",
    "iotId":"ne8dksa3nf3la5nfke",
    "type":"PRIVATE",
    "name":"A位",
    "lotId":"lotA",
    "isSold":true,
    "property":"GUARD",
    "ownerPhone":"132xxxxxx00",
    "ownerName":"老王",
    "ownerId":"1000xxxxxxxx0011",
    "isParking":ture,
    "licenseNumber":"京N TR669"
  },
  "message": null,
  "localizedMsg": null
}

5. 车辆管理

5.1 添加车辆

定义

path 版本 是否需要登录
/parking/paas/user/vehicle/add 2.0.0 否

入参

字段 类型 是否必传 备注
parkSpaceId String 是 停车场的spaceId，创建停车场时的id
userName String 是 用于显示的车主名字
userPhone String 是 车主联系电话
userId String 是 车主证件号
identityId String 是 车主统一身份ID
licenseNumber String 是 车牌号
lockEffectiveDate String 否 锁车的开始时间，时间格式 yyyy-MM-dd HH:mm:ss"。lockEffectiveDate和lockExpiredDate需要同时传。
lockExpiredDate String 否 锁车的结束时间，时间格式 yyyy-MM-dd HH:mm:ss"。lockEffectiveDate和lockExpiredDate
需要同时传。

示例

{
  "parkSpaceId": "d4d984jdlafjek",
  "userName": "王生",
  "userPhone":"13888888888",
  "userId":"10xxxxxxxxxxxx9876X",
  "identityId":"5047xxxxxxxxxxxx94",
  "licenseNumber":"京N TR666",
  "lockEffectiveDate":"2019-01-01 00:00:00",
  "lockExpiredDate":"2021-12-31 23:59:59"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":null,
  "message": null,
  "localizedMsg": null
}

5.2 删除车辆

定义

path 版本 是否需要登录
/parking/paas/user/vehicle/delete 2.0.0 否

入参

字段 类型 是否必传 备注
parkSpaceId String 是 停车场的spaceId，创建停车场时的id
licenseNumber String 是 车牌号

示例

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

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":null,
  "message": null,
  "localizedMsg": null
}

5.3 更新车辆信息

定义

path 版本 是否需要登录
/parking/paas/user/vehicle/update 2.0.0 否

入参

字段 类型 是否必传 备注
parkSpaceId String 是 停车场的spaceId，创建停车场时的id
licenseNumber String 是 车牌号
userName String 否 车主名字，不传不修改
userPhone String 否 车主联系电话，不传不修改
userId String 否 车主证件号，不传不修改
identityId String 否 车主统一身份ID,不传不修改
lockEffectiveDate String 否 锁车的开始时间，时间格式 yyyy-MM-dd HH:mm:ss",不传不修改。lockEffectiveDate和lockExpiredDate需要同时传。
lockExpiredDate String 否 锁车的结束时间，时间格式 yyyy-MM-dd HH:mm:ss"，不传不修改。lockEffectiveDate和lockExpiredDate需要同时传。

示例

{
  "parkSpaceId": "d4d984jdlafjek",
  "userName": "王生",
  "userPhone":"13888888888",
  "userId":"10xxxxxxxxxxxx9876X",
  "licenseNumber":"京N TR666",
  "lockEffectiveDate":"2019-01-01 00:00:00",
  "lockExpiryDate":"2021-12-31 23:59:59"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":null,
  "message": null,
  "localizedMsg": null
}

5.4 停车场内的车辆列表下载地址

返回车牌号的下载地址

定义

path 版本 是否需要登录
/parking/paas/park/vehicle/url/get 2.0.0 否

入参

字段 类型 是否必传 备注
parkSpaceId String 是 停车场的spaceId，创建停车场时的id

示例

{
  "parkSpaceId": "d4d984jdlafjek"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data String 车牌列表的下载地址

车牌列表下载下来的文件格式

{
  "PlateNumberList":[
      "浙A5566"，
      "浙A5567"，
      "浙A5568"，
      ...
    ]
}

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data": "http://xxxxxxxx",
  "message": null,
  "localizedMsg": null
}

5.5查询停车场的车辆信息

定义

path 版本 是否需要登录
/parking/paas/vehicle/get 2.0.0 否

入参

字段 类型 是否必传 备注
parkSpaceId String 是 停车场的spaceId，创建停车场时的id
licenseNumber String 是 车牌号

示例

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

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data Object 车辆信息

VehicleDTO

字段 类型 备注
parkSpaceId String 停车场的spaceId，创建车位的时候获取
userName String 车主名字，不传不修改
userPhone String 车主联系电话，不传不修改
userId String 车主证件号，不传不修改
licenseNumber String 车牌号
lotSpaceId String 停泊的车位空间id
lockEffectiveDate String 锁车的开始时间，时间格式 yyyy-MM-dd HH:mm:ss"
lockExpiredDate String 锁车的结束时间，时间格式 yyyy-MM-dd HH:mm:ss"

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":{
      "parkSpaceId": "d4d984jdlafjek",
      "userName": "王生",
      "userPhone":"13888888888",
      "userId":"10xxxxxxxxxxxx9876X",
    "identityId":"509xxxxxxxxxxxx480",
      "licenseNumber":"京N TR666",
    "lotSpaceId":"vnidalwed746aosd",
    "lockEffectiveDate":"2019-01-01 00:00:00",
    "lockExpiryDate":"2021-12-31 23:59:59",
    "tags":"主车"
  },
  "message": null,
  "localizedMsg": null
}

6 车辆权限

6.1 车辆对道闸授权

说明：
如权限已存在，则更新权限
定义

path 版本 是否需要登录
/parking/paas/edge/vehicle/iot/permission/add 2.0.0 否

入参

字段 类型 是否必传 备注
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 是 车牌号
iotIds List 是 道闸iotId列表

示例

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

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":null,
  "message": null,
  "localizedMsg": null
}

6.2 车辆对空间区域授权

说明：
1、对空间下所有设备iotId增加权限
2、权限已存在则更新
3、设备为空返回失败
定义

path 版本 是否需要登录
/parking/paas/edge/vehicle/space/permission/add 2.0.0 否

入参

字段 类型 是否必传 备注
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 是 车牌号
spaceIds List 是 停车区域的spaceId列表

示例

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

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":null,
  "message": null,
  "localizedMsg": null
}

6.3 车辆权限查询

定义

path 版本 是否需要登录
/parking/paas/edge/vehicle/permission/get 2.0.0 否

入参

字段 类型 是否必传 备注
plateNumber String 是 车牌号
iotId String 是 道闸Id

示例

{
  "plateNumber": "京N12345",
  "iotId": "xxx"
}

出参

字段 类型 备注
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 等标准事件格式
iotId String 道闸Id

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "message": null,
  "localizedMsg": null,
  "data": {
    "expiryDate": "2019-06-03 17:53:04",
    "effectiveDate": "2019-06-03 17:53:04",
    "plateNumber": "浙A54321",
    "iotId": "xxx"
  }
}

6.4 车辆权限修改

说明：
1、基于iotId修改权限，权限不存在返回失败
2、基于空间修改权限，空间下设备权限为空返回失败
3、基于空间修改权限，对空间下已有权限批量修改
定义

path 版本 是否需要登录
/parking/paas/edge/vehicle/permission/update 2.0.0 否

入参

字段 类型 是否必传 备注
plateNumber String 是 车牌号
spaceId String 是，spaceId 与 iotId必须有一个不为空，且不能同时存在 空间Id
iotId String 是，spaceId 与 iotId必须有一个不为空，且不能同时存在 道闸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": "京N12345",
  "iotId": "xxx",
  "effectiveDate": "2019-01-01 00:00:00",
  "expiryDate": "2020-01-01 00:00:00"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":null,
  "message": null,
  "localizedMsg": null
}

6.5 车辆权限删除

说明：
1、基于iotId删除权限，权限不存在返回失败
2、基于空间删除权限，空间下设备权限为空返回失败
3、基于空间删除权限，对空间下已有权限批量删除
定义

path 版本 是否需要登录
/parking/paas/edge/vehicle/permission/delete 2.0.0 是

入参

字段 类型 是否必传 备注
plateNumber String 是 车牌号
spaceId String 是，spaceId 与 iotId必须有一个不为空，且不能同时存在 空间Id
iotId String 是，spaceId 与 iotId必须有一个不为空，且不能同时存在 道闸Id

示例

{
  "plateNumber": "京N12345",
  "iotId": "xxx"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

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

6.6 停车区域/道闸 车辆权限列表

定义

path 版本 是否需要登录
/parking/paas/edge/vehicle/permission/query 2.0.0 否

入参

字段 类型 是否必传 备注
spaceId String 是，spaceId 与 iotId必须有一个不为空，且不能同时存在 空间Id
iotId String 是，spaceId 与 iotId必须有一个不为空，且不能同时存在 道闸Id

示例

{
  "iotId": "xxx"
}

出参

字段 类型 备注
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 等标准事件格式
spaceId String 空间Id
iotId String 道闸Id

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "message": null,
  "localizedMsg": null,
  "data": [{
    "expiryDate": "2019-06-03 17:53:04",
    "effectiveDate": "2019-06-03 17:53:04",
    "plateNumber": "浙A54321",
    "spaceId": "xxx"
  },{
    "expiryDate": "2019-06-03 17:53:04",
    "effectiveDate": "2020-06-03 17:53:04",
    "plateNumber": "京A54321",
    "spaceId": "xxx"
  }]
}

7 黑白名单

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

定义

path 版本 是否需要登录
/parking/paas/edge/vehicle/special/concerns/add 2.0.0 否

入参

字段 类型 是否必传 备注
plateNumber String 是 车牌号
spaceId String 是 区域空间Id
type String 是 WHITELIST/BLACKLIST

示例

{
  "plateNumber": "京N12345",
  "spaceId": "xxx",
  "type": "WHITELIST"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data String 安全名单id

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":"a34d9b3ld93lb",
  "message": null,
  "localizedMsg": null
}

7.2 车辆从黑/白名单移除

定义

path 版本 是否需要登录
/parking/paas/edge/vehicle/special/concerns/remove 2.0.0 否

入参

字段 类型 是否必传 备注
plateNumber String 是 车牌号
spaceId String 是 区域空间Id

示例

{
  "licenseNumber": "京N12345",
  "spaceId": "xxx"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":null,
  "message": null,
  "localizedMsg": null
}

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

定义

path 版本 是否需要登录
/parking/paas/edge/vehicle/special/concerns/get 2.0.0 否

入参

字段 类型 是否必传 备注
plateNumber String 是 车牌号
spaceId String 是 区域空间Id

示例

{
  "plateNumber": "京N12345",
  "spaceId": "xxx"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data VehicleSecurityDTO 车辆权限信息

VehiclePermissionDTO

字段 类型 备注
plateNumber String 车牌号
spaceId String 区域空间Id
type String WHITELIST/BLACKLIST

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "message": null,
  "localizedMsg": null,
  "data": {
    "plateNumber": "浙A54321",
    "spaceId": "xxx",
    "type": "WHITELIST"
  }
}

7.4 黑/白名单车辆查询

定义

path 版本 是否需要登录
/parking/paas/edge/vehicle/special/concerns/query 2.0.0 否

入参

字段 类型 是否必传 备注
spaceId String 是 区域空间Id
type String 否 WHITELIST/BLACKLIST

示例

{
  "spaceId": "xxx",
  "type": "BLACKLIST"
}

出参

字段 类型 备注
code Integer 返回码
message String 返回信息
data List 车辆权限信息

VehicleSecurityDTO

字段 类型 备注
plateNumber String 车牌号
spaceId String 区域空间Id
type String WHITELIST/BLACKLIST

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "message": null,
  "localizedMsg": null,
  "data": [{
    "type": "WHITELIST",
    "plateNumber": "浙A54321",
    "spaceId": "xxx"
  },{
    "type": "BLACKLIST",
    "plateNumber": "京A54321",
    "spaceId": "xxx"
  }]
}

8 订单系统

8.1 新增车辆订单

定义

path 版本 是否需要登录
/parking/paas/edge/vehicle/order/add 2.0.0 否

入参

字段 类型 是否必传 备注
plateNumber String 是 车牌号
inBarrierGateId String 是 入场道闸Id
inTime String-utc 是 入场时间
outBarrierGateId String 是 出场道闸Id
outTime String-utc 是 出场时间
payStatus Integer 是 支付结果：
0 - 支付完成
4 - 未支付

示例

{
  "plateNumber": "京N12345",
  "inBarrierGateId": "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,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "message": null,
  "localizedMsg": null
}

8.2 确认车辆订单

定义

path 版本 是否需要登录
/parking/paas/edge/vehicle/order/completed 2.0.0 否

入参

字段 类型 是否必传 备注
orderNumber String 是 订单号
areaId String 是 停车区域spaceId
payStatus Integer 是 支付结果：
0 - 支付完成
1 - 免费
2 - 本地支付
3 - 取消订单

示例

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

出参

字段 类型 备注
code Integer 返回码
message String 返回信息

示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":null,
  "message": null,
  "localizedMsg": null
}

results matching ""

    No results matching ""