边缘车辆通行服务API

更新时间：2019-07-23 18:57:07

使用说明

接口文档

接口以阿里云IoT统一网关HTTP接口的形式提供（使用方法参考https://github.com/aliyun/iotx-api-gateway-client），访问域名：api.link.aliyun.com，接口协议：HTTPS。

接口列表

模块	接口名称	接口说明
	配置OSS	指定边缘网关的OSS配置
	查询网关对应的OSS配置	查询网关对象的OSS配置
	创建停车区域	创建停车区域，指定关联的边缘网关
	删除停车区域	删除停车区域，包括关联的车道闸
	查询停车区域列表	查询某边缘网关下关联的停车区域列表
	创建车辆道闸	新建车辆道闸
	绑定车道闸到停车区域	绑定到某停车区域
	解绑车道闸	将车道闸从停车区域解绑
	删除车闸	删除已有车道闸
	查询边缘网关范围内车闸列表	查询某边缘网关下的车闸列表
	查询停车区域范围内车闸列表	查询某停车区域内的车闸列表
	收费账单	确认车辆支付账单状态
车辆人员信息	添加用户车辆权限	在某停车区域内添加用户车辆信息
	删除用户车辆权限	删除某停车区域内的一个车辆权限信息
	查询某车辆权限	查询某停车区域内某车辆的权限信息
	查询用户所有的车辆权限	查询用户在某停车区域内的所有车辆权限
	更新用户的车辆权限信息	更新用户在指定停车场中的一个车辆的权限信息
业务功能	锁定某车辆	锁定停车区域中的一个车辆
	矫正某停车区域中的车牌信息	矫正某停车区域中的某个车牌信息
	打开车闸	打开车闸

通用对象

车闸对象ParkingTollDTO

字段	类型	说明
productKey	String	车闸的pk
name	String	车闸的名称
iotId	String	车闸的iotId
parkIotId	String	停车区域的iotId
gatewayProductKey	String	边缘网关设备的productKey
gatewayDeviceName	String	边缘网关设备的deviceName
gatewayIotId	String	边缘网关设备的iotId

停车区域对象ParkDTO

字段	类型	说明
productKey	String	停车区域的pk
name	String	停车区域的名称
iotId	String	停车区域的iotId
gatewayProductKey	String	边缘网关设备的productKey
gatewayDeviceName	String	边缘网关设备的deviceName
gatewayIotId	String	边缘网关设备的iotId

车辆信息对象VehicleInfoDTO

字段	类型	备注
identityId	String	统一身份ID
userName	String	显示的用户名
licenseNumber	String	车牌号
parkName	String	停车区域名称
parkIotId	String	停车区域iotId
userData	String	用户自定义信息
effectiveDate	String	车牌信息有效期的开始时间格式 yyyy-MM-dd HH:mm:ss"
expiryDate	String	车牌信息有效期的终止时间格式 yyyy-MM-dd HH:mm:ss"
payType	Integer	"0":"免费", "1":"线上收费", "2":"线下收费", "3":"线上或线下收费"

停车区域、车闸对象管理

配置OSS

使用边缘网关的时候需要在阿里云上创建OSS，这个接口用于指定边缘网关使用的OSS配置

path	版本	是否需要登录
/parking/paas/gateway/oss/config	1.0.0	否

入参

字段	类型	是否必传	备注
ossEndpoint	String	是	oss的接入点
bucket	String	是	oss的bucket名称
gatewayProductKey	String	如不传gatewayIotId，此处必填	边缘网关设备的productKey
gatewayDeviceName	String	如不传gatewayIotId，此处必填	边缘网关设备的deviceName
gatewayIotId	String	如不传gatewayProductKey和gatewayDeviceName，此处必填	边缘网关的iotId，

出参

返回结果使用通用结果类型，data域为空。

示例

请求示例

{
  "gatewayProductKey": "xxxxxxxx",
  "gatewayDeviceName": "xxxxxxxx",
  "ossEndpoint":"oss-cn-shanghai.aliyuncs.com",
  "bucket":"parking"
}

返回示例

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

查询网关对应的OSS配置

查询指定边缘网关所使用的OSS配置信息

path	版本	是否需要登录
/parking/paas/gateway/oss/get	1.0.0	否

入参

字段	类型	是否必传	备注
gatewayProductKey	String	如不传gatewayIotId，此处必填	边缘网关设备的productKey
gatewayDeviceName	String	如不传gatewayIotId，此处必填	边缘网关设备的deviceName
gatewayIotId	String	如不传gatewayProductKey和gatewayDeviceName，此处必填	边缘网关的iotId，

出参

字段	类型	备注
code	Integer	返回码
message	String	返回信息
data	JSON	配置信息

OssConfig对象

字段	类型	备注
ossEndpoint	String	oss的接入点
bucket	String	oss的bucket名称

示例

请求示例

{
  "gatewayProductKey": "xxxxxxxx",
  "gatewayDeviceName": "xxxxxxxx"
}

返回示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "data":{
    "ossENdpoint":"oss-cn-shanghai.aliyuncs.com",
    "bucket":"parking-daily-auto"
  },
  "message": null,
  "localizedMsg": null
}

创建停车区域

停车区域是一个虚拟的物对象，创建的时候需要指定关联的边缘网关，因为没有边缘网关这个设备无法连接到云。需要预先在阿里云物联网平台上创建边缘网关设备，拿到边缘网关对应的productKey和deviceName；还要预先创建停车区域的产品，拿到停车区域产品的ProductKey。

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

入参

字段	类型	是否必传	备注
gatewayProductKey	String	如不传gatewayIotId，此处必填	边缘网关设备的productKey
gatewayDeviceName	String	如不传gatewayIotId，此处必填	边缘网关设备的deviceName
gatewayIotId	String	如不传gatewayProductKey和gatewayDeviceName，此处必填	边缘网关的iotId，
productKey	String	是	停车区域的ProductKey
name	String	是	自定义的停车区域名称，支持英文字母、数字和特殊字符-_@.:，长度限制4~32字符（不支持中文）
iNetAddress	String	是	ip地址 "192.168.0.1"
port	Integer	是	端口号

出参

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

示例

请求示例

{
  "gatewayProductKey": "xxxxxxxx",
  "gatewayDeviceName": "xxxxxxxx",
  "productKey": "xxxxxxxx",
  "name": "1dayPark",
  "iNetAddress":"192.168.0.1",
  "port":6800
}

返回示例

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

删除停车区域

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

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

入参

字段	类型	是否必传	备注
gatewayProductKey	String	如不传gatewayIotId，此处必填	边缘网关设备的productKey
gatewayDeviceName	String	如不传gatewayIotId，此处必填	边缘网关设备的deviceName
gatewayIotId	String	如不传gatewayProductKey和gatewayDeviceName，此处必填	边缘网关的iotId，
iotId	String	是	停车区域的iotId，创建停车区域的时候获取

出参

返回结果使用通用结果类型，data域为空。

示例

请求示例

{
   "gatewayProductKey": "xxxxxxxx",
   "gatewayDeviceName": "xxxxxxxx",
   "iotId": "xxxxxxxx"
}

返回示例

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

查询指定边缘网关下停车区域列表

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

入参

字段	类型	是否必传	备注
gatewayProductKey	String	如不传gatewayIotId，此处必填	边缘网关设备的productKey
gatewayDeviceName	String	如不传gatewayIotId，此处必填	边缘网关设备的deviceName
gatewayIotId	String	如不传gatewayProductKey和gatewayDeviceName，此处必填	边缘网关的iotId，
pageSize	Integer	是	分页查询一页内的记录数，上限100
pageNo	Integer	是	分页数，从1开始

出参

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

分页数据对象PageDTO

字段	类型	备注
pageSize	Integer	传入的pageSize
pageNo	Integer	传入的pageNo
total	Long	总记录数
data	JSONArray	停车区域对象

示例

请求示例

{
  "gatewayProductKey":"xxxxxxxx",
  "gatewayDeviceName":"xxxxxxxx",
  "pageSize":10,
  "pageNo":1
}

返回示例

{
    "code": 200,
    "data": {
        "total": 14,
        "data": [{
            "iotId": "p2OsgId2N2kXMWThRCQP000101",
            "gatewayIotId": "0yFE8hIltDi7EnjnKrPZ000101",
            "name": "juanshi",
            "productKey": "a1t1qy6wAtx",
            "gatewayProductKey": "a1ygwU7VmdX",
            "gatewayDeviceName": "daily2"
        }, {
            "iotId": "thyODMKlsOzePlalKKdK000101",
            "gatewayIotId": "0yFE8hIltDi7EnjnKrPZ000101",
            "name": "03-22",
            "productKey": "a1t1qy6wAtx",
            "gatewayProductKey": "a1ygwU7VmdX",
            "gatewayDeviceName": "daily2"
        }, {
            "iotId": "lah1Qr4NPbJM7c0Uq3aV000101",
            "gatewayIotId": "0yFE8hIltDi7EnjnKrPZ000101",
            "name": "03-23",
            "productKey": "a1t1qy6wAtx",
            "gatewayProductKey": "a1ygwU7VmdX",
            "gatewayDeviceName": "daily2"
        }, {
            "iotId": "bVQhboZGAfl8WX7lrF0S000101",
            "gatewayIotId": "0yFE8hIltDi7EnjnKrPZ000101",
            "name": "WXvG",
            "productKey": "a1t1qy6wAtx",
            "gatewayProductKey": "a1ygwU7VmdX",
            "gatewayDeviceName": "daily2"
        }, {
            "iotId": "ESYQRRGKPG0gZhKRIuBr000101",
            "gatewayIotId": "0yFE8hIltDi7EnjnKrPZ000101",
            "name": "eSh6",
            "productKey": "a1t1qy6wAtx",
            "gatewayProductKey": "a1ygwU7VmdX",
            "gatewayDeviceName": "daily2"
        }, {
            "iotId": "KMWeBpjQ9a0AHY1lsp9M000101",
            "gatewayIotId": "0yFE8hIltDi7EnjnKrPZ000101",
            "name": "Iaoi",
            "productKey": "a1t1qy6wAtx",
            "gatewayProductKey": "a1ygwU7VmdX",
            "gatewayDeviceName": "daily2"
        }, {
            "iotId": "jEZPuMRtVGyFD5L9gROq000101",
            "gatewayIotId": "0yFE8hIltDi7EnjnKrPZ000101",
            "name": "oJfE",
            "productKey": "a1t1qy6wAtx",
            "gatewayProductKey": "a1ygwU7VmdX",
            "gatewayDeviceName": "daily2"
        }, {
            "iotId": "ln1ci3TVnAaoOjhf2fcH000101",
            "gatewayIotId": "0yFE8hIltDi7EnjnKrPZ000101",
            "name": "9ETi",
            "productKey": "a1t1qy6wAtx",
            "gatewayProductKey": "a1ygwU7VmdX",
            "gatewayDeviceName": "daily2"
        }, {
            "iotId": "O4jRKfKLzpGWX4p4dcpZ000101",
            "gatewayIotId": "0yFE8hIltDi7EnjnKrPZ000101",
            "name": "0322",
            "productKey": "a1t1qy6wAtx",
            "gatewayProductKey": "a1ygwU7VmdX",
            "gatewayDeviceName": "daily2"
        }, {
            "iotId": "uHeAD9n05TEqjfvGukzC000101",
            "gatewayIotId": "0yFE8hIltDi7EnjnKrPZ000101",
            "name": "parking_023",
            "productKey": "a1t1qy6wAtx",
            "gatewayProductKey": "a1ygwU7VmdX",
            "gatewayDeviceName": "daily2"
        }, {
            "iotId": "wp22skoHE18fUn4pb3Ic000101",
            "gatewayIotId": "0yFE8hIltDi7EnjnKrPZ000101",
            "name": "A60e4TLPG0c4d2icOC2YKWoe6gPDXYG@",
            "productKey": "a1t1qy6wAtx",
            "gatewayProductKey": "a1ygwU7VmdX",
            "gatewayDeviceName": "daily2"
        }, {
            "iotId": "1o9nUhO1MHIfO1ze0Dfc000101",
            "gatewayIotId": "0yFE8hIltDi7EnjnKrPZ000101",
            "name": "0325",
            "productKey": "a1t1qy6wAtx",
            "gatewayProductKey": "a1ygwU7VmdX",
            "gatewayDeviceName": "daily2"
        }, {
            "iotId": "z5GWzyiFiYpnpDGL9xhA000101",
            "gatewayIotId": "0yFE8hIltDi7EnjnKrPZ000101",
            "name": "0324",
            "productKey": "a1t1qy6wAtx",
            "gatewayProductKey": "a1ygwU7VmdX",
            "gatewayDeviceName": "daily2"
        }, {
            "iotId": "XHODY1zPAFzlDwx65hlV000101",
            "gatewayIotId": "0yFE8hIltDi7EnjnKrPZ000101",
            "name": "parking_023",
            "productKey": "a1t1qy6wAtx",
            "gatewayProductKey": "a1ygwU7VmdX",
            "gatewayDeviceName": "daily2"
        }],
        "pageNo": 1,
        "pageSize": 100
    },
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "message": null,
  "localizedMsg": null
}

创建车道闸并绑定到停车区域

车道闸也是从属于边缘网关的。需要预先在阿里云物联网平台上预先创建好边缘网关设备，拿到ProductKey和DeviceName，以及车道闸的产品ProductKey。创建车道闸的时候，如果传了parkIotId会把车道闸绑定到停车区域，如果不传则不会绑定到特定的停车区域。

path	版本	是否需要登录
/parking/paas/edge/toll/add	1.0.0	否

入参

字段	类型	是否必传	备注
gatewayProductKey	String	如不传gatewayIotId，此处必填	边缘网关设备的productKey
gatewayDeviceName	String	如不传gatewayIotId，此处必填	边缘网关设备的deviceName
gatewayIotId	String	如不传gatewayProductKey和gatewayDeviceName，此处必填	边缘网关的iotId，
parkIotId	String	否	停车区域的iotId
productKey	String	是	车闸的ProductKey
name	String	是	自定义的车闸名称，支持英文字母、数字和特殊字符-_@.:，长度限制4~32字符（不支持中文）

出参

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

示例

请求示例

{
  "gatewayProductKey": "xxxxxxxx",
  "gatewayDeviceName": "xxxxxxxx",
  "parkIotId":"xxxxxxxxxxx",
  "productKey": "xxxxxxxx",
  "name": "1dayToll"
}

返回示例

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

绑定车道闸到停车区域

对于用1.5单独创建而没有关联停车区的车道闸，或者通过1.7解绑的车道闸，可以通过这个接口绑定到一个特定的停车区域。

之所以需要绑定停车区域，是因为车道闸和停车区域关联之后，才能打通人的信息和车辆事件。因为人的信息在停车区域里，而车辆事件是有车道闸上报的。

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

入参

字段	类型	是否必传	备注
tollIotId	String	是	车闸的iotId
parkIotId	String	是	停车区域的iotId

出参

返回结果使用通用结果类型，data域为空。

示例

请求示例

{
  "tollIotId": "xxxxxxxx",
  "parkIotId": "xxxxxxxx"
}

返回示例

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

从停车区域解绑车道闸

将车道闸从已绑定的停车区域内解绑

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

入参

字段	类型	是否必传	备注
tollIotId	String	是	车闸的iotId
parkIotId	String	是	停车区域的iotId

出参

返回结果使用通用结果类型，data域为空。

示例

请求示例

{
  "tollIotId": "xxxxxxxx",
  "parkIotId": "xxxxxxxx"
}

返回示例

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

解绑并删除车闸

把车闸从车场解绑并删除车闸
定义

path	版本	是否需要登录
/parking/paas/edge/toll/delete	1.0.0	否

入参

字段	类型	是否必传	备注
tollIotId	String	是	车闸的iotId，创建车闸的时候获取

出参

返回结果使用通用结果类型，data域为空。

示例

请求示例

{
   "tollIotId": "xxxxxxxx"
}

返回示例

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

查询指定边缘网关下车闸列表

查询某边缘网关下关联的车闸列表

path	版本	是否需要登录
/parking/paas/edge/toll/query	1.0.0	否

入参

字段	类型	是否必传	备注
gatewayProductKey	String	如不传gatewayIotId，此处必填	边缘网关设备的productKey
gatewayDeviceName	String	如不传gatewayIotId，此处必填	边缘网关设备的deviceName
gatewayIotId	String	如不传gatewayProductKey和gatewayDeviceName，此处必填	边缘网关的iotId，
pageSize	Integer	是	分页查询一页内的记录数，上限100
pageNo	Integer	是	分页数，从1开始

出参

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

分页数据对象PageDTO

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

车闸对象ParkingTollDTO

productKey	String	车闸的pk
name	String	车闸的名称
iotId	String	车闸的iotId
parkIotId	String	停车区域的iotId
gatewayProductKey	String	边缘网关设备的productKey
gatewayDeviceName	String	边缘网关设备的deviceName
gatewayIotId	String	边缘网关设备的iotId

示例

请求示例

{
  "gatewayProductKey":"xxxxxxxx",
  "gatewayDeviceName":"xxxxxxxx",
  "pageSize":10,
  "pageNo":1
}

返回示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "message": null,
  "localizedMsg": null,
  "data":{
      "pageSize":10,
    "pageNo":1,
    "total":2,
    "data":[
      {
        "productKey":"xxxxxx",
        "name":"1dayToll",
        "iotId":"xxxxxxxxxx",
        "parkIotId":"xxxxxxxxxx",
        "gatewayProductKey":"xxxxxxxxxxxx",
        "gatewayDeviceName":"xxxxxxxxxxxxx",
        "gatewayIotId":"xxxxxxxxxxx"
      },
      {
        "productKey":"xxxxxx",
        "name":"2daysToll",
        "iotId":"xxxxxxxxxx",
        "parkIotId":"xxxxxxxxxx",
        "gatewayProductKey":"xxxxxxxxxxxx",
        "gatewayDeviceName":"xxxxxxxxxxxxx",
        "gatewayIotId":"xxxxxxxxxxx"
      }
    ]
  }
}

查询指定停车区域下的车闸列表

查询一个停车区域下绑定的车闸列表

path	版本	是否需要登录
/parking/paas/park/toll/query	1.0.0	否

入参

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

出参

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

分页数据对象PageDTO

字段	类型	备注
pageSize	Integer	传入的pageSize
pageNo	Integer	传入的pageNo
total	Long	总记录数
data	JSONArray	车闸对象

示例

请求示例

{
  "parkIotId":"xxxxxxxx",
  "pageSize":10,
  "pageNo":1
}

返回示例

{
  "code": 200,
  "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
  "message": null,
  "localizedMsg": null,
  "data":{
      "pageSize":10,
    "pageNo":1,
    "total":2,
    "data":[
      {
        "productKey":"xxxxxx",
        "name":"1dayToll",
        "iotId":"xxxxxxxxxx",
        "parkIotId":"xxxxxxxxxx",
        "gatewayProductKey":"xxxxxxxxxxxx",
        "gatewayDeviceName":"xxxxxxxxxxxxx",
        "gatewayIotId":"xxxxxxxxxxxx",
      },
      {
        "productKey":"xxxxxx",
        "name":"2daysToll",
        "iotId":"xxxxxxxxxx",
        "parkIotId":"xxxxxxxxxx",
        "gatewayProductKey":"xxxxxxxxxxxx",
        "gatewayDeviceName":"xxxxxxxxxxxxx",
        "gatewayIotId":"xxxxxxxxxxxx",
      }
    ]
  }
}

确认收费账单

云端如果需要向本地确认支付账单状态，可以调这个接口

path	版本	是否需要登录
/parking/paas/order/update	1.0.0	否

入参

字段	类型	是否必传	备注
identityId	String	是	统一身份ID
parkIotId	String	是	停车区域iotId
tollIotId	String	是	车闸iotId
orderSerialNum	String	是	订单号
licenceNumber	String	是	车牌号

出参

返回结果使用通用结果类型，data域为空。

示例

请求示例

{
  "identityId":"50acopfd3a94900494085ed2699e052432c34452",
  "parkIotId":"xxxxxxxx",
  "tollIotId":"xxxxxxxx",
  "orderSerialNum":"xxxxxxxxxxxxxxxx",
  "licenceNumber":"京N XXXXX"
}

返回示例

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

车辆人员信息管理

向停车区域添加用户车辆权限信息

向停车区域添加用户的车辆信息，一个车辆绑定一个用户，但是一个用户可以绑定多个车辆

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

入参

字段	类型	是否必传	备注
identityId	String	是	统一身份ID
userName	String	是	用于显示的用户名字
parkIotId	String	是	停车区域iotId
effectiveDate	String	否	车牌信息有效期的开始时间格式 yyyy-MM-dd HH:mm:ss"
expiryDate	String	是	车牌信息有效期的终止时间格式 yyyy-MM-dd HH:mm:ss"
licenseNumber	String	是	车牌号
payType	Integer	是	"0":"免费", "1":"线上收费", "2":"线下收费", "3":"线上或线下收费"
userData	String	否	用户自定义信息，长度限制65535字符

出参

返回结果使用通用结果类型，data域为空。

示例

请求示例

{
  "identityId":"50acopfd3a94900494085ed2699e052432c34452",
  "userName":"王先生",
  "parkIotId":"xxxxxxxx",
  "effectiveDate":"2019-12-24 00:00:00",
  "expiryDate":"2020-03-04 18:00:00",
  "licenseNumber":"浙X XXXXX",
  "userData":"",
  "payType":0
}

返回示例

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

删除停车区域内的一个车辆权限信息

定义

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

入参

字段	类型	是否必传	备注
identityId	String	是	统一身份ID
parkIotId	String	是	停车区域iotId
licenseNumber	String	是	车牌号

出参

返回结果使用通用结果类型，data域为空。

示例

请求示例

{
  "identityId":"50acopfd3a94900494085ed2699e052432c34452",
  "parkIotId":"xxxxxxxx",
  "licenseNumber":"浙X XXXXX"
}

返回示例

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

查询指定车辆的权限信息

前提：指定停车区域；

权限信息：指effectiveDate和expiryDate

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

入参

字段	类型	是否必传	备注
parkIotId	String	是	停车区域iotId
licenseNumber	String	是	车牌号

出参

字段	类型	备注
code	Integer	返回码
message	String	返回信息
data	JSONObject	查询到的车辆信息

示例

请求示例

{
  "parkIotId":"xxxxxxxx",
  "licenseNumber":"浙X XXXXX"
}

返回示例

{
    "code": 200,
    "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
    "data": {
        "expiryDate": "2019-06-03 17:53:04",
        "userData": "userData",
        "payType": 2,
        "parkName": "0322",
        "identityId": "50acopfd3a94900494085ed2699e052432c34452",
        "parkIotId": "O4jRKfKLzpGWX4p4dcpZ000101",
        "licenseNumber": "浙A54321",
        "userName": "userName更新",
        "effectiveDate": "2019-04-04 17:53:06"
    },
    "localizedMsg": null,
    "message": null
}

查询用户在指定停车区域内所有车辆的权限

一个人在一个停车区域中可以有多辆车

查询当前用户在指定区域内的所有关联的车辆信息

path	版本	是否需要登录
/parking/paas/user/vehicle/query	1.0.0	否

入参

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

出参

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

分页数据对象PageDTO

pageSize	Integer	传入的pageSize
pageNo	Integer	传入的pageNo
total	Long	总记录数
data	JSONArray	停车区域对象

示例

请求示例

{
  "identityId":"50acopfd3a94900494085ed2699e052432c34452",
  "parkIotId":"O4jRKfKLzpGWX4p4dcpZ000101",
     "pageSize":10,
  "pageNo":1
}

返回示例

{
    "code": 200,
    "id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
    "data": {
        "total": 2,
        "data": [{
            "expiryDate": "2019-06-03 17:53:04",
            "userData": "userData",
            "payType": 2,
            "parkName": "0322",
            "identityId": "50acopfd3a94900494085ed2699e052432c34452",
            "parkIotId": "O4jRKfKLzpGWX4p4dcpZ000101",
            "licenseNumber": "浙A54321",
            "userName": "test",
            "effectiveDate": "2019-04-04 17:53:07"
        }],
        "pageNo": 2,
        "pageSize": 1
    },
    "localizedMsg": null,
    "message": null
}

更新用户的车辆权限信息

更新用户在指定停车场中的一个车辆的权限信息

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

入参

字段	类型	是否必传	备注
parkIotId	String	是	停车区域iotId
licenseNumber	String	是	车牌号
identityId	String	否	如不需要修改，不传这个字段。统一身份ID
userName	String	否	如不需要修改，不传这个字段。用于显示的用户名字
effectiveDate	String	否	如不需要修改，不传这个字段。车牌信息有效期的开始时间格式 yyyy-MM-dd HH:mm:ss"
expiryDate	String	否	如不需要修改，不传这个字段。车牌信息有效期的终止时间格式 yyyy-MM-dd HH:mm:ss"
payType	Integer	否	如不需要修改，不传这个字段。_"0":"免费", "1":"线上收费", "2":"线下收费", "3":"线上或线下收费"
userData	String	否	如不需要修改，不传这个字段。_用户自定义信息，长度限制65535字符

出参

返回结果使用通用结果类型，data域为空。

示例

请求示例

{
  "identityId":"50acopfd3a94900494085ed2699e052432c34452",
  "parkIotId":"O4jRKfKLzpGWX4p4dcpZ000101",
  "licenseNumber":"京N TR666",
  "userName":"王先生",
  "effectiveDate":"2019-12-24 00:00:00",
  "expiryDate":"2020-03-04 18:00:00",
  "userData":{"address":"22#303"}
}

返回示例

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

业务功能

锁定停车区域中的一个车辆

对一个停车区域的车辆信息标记成锁定状态，如果该车辆通过车场，会触发一个告警消息推送到云端

path	版本	是否需要登录
/parking/paas/service/vehicle/lock/modify	1.0.0	否

入参

字段	类型	是否必传	备注
parkIotId	String	是	停车区域iotId
licenseNumber	String	是	车牌号
effectiveDate	String	否	如不需要修改，不传这个字段。车牌信息有效期的开始时间格式 yyyy-MM-dd HH:mm:ss"
expiryDate	String	是	如不需要修改，不传这个字段。车牌信息有效期的终止时间格式 yyyy-MM-dd HH:mm:ss"
action	String	是	lock/unlock

出参

返回结果使用通用结果类型，data域为空。

示例

请求示例

{
  "parkIotId":"O4jRKfKLzpGWX4p4dcpZ000101",
  "licenseNumber":"京N TR666",
  "effectiveDate":"2019-12-24 00:00:00",
  "expiryDate":"2020-03-04 18:00:00",
  "action":"lock"
}

返回示例

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

矫正某停车区域中的车牌信息

接口定义

path	版本	是否需要登录
/parking/paas/service/licence/number/update	1.0.0	否

入参

字段	类型	是否必传	备注
parkIotId	String	是	停车区域iotId
licenseNumber	String	是	车牌号
image	String	是	车牌的图片url

出参

返回结果使用通用结果类型，data域为空。

示例

请求示例

{
  "parkIotId":"xxxxxxxx",
  "licenseNumber":"浙X XXXXX",
  "image":"https://"
}

返回示例

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

打开车闸

接口定义

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

入参

字段	类型	是否必传	备注
iotId	String	是	车闸iotId
items	JSNOObject	是	固定值 { "BarrierState":1 }

出参

返回结果使用通用结果类型，data域为空。

示例

请求示例

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

返回示例

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