2. 参数data加密定义
标准停车场接口协议
目 录
1.4车场终端设备上报接口PostParkingDevice
2.5空闲车位数据提交接口PostFreeParkingSpace
2.6免密支付/自动扣费冲正上报接口PostCarCorrect
4.2扫码枪扫码用户手机二维码缴费接口PayScanCode
5.3 第三方线上自主计费接口AutonomousCalfee
1.1车牌查询停车信息接口GetCarInOutInfoByPlate
1.2按出入口查询停车信息接口GetCarInOutInfoByPlace
2.5免密支付车辆签约接口 RecordDensityPay
3.1停车费(账单)查询接口GetParkingPaymentInfo
4.2固定车(同卡多车)修改接口ModifyCarCardNo
4.3固定车(同卡多车)删除接口DeleteCarCardNo
4.4固定车(同卡多车)车牌管理接口CarCardNoManage
采用http协议,POST方法
注意:上行5.1/5.2 接口 不需要遵循此定义
协议类型: Content-Type: application/json;
字符集: charset=UTF-8
请求头验证: 需要提供用户名(user)和密码(pwd) 发布时下行由我方提供
上行由第三方提供用户名(user)和密码(pwd) 及加密所需密钥
测试地址:
Content-Type: application/json;charset=utf-8
Host: xxxx://000.000.000.000:0000
user: ktapi
pwd: 0506E3
Key: 693207DB8148FBC9D8410179
parkCode: 1
上面地址不可用时,可用以下备用地址
Host: xxxx://000.00.000.000:0000
user: ktapi
pwd: 050654
key: 693207DB8148FBC90D1DBDBB
parkCode: 1
参数统一使用 data, 采用3DES加密,
加密密钥: KEY(发布时提供给第三方)
加密IV: 采用每天的日期作为偏移量 yyyyMMdd
例如:
KEY= 693207DB8148FBC9D8410179
IV = 20190225
预约车查询接口GetBookingCar 所需要的参数为 parkCode ,plateNo
转换成json格式 {"parkCode":"1","plateNo":"京A11113"}
3DES加密 data= 3DES(data,KEY,IV);
注:编码采用Encoding.GB2312.GetBytes
结果data为:
0edFaLw+X+9J2LHbzKQa0zo3RGmHII0JXoSLu19d+/pvYydg1qZV5A==
以json 的格式返回数据. 包含响应码代码,相应消息,数据体.
数据体详见各接口示例
名称 |
数据类型 |
说明 |
resCode |
int |
响应代码(0:正常,1:错误) |
resMsg |
string |
响应消息(错误消息) |
data |
array |
数据体 json的数组结构,具体返回值详见接口定义 |
举例:
请求接口2: GetParkingPaymentInfo
参数 plateNo:A12345
用户名:ktapi
密码:0306A9
加密密钥:F7A0B971B199FD2A1017CEC5
加密IV:20160120
请求报文
POST /api/pay/GetParkingPaymentInfo HTTP/1.1
Content-Type: application/json;charset=utf-8
user: ktapi
pwd: 0306A9
Host: 220.160.111.114:9099
Content-Length: 43
Expect: 100-continue
{"data":"DkTwRsUUza33A8/TvrocXI3r+Az1T7bt"}
应答报文
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/html; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 4.0
X-AspNet-Version: 4.0.30319
X-Powered-By: XXX.XXX
Date: Wed, 20 Xxx 2016 05:19:19 GMT
Content-Length: 412
{"data":[{"orderNo":"0001201601201319195951","entryTime":"2016-01-20 11:02:07","elapsedTime":137,"imgName":"xxxx://000.000.000.000:0000/XX_XxxxxxXxxx/XxxXxxxxXxxxxxxxx/00000000/000.000.0.000/00/00000000000000000_000.000.0.000_000000.xxx","payTime":"2016-01-20 13:19:19","payable":300,"delayTime":20],"resCode":0,"resMsg":null}
4. 上行部分接口流程
免密支付流程:
车辆入场 => 请求入场上报 => 根据返回值进行免密签约 => 车辆出场产生费用时 => 请求免密支付 => 根据返回值进行费用同步 => 费用缴清开闸出场
5. 缴费机第三方支付码流程(被扫)
大致流程:缴费机请求收费系统获取支付二维码 =>上行4.1获取停车费二维码接口GetPayQRCode 获取第三方支付二维码返回 => 缴费机展示,客户扫码付款 => 第三方收到付款后 由第三方请求 下行3.2停车费支付(账单同步)接口PayParkingFee 同步车辆费用至本地车场 => 费用缴清开闸放行
6. 扫码枪扫用户支付二维码流程(主扫)
大致流程:扫码枪扫用户支付二维码 =>请求 上行4.2扫码枪扫码用户手机二维码缴费接口PayScanCode 提交用户支付二维码,并由第三方进行收款后
=> 第三方缴费成功后 由第三方请求 下行3.2停车费支付(账单同步)接口PayParkingFee 同步车辆费用至本地车场 => 费用缴清开闸放行
7. 第三方标准找零流程
大致流程
用户投币产生找零金额 => 缴费机请求找零二维码接口(找零订单号) => 打印 上行5.2找零二维码页面跳转接口 的二维码 => 用户找零 => 第三方请求 下行3.5找零信息查询接口 根据返回的投币金额及应缴金额自行计算找零金额 => 用户找零成功 => 第三方请求 下行3.6找零成功通知接口 通知本地车场
1. 停车场基本信息部分
1.1停车场信息数据上报接口PostParkingInfo
注:每天上传一次
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 |
parkName |
string |
停车场名称 |
parkArea |
int |
停车场区域数 |
placeCount |
int |
停车场总停车位 |
返回值数据体定义
名称 |
数据类型 |
说明 |
请求示例
{
"parkCode": "123",
"parkName": "测试车场",
"parkArea": 3,
"placeCount": 300
}
返回示例
{
"resCode":0,
"resMsg":"",
"data":null
}
1.2停车场内区域数据上报接口PostAreaInfo
注:每天上传一次 全量上报
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 |
parkName |
string |
停车场名称 |
parkArea |
string |
停车场区域数 |
totalPlaceCount |
int |
停车场总停车位 |
areaInfo |
array |
包含以下参数 |
areaCode |
int |
区域编号 |
areaName |
string |
区域名称 |
areaType |
int |
区域类别(传值请自行转换) 0:普通停车区;1:6格立体停车场;2:9格立体停车场 |
placeCount |
int |
区域停车位数 |
返回值数据体定义
名称 |
数据类型 |
说明 |
请求示例
{
"parkCode": "123",
"parkName": "测试车场",
"parkArea": "3",
"areaInfo":[
{"areaCode":"1","areaName":"A地面","areaType":"0","placeCount":"100"},
{"areaCode":"2","areaName":"地库","areaType":"0","placeCount":"100"},
{"areaCode":"3","areaName":"B地面","areaType":"0","placeCount":"100"},
]
}
返回示例
{
"resCode":0,
"resMsg":"",
"data":null
}
1.3设备状态上报接口PostDeviceState
接口描述: 程序启动时,全量上报所有设备状态,之后有变更才上报
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 |
deviceCode |
string |
|
deviceName |
string |
设备名称 |
deviceType |
int |
设备类型 详见附录1.5 |
status |
string |
设备状态码 0:正常 其他:设备故障码 |
remark |
string |
故障描述 |
返回值数据体定义
名称 |
数据类型 |
说明 |
请求示例
{
"parkCode": "123",
"deviceCode": "1",
"deviceName": "入口1",
"deviceType": "4",
"status": 0,
"remark": ""
}
返回示例
{
"resCode":0,
"resMsg":""
}
1.4车场终端设备上报接口PostParkingDevice
xxxx://xxxXXX/XxxxXxxxxxxXxxxxx
接口描述: 上报车场基础设备数据
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 |
deviceCode |
string |
设备编码 |
deviceIp |
string |
设备Ip |
deviceName |
string |
设备名称 |
deviceType |
int |
设备类型 详见附录1.5 |
返回值数据体定义
名称 |
数据类型 |
说明 |
请求示例
{
"parkCode": "123",
"deviceCode": "1",
"deviceIp": "172.19.8.242",
"deviceName": "入口1",
"deviceType": "4"
}
返回示例
{
"resCode":0,
"resMsg":""
}
2. 车辆出入场部分
2.1入场数据提交接口PostCarInInfo
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 |
plateNo |
string |
车牌号,不允许为空 |
cardNo |
string |
入场取票号/无牌车入场的卡号 |
entryTime |
string |
|
entryPlace |
string |
入口名称/入口ip/入口设备编码 三选一 |
imgName |
string |
入口抓拍图片 方式:Base64 / Url 二选一 可配置是否上传 |
vplType |
string |
车辆类型 1:大型车;2:小型车 (传数值请自行转换) |
vplColor |
string |
车牌颜色 0蓝色;1黄色;2白色;3黑色;4绿色;(传数值请自行转换) |
返回值数据体定义
名称 |
数据类型 |
说明 |
IsDensityPay |
Int |
是否开通免密支付/自动扣费. 0:未开通,1:已开通 如果开通,出场时会上传停车数据,询问是否扣费成功 |
参数示例
{
"parkCode": "123",
"plateNo": "xxxxxxx",
"cardNo":"123123",
"entryTime": "yyyy/MM/dd HH:mm:ss",
"entryPlace": "xxxxxxxx",
"imgName": "xxxxxxx.jpg",
"vplType": "1",
"vplColor": "0"
}
返回示例
{
"resCode":0,
"resMsg":"",
"data":[{"IsDensityPay":0/1}](是否开通免密支付:0未开通、1已开通)
}
2.2免密支付数据提交接口PostCarOutInfo
针对开通了免密支付/自动扣费的车辆会在车辆到达出口时进行上报
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 |
plateNo |
string |
车牌号,不 允许为空 |
cardNo |
string |
|
entryTime |
string |
入场时间,不 允许为空 |
leaveTime |
string |
出场时间,不允许为空 |
totalMoney |
Int |
应收金额(分) |
leavePlace |
string |
出口名称/出口ip/出口设备编码 三选一 |
imgName |
string |
出口抓拍图片方式:Base64 / Url 二选一 可配置是否上传 |
返回值数据体定义
名称 |
数据类型 |
说明 |
densityMoney |
Int |
线上自动扣款/抵扣金额,单位分 |
请求示例
{
"parkCode": "123",
"plateNo": "xxxxxxx",
"cardNo":"123123",
"entryTime": "yyyy/MM/dd HH:mm:ss",
"leaveTime": "yyyy/MM/dd HH:mm:ss",
"totalMoney": 200,
"leavePlace": "xxxxxxx",
"imgName": "xxxxxxx.jpg"
}
返回示例
{
"resCode":0,
"resMsg":"",
"data":[{"deductMoney":200}](线上自动扣款/抵扣金额,单位分)
}
2.3出场数据提交接口PostPayDetail
实时上报 岗亭收费明细报表出车数据
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 |
plateNo |
string |
车牌号,不 允许为空 |
cardNo |
string |
入场取票号/无牌车入场的卡号 |
entryTime |
string |
入场时间,不 允许为空 |
leaveTime |
string |
出场时间,不允许为空 |
preMoney |
int |
提前缴费金额(分) |
payMoney |
int |
|
payType |
int |
出口支付方式 详见附录1.2 |
ticketMoney |
int |
抵扣金额 单位:分 |
ticketTime |
int |
抵扣时间 单位:秒 |
freeMoney |
int |
免费金额 单位:分 |
carType |
int |
车辆类型 详见附录1.1 |
leavePlace |
string |
出口名称/出口ip/设备编码 三选一 |
imgName |
string |
出口抓拍图片方式:Base64 / Url 二选一 可配置是否上传 |
返回值数据体定义
名称 |
数据类型 |
说明 |
请求示例
{
"parkCode": "123",
"plateNo": "xxxxxxx",
"cardNo":"0456adasd",
"entryTime": "yyyy/MM/dd HH:mm:ss",
"leaveTime": "yyyy/MM/dd HH:mm:ss",
"preMoney": 123,
"payMoney": 123,
"payType":1,
"carType": 1,
"leavePlace": "xxxxxxx",
"imgName": "xxxxxxx.jpg"
}
返回示例
{
"resCode":0,
"resMsg":"",
"data":null
}
2.4入场黑名单提交接口PostBlackInInfo
注:第三方黑名单车辆入场提交
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 |
blackId |
int |
黑名单编号 |
plateNo |
string |
车牌号码 |
remark |
string |
黑名单原因(备注) |
entryPlace |
int |
入口名称/入口ip/入口设备编码 三选一 |
entryTime |
String |
入场时间 |
返回值数据体定义
名称 |
数据类型 |
说明 |
返回示例
{
"resCode":0,
"resMsg":""
}
2.5空闲车位数据提交接口PostFreeParkingSpace
xxxx://xxxXXX/XxxxXxxxXxxxxxxXxxxx
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 |
freeSpaceNum |
int |
总剩余车位数 |
totalSpaceNum |
int |
总车位数 |
areaInfo |
array |
包含以下参数 |
areaCode |
int |
区域编号 |
areaName |
string |
区域名称 |
areaFreeSpaceNum |
int |
区域剩余车位数 |
返回值数据体定义
名称 |
数据类型 |
说明 |
请求示例
{
"parkCode": "123",
"freeSpaceNum": "200",
"totalSpaceNum": "300"
}
返回示例
{
"resCode":0,
"resMsg":"",
"data":null
}
2.6免密支付/自动扣费冲正上报接口PostCarCorrect
针对开通了免密支付/自动扣费的车辆上报的时候,第三方接口网络超时没有应答或其他异常情况,车场无法知道线上扣费是否成功,通过线下收费的情况
车辆离场之后会发起冲正请求,第三方针对缴费订单做异常处理(比如退款,人工处理等)
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 |
plateNo |
string |
车牌号,不 允许为空 |
entryTime |
string |
入场时间,不 允许为空 |
leaveTime |
string |
出场时间,不允许为空 |
totalMoney |
Int |
应收金额(分) |
leavePlace |
string |
出口 |
返回值数据体定义
名称 |
数据类型 |
说明 |
请求示例
{
"parkCode": "123",
"plateNo": "xxxxxxx",
"entryTime": "yyyy/MM/dd HH:mm:ss",
"leaveTime": "yyyy/MM/dd HH:mm:ss",
"totalMoney": 200,
"leavePlace": "xxxxxxx",
"imgName": "xxxxxxx.jpg"
}
返回示例
{
"resCode":0,
"resMsg":"",
"data":null
}
2.7终端支付明细接口PostCarBillDetail
xxxx://xxxXXX/XxxxXxxXxxxXxxxxx
实时上报 终端支付明细报表支付明细数据
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 |
plateNo |
string |
车牌号,不 允许为空 |
cardNo |
string |
入场取票号/无牌车入场的卡号 |
carType |
int |
车辆类型 详见附录1.1 |
entryTime |
string |
入场时间 |
leaveTime |
string |
出场时间 |
totalMoney |
int |
应收金额 |
payMoney |
int |
实收金额 |
freeMoney |
int |
免费金额 |
selfTotal |
int |
(缴费机)待找零金额 |
selfPay |
int |
(缴费机)已找零金额 |
ticketMoney |
int |
抵扣金额 |
ticketTime |
int |
抵扣时长 |
ticketNum |
int |
抵扣张数 |
terminalType |
int |
终端类型 详见附录1.3 |
payType |
int |
支付方式 详见附录1.4 |
payTime |
string |
支付时间 |
paidType |
int |
收费方式 0-收费,1-免费,2-异常放行 |
remark |
string |
缴费备注(缴费订单号或者其他备注) |
返回值数据体定义
名称 |
数据类型 |
说明 |
请求示例
{
"parkCode": "123",
"plateNo": "xxxxxxx",
"cardNo":"123123123",
"carType": 1,
"entryTime": "yyyy/MM/dd HH:mm:ss",
"leaveTime": "yyyy/MM/dd HH:mm:ss",
"totalMoney": 123,
"payMoney": 123,
"freeMoney": 0,
"selfTotal": 0,
"selfPay": 0,
"ticketMoney": 0,
"ticketTime": 0,
"ticketNum": 0,
"terminalType": 0,
"payType": 0,
"payTime": "yyyy/MM/dd HH:mm:ss",
"paidType": 0,
"remark": "156486413564",
}
返回示例
{
"resCode":0,
"resMsg":"",
"data":null
}
3. 内部车部分
3.1内部车辆更新提交接口PostCarCard
注:首次全部上传全部生效内部车,之后有更新才上报
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 |
cardId |
string |
内部车卡片编号 |
userName |
string |
业主名称 |
telPhone |
string |
业主手机号 |
carType |
string |
车辆类型 详见附录1.1 |
validFrom |
string |
卡片起始有效期 yyyy-MM-dd HH:mm:ss |
validTo |
string |
卡片结束有效期 yyyy-MM-dd HH:mm:ss |
plateDetails |
string |
Json数组字符串 [{"plateNo":"A12345","etcNo":"XXXXXX"}] plateNo: 车牌号 etcNo:ETC号或者卡号 |
返回值数据体定义
名称 |
数据类型 |
说明 |
参数示例
{
"parkCode": "123",
"cardId": "1",
"userName": "xx",
"telPhone": "181xxxxxxxx",
"carType": 1,
"validFrom": "yyyy/MM/dd HH:mm:ss",
"validTo": "yyyy/MM/dd HH:mm:xx",
"xxxxxXxxxxxx": "[{\"plateNo\":\"A12345\",\"etcNo\":\"\"}]"
}
返回示例
{
"resCode":0,
"resMsg":"",
"data":null
}
4. 支付二维码部分
4.1获取停车费二维码接口GetPayQRCode
接口描述: 车场向平台获取供客户缴费扫码使用的二维码(建议短码链接),客户通过二维码缴费成功后,请异步请求停车场本地接口进行通知(下行接口1.2 账单同步接口)
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 |
orderNo |
string |
车场订单号 |
deviceCode |
string |
设备编码 |
plateNum |
string |
车牌号(含中文,URL编码) |
cardNo |
string |
小票号(取卡取票) |
inTime |
string |
入场时间(yyyy-MM-dd HH:mm:ss) |
elapsedTime |
Int |
停车时长(单位:分钟) |
amount |
Int |
订单金额(分) |
outTime |
string |
出场时间(yyyy-MM-dd HH:mm:ss) 场内支付取当前时间 |
返回值数据体定义
名称 |
数据类型 |
说明 |
qrcode |
string |
二维码内容(短码链接url) |
orderNo |
string |
平台订单号 |
payType |
Int |
支付平台 6-微信 7-支付宝 |
请求示例
{
"parkCode": "123",
"orderNo": "200",
"deviceId": "300",
"plateNum": "XXXXXX",
"inTime": "yyyy-MM-dd HH:mm:ss",
"elapsedTime": "300",
"amount": "300",
"outTime":"yyyy-MM-dd HH:mm:ss"
}
返回示例
{
"resCode":0,
"resMsg":"",
"data":[{"qrcode":"XXXXXXXXX",
"orderNo":"XXXXXXXXX",
"payType":6}]
}
qrcode 为二维码内容(短码链接url);
4.2扫码枪扫码用户手机二维码缴费接口PayScanCode
接口描述: 车场扫客户支付码,向支付平台请求扣费. 扣费成功后,请异步请求停车场本地接口进行通知(下行接口1.2 账单同步接口)
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
|
orderNo |
string |
车场订单号 |
deviceId |
string |
设备Id |
carNo |
string |
车牌号(含中文,URL编码) |
inTime |
string |
入场时间(yyyy-MM-dd HH:mm:ss) |
elapsedTime |
Int |
停车时长(单位:分钟) |
amount |
Int |
应缴金额(单位:分) |
authCode |
string |
支付条形码数字 |
outTime |
string |
出场时间(yyyy-MM-dd HH:mm:ss) 场内支付取当前时间 |
返回值数据体定义
名称 |
数据类型 |
说明 |
orderNo |
string |
平台订单号 |
payType |
int |
支付平台 6-微信 7-支付宝 |
请求示例
{
"parkCode": "123",
"orderNo": "200",
"deviceId": "300",
"carNo": "300",
"inTime": "300",
"elapsedTime": "300",
"amount":
"300",
"authCode":
"XXXXXXXX"
}
返回示例
{
"resCode":0,
"resMsg":"",
"data":[{"orderNo":"xxxxxxxxxxxxxxx","payType":6}]
}
5.1 入场小票二维码页面跳转接口
接口描述: 入场取票机入场小票上打印的二维码内容(自助缴费页面)
参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 |
返回值数据体定义
名称 |
数据类型 |
说明 |
该接口为请求自助缴费页面 不需要遵循加密定义,不需要请求头
用户需要根据该接口参数自己开发一个页面,入场小票会将该地址转化为二维码打印至入场小票上,用户可通过扫描二维码进行自助缴费
5.2 找零小票二维码页面跳转接口
xxxx://xxxXXX?xxxxXxxxx*&xxxxxXxx*
接口描述: 缴费机找零小票上打印的二维码内容(自助找零页面)
参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 |
orderNo |
string |
找零订单号 |
返回值数据体定义
名称 |
数据类型 |
说明 |
该接口为请求自助找零页面 不需要遵循加密定义,不需要请求头
用户需要根据该接口参数自己开发一个页面,找零小票会将该地址转化为二维码打印至找零小票上,用户可通过扫描二维码进行自助找零
5.3 第三方线上自主计费接口AutonomousCalfee
xxxx://xxxXXX/XxxxxxxxxxXxxxxx
接口描述:适用于第三方自主线上计算停车费用,不采用车场计费模式
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 |
plateNo |
string |
车牌号码 |
cardNo |
string |
卡号/票号 |
entryTime |
string |
入场时间 yyyy-MM-dd HH:mm:ss |
entryPlace |
string |
入场地点/Ip/设备编码 |
leaveTime |
string |
出场时间 yyyy-MM-dd HH:mm:ss |
leavePlace |
string |
出场地点/Ip/设备编码 |
返回值数据体定义
名称 |
数据类型 |
说明 |
payMoney |
int |
待缴金额 |
请求示例
{
"parkCode": "123",
"plateNo": "xxxxxxx","cardNo": "xxxxxxx",
"entryTime": "yyyy/MM/dd HH:mm:ss","entryPlace": "xxxxxxx",
"leaveTime": "yyyy/MM/dd HH:mm:ss","leavePlace": "xxxxxxx",
}
返回示例
{
"resCode":0,
"resMsg":"",
"data":[{"payMoney":100}]
}
三、下行接口定义
1. 停车信息部分
1.1车牌查询停车信息接口GetCarInOutInfoByPlate
http://IP:端口/api/ParkingInfo/GetCarInOutInfoByPlate
兼容旧版 http://IP:端口/api/pay2/GetCarInOutInfoByPlate
注:该接口数据对应收费后台的 报表统计->岗亭收费明细报表。
参数
string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
plateNo |
string |
车牌号(可模糊输入) 必填 |
startTime |
string |
开始时间 必填 yyyy-MM-dd HH:mm:ss |
endTime |
string |
结束时间 必填 Yyyy-MM-dd HH:mm:ss |
pageIndex |
int |
分页数(>=1 必填) |
pageCount |
int |
每页数量(>=1 必填) |
返回值数据体定义
名称 |
数据类型 |
说明 |
totalNum |
string |
总数 |
detail |
array |
包含以下参数 |
id |
string |
编号 |
plateNo |
string |
车牌号 |
entryTime |
string |
入场时间 |
entryPlace |
String |
入口 |
leaveTime |
string |
出场时间 |
leavePlace |
string |
出口 |
imgName |
string |
出口抓拍图片url |
payable |
string |
支付金额(单位:分) |
cashUser |
string |
操作员 |
cashTime |
string |
收费时间 |
返回示例
{"data":[{
"totalNum":"2",
"detail":[
{"id":"1","plateNo":"空818494","entryTime":"2018/12/11 15:53:54","entryPlace":"172.19.8.242","leaveTime":"2018/12/11 16:54:54","leavePlace":"172.19.8.243","imgName":"xxxx://000.00.0.000:0000/XX_XxxxxxXxxx/XxxXxxxxXxxxxxxxx/00000000/000.00.0.000/00/00000000000000000_000.00.0.000_000000.xxx","payable":"100","cashUser":"Admin","cashTime":"2018/12/11 16:54:54"},
{"id":"2","plateNo":"闽D02001","entryTime":"2018/12/12 8:20:19","entryPlace":"172.19.8.242","leaveTime":"2018/12/12 8:20:24","leavePlace":"172.19.8.243","imgName":"xxxx://000.00.0.000:0000/XX_XxxxxxXxxx/XxxXxxxxXxxxxxxxx/00000000/000.00.0.000/00/00000000000000000_000.00.0.000_000000.xxx","payable":"100","cashUser":"Admin","cashTime":"2018/12/12 8:20:24"}
]
}],
"resCode":0,
"resMsg":null}
1.2按出入口查询停车信息接口GetCarInOutInfoByPlace
http://IP:端口/api/ParkingInfo/GetCarInOutInfoByPlace
兼容旧版 http://IP:端口/api/pay2/GetCarInOutInfoByPlace
注:该接口数据对应收费后台的 报表统计->岗亭收费明细报表。
参数
string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
entryPlace |
string |
入口名称(可模糊输入) 出口名称(可模糊输入) 二选一 选填 |
leavePlace |
string |
|
startTime |
string |
开始时间 必填 yyyy-MM-dd HH:mm:ss |
endTime |
string |
结束时间 必填 yyyy-MM-dd HH:mm:ss |
pageIndex |
int |
分页数(>=1 必填) |
pageCount |
int |
每页数量(>=1 必填) |
返回值数据体定义
名称 |
数据类型 |
说明 |
totalNum |
string |
总数 |
detail |
array |
包含以下参数 |
id |
string |
编号 |
plateNo |
string |
车牌号 |
entryTime |
string |
入场时间 |
entryPlace |
String |
入口 |
leaveTime |
string |
出场时间 |
leavePlace |
string |
出口 |
imgName |
string |
出口抓拍图片url |
payable |
string |
支付金额(单位:分) |
cashUser |
string |
操作员 |
cashTime |
string |
收费时间 |
返回示例
{"data":[{"totalNum":"2",
"detail":[
{"id":"1","plateNo":"空818494","entryTime":"2018/12/11 15:53:54","entryPlace":"172.19.8.242","leaveTime":"2018/12/11 16:54:54","leavePlace":"172.19.8.243","imgName":"xxxx://000.00.0.000:0000/XX_XxxxxxXxxx/XxxXxxxxXxxxxxxxx/00000000/000.00.0.000/00/00000000000000000_000.00.0.000_000000.xxx","payable":"100","cashUser":"Admin","cashTime":"2018/12/11 16:54:54"},
{"id":"2","plateNo":"闽D02001","entryTime":"2018/12/12 8:20:19","entryPlace":"172.19.8.242","leaveTime":"2018/12/12 8:20:24","leavePlace":"172.19.8.243","imgName":"xxxx://000.00.0.000:0000/XX_XxxxxxXxxx/XxxXxxxxXxxxxxxxx/00000000/000.00.0.000/00/00000000000000000_000.00.0.000_000000.xxx","payable":"100","cashUser":"Admin","cashTime":"2018/12/12 8:20:24"}
]
}],
"resCode":0,
"resMsg":null}
1.3场内车查询接口 SearchParkingInfo
http://IP:端口/api/ParkingInfo/SearchParkingInfo
兼容旧版 http://IP:端口/api/pay2/SearchParkingInfo
注:该接口数据对应收费后台的 报表统计->场内车辆查询。
若车牌卡号都传空则默认返回所有场内车辆不做分页处理
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
plateNo |
string |
车牌号(可模糊输入) 选填 |
cardNo |
string |
卡号(主要给无牌车使用,有牌车传空) 选填 |
返回值数据体定义
名称 |
数据类型 |
说明 |
plateNo |
string |
车牌号 |
cardNo |
string |
卡号 |
entryTime |
string |
入场时间 yyyy-MM-dd HH:mm:ss |
entryPlace |
String |
入口 |
carType |
int |
车辆类型 详见附录1.1 |
imgName |
string |
入口抓拍图片url |
返回示例
{
"resCode":0,
"resMsg":"",
"data":[
{
"plateNo":"闽D02000",
"cardNo":"000001",
"entryTime":"2018-01-01 00:00:00",
"entryPlace":"入口",
"carType":1,
"imgName":"http://ip:port/***/***/***/****.jpg"
}
]
}
2.1无牌车出入场接口OnlineCarInOut
http://IP:端口/api/ParkingManage/OnlineCarInOut
兼容旧版 http://IP:端口/api/pay2/OnlineCarInOut
用途:针对无牌车扫出入口二维码进出场。
注:如果是出口,建议先调用接口3.1接口 判断是否需要缴费.如果未缴清费用,无法开闸
参数
string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
deviceCode |
string |
设备编码 必填 进出口的设备编号 |
deviceType |
int |
设备标识 0-设备编码 1-设备Ip |
cardNo |
string |
无牌车绑定的卡号 必填 (openId等唯一值) 单次停车入场和出场需要一致且在场内的不得重复 卡号长度必须大于12位(不包含12位) |
返回值数据体定义
名称 |
数据类型 |
说明 |
返回示例
{
"resCode":0,
"resMsg":"",
"data": null
}
流程:用户扫描入口二维码(由第三方进行开发) => 由第三方生成卡号,并根据设备编号请求该接口进行车辆入场操作
2.2空闲车位修改接口ModifyFreeSpace
http://IP:端口/api/ParkingManage/ModifyFreeSpace
兼容旧版 http://IP:端口/api/pay2/OnlineCarInOut
注:由于现场实际LED屏会配置显示各个区域的空余车位数.本接口仅支持修改其中一条空余车位.
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
areaCode |
int |
区域编号 选填 x没有填写则只修改排序第一的一条数据 |
freeSpaceNum |
int |
剩余车位数 必填 |
返回值数据体定义
名称 |
数据类型 |
说明 |
返回示例
{
"resCode":0,
"resMsg":"",
"data":null
2.3道闸控制接口 GateControl
http://IP:端口/api/ParkingManage/GateControl
注:仅是控制道闸开关,不做任何进出车流程逻辑处理。慎用
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
deviceCode |
string |
设备编码/设备Ip 必填 进出口的设备编号/设备Ip |
deviceType |
int |
设备标识 0-设备编码 1-设备Ip |
controlType |
int |
控制类型 1-开闸 2-关闸 11-常抬 12-常抬恢复 |
返回值数据体定义
名称 |
数据类型 |
说明 |
返回示例
{
"resCode":0,
"resMsg":"",
"data":null
}
2.4显示屏信息推送接口 ShowLedMsg
http://IP:端口/api/ParkingManage/ShowLedMsg
推送信息至LED显示屏显示
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
deviceCode |
string |
设备编码/设备Ip 必填 进出口的设备编号/设备Ip |
deviceType |
int |
设备标识 0-设备编码 1-设备Ip |
showInfo |
string |
待推送的信息 |
注:待推送的信息 x有分段则以|隔开 如 ABC|DEF 则会以两段推送至LED屏
返回值数据体定义
名称 |
数据类型 |
说明 |
返回示例
{
"resCode":0,
"resMsg":"",
"data":null
}
2.5免密支付车辆签约接口 RecordDensityPay
http://IP:端口/api/ParkingManage/RecordDensityPay
用途:适用于入场后再进行会员或者签约注册时,由第三方同步到车场,车主此次停车即可享受免密支付功能
参数
string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
plateNo |
string |
车牌号码 必填 |
返回值数据体定义
名称 |
数据类型 |
说明 |
返回示例
{
"resCode":0,
"resMsg":"",
"data":null
}
3. 费用支付部分
3.1停车费(账单)查询接口GetParkingPaymentInfo
http://IP:端口/api/ParkingPay/GetParkingPaymentInfo
兼容旧版http://IP:端口/api/pay2/GetParkingPaymentInfo
参数
string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
plateNo |
string |
车牌号, 设备编码(出口) 设备编码仅支持出口有停放车辆,并识别正确的情况不支持无牌车 三选一必填 |
cardNo |
string |
|
deviceCode |
string |
返回值数据体定义
名称 |
数据类型 |
说明 |
orderNo |
string |
账单号 |
plateNo |
string |
车牌号 |
cardNo |
string |
卡号、票号、惟一标识号 |
entryTime |
string |
入场时间 (yyyy-MM-dd HH:mm:ss) |
payTime |
string |
付款(查询费用)时间 |
elapsedTime |
Int |
停车时长(分钟) |
imgName |
string |
停车入场图片URL |
payable |
int |
应付金额 (单位 分) |
delayTime |
int |
收费后允许延时出场的时间限制(分钟),默认:15分钟 |
totalFee |
string |
总费用,单位分 |
payedFee |
string |
已支付费用,单位分 |
outTime |
string |
出场时间格式: yyyy-MM-dd HH:mm:ss 场内查询为查询时间 |
返回示例
{
"data":
[{
"orderNo":"000120181212173448477D02000",
"plateNo":"闽D02000",
"entryTime":"2018-12-10 09:59:12",
"payTime":"2018-12-12 17:34:48",
"elapsedTime":3336,
"imgName":"xxxx://000.00.0.000:0000/XX_XxxxxxXxxx/XxxXxxxxXxxxxxxxx/00000000/000.00.0.000/00/00000000000000000_000.00.0.000_000000.xxx",
"payable":22600,
"delayTime":10,
"totalFee":23600,
"payedFee":1000,
"outTime":"2018-12-12 17:34:48"
}],
"resCode":0,
"resMsg":null
}
3.2停车费支付(账单同步)接口PayParkingFee
http://IP:端口/api/ParkingPay/PayParkingFee
兼容旧版http://IP:端口/api/pay2/PayParkingFee
参数
string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
orderNo |
string |
车场提供的订单号 必填 平台订单号各平台自己维护 |
amount |
int |
支付金额,单位为分 必填 |
discount |
int |
车场免费金额,单位为分 必填 注:除减免金额/时长外,车场活动免费的金额 |
payType |
Int |
收费终端 必填 4:微信平台 5:APP(xx/IOS) |
payMethod |
int |
支付金额(amount)的付款方式 默认与payType一致 4: 微信 5:支付宝 必填 |
freeMoney |
int |
减免总金额(单位 分) 必填 |
freeTime |
int |
减免总时长(单位 分钟) 必填 |
freeDetail |
string |
减免详情(json数组格式)高级抵用报表记录 例如: [{"type": 0,"money":100,"time":0,"code":"1234567"},........] 无减免数据可为空 |
freeDetail数据:
名称 |
数据类型 |
说明 |
money |
string |
金额
|
time |
string |
时间
|
code |
int |
会员id/抵扣券编号/购物小票号 |
type |
int |
抵扣来源:0:积分抵扣1:抵扣券2:购物小票等 |
返回值数据体定义
名称 |
数据类型 |
说明 |
parkingTime |
int |
总停车时间(分钟) |
返回示例
{
"resCode":0,
"resMsg":"",
"data":
[{"parkingTime": 150}]
}
3.3停车优惠减免接口ParkingFree
http://IP:端口/api/ParkingPay/ParkingFree
用途:该接口只针对停车费减免抵扣。无需获取订单号及优惠券详情。适用部分车场直接入场抵扣或其他特殊情况使用 不可用于正常支付停车费用
参数
string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
plateNo |
string |
车牌号 卡号/票号 二选一 选填 |
cardNo |
string |
|
freeMoney |
int |
优惠金额 单位:分 |
freeTime |
int |
优惠时间 单位:秒 |
payType |
Int |
收费终端 必填 4:微信平台 5:APP(xx/IOS) |
payMethod |
int |
支付金额(amount)的付款方式 默认与payType一致 4: 微信 5:支付宝 必填 |
remark |
string |
优惠详情 |
返回值数据体定义
名称 |
数据类型 |
说明 |
orderNo |
string |
车场本地订单号 |
返回示例
{
"resCode":0,
"resMsg":"",
"data":
[{"orderNo": 123456789}]
}
3.4订单支付状态查询接口GetPaymentStatus
http://IP:端口/api/ParkingPay/GetPaymentStatus
兼容旧版http://IP:端口/api/pay2/GetPaymentStatus
用途:查询由下行接口3.1中获取的订单号及缴费机请求时订单号的支付状态
参数
string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
orderNo |
string |
订单号 必填 |
返回值数据体定义
名称 |
数据类型 |
说明 |
status |
string |
订单状态 0:未支付,1:已支付 |
返回示例
{ "data":[{"status":"1"}],
"resCode":0,
"resMsg":null
}
3.5找零信息查询接口GetPayChargeInfo
http://IP:端口/api/ParkingPay/GetPayChargeInfo
兼容旧版http://IP:端口/api/pay2/GetPayChargeInfo
用途:针对缴费机第三方找零的标准接口
注:对接方需要根据上行接口5.2找零二维码接口 开发一个找零二维码界面用于用户找零
参数
string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
orderNo |
string |
找零订单号 必填 |
返回值数据体定义
名称 |
数据类型 |
说明 |
orderNo |
string |
订单号原样返回 |
plateNo |
string |
车牌号码 |
cardNo |
string |
卡号/票号 |
comeTime |
string |
入场时间 |
payMoney |
int |
现金应缴金额 单位:分 |
paidAmount |
int |
车主投币金额 单位:分 |
ifCharge |
int |
1已找零,0未找零 |
返回示例
{ "data":[{"status":"1"}],
"resCode":0,
"resMsg":[
{
"orderNo":"0215646456465",
"plateNo":"闽A12344",
"comeTime":"1972-01-01 00:00:00",
"payMoney":1100,"paidAmount":15000,"ifCharge":1
}
]
}
3.6找零成功通知接口PayChargeNotice
http://IP:端口/api/ParkingPay/PayChargeNotice
兼容旧版http://IP:端口/api/pay2/PayChargeNotice
用途:针对缴费机第三方找零的标准接口
参数
string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
orderNo |
string |
找零订单号 必填 |
chargeType |
string |
找零类型 0-微信 1-支付宝 必填 |
UserAccount |
string |
用户微信账号或支付宝账号 选填 |
返回值数据体定义
名称 |
数据类型 |
说明 |
orderNo |
string |
订单号原样返回 |
返回示例
{
"resCode":0,
"resMsg":"",
"data":[{"orderNo":"0215646456465"}]
}
3.7找零数据查询接口PayChargeReport
http://IP:端口/api/ParkingPay/PayChargeReport
兼容旧版http://IP:端口/api/pay2/PayChargeReport
用途:
查询指定时间范围内的找零数据 及 全部未找零部分
只适用于速停车找零部分
参数
string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
startTime |
string |
开始时间 必填 yyyy-MM-dd HH:mm:ss |
endTime |
string |
结束时间 必填 yyyy-MM-dd HH:mm:ss |
pageIndex |
int |
分页数(>=1 必填 页码) |
pageCount |
int |
每页数量(>=1 必填) |
返回值数据体定义
名称 |
数据类型 |
说明 |
orderNo |
string |
找零订单号 |
plateNo |
string |
车牌号 |
cardNo |
string |
卡号 |
entryTime |
string |
入场时间 异常数据时间为 1972-01-01 00:00:00 |
payMoney |
int |
现金应缴金额 单位:分 |
paidAmount |
int |
车主投币金额 单位:分 |
ifCharge |
int |
是否已找零(1已找零,0未找零) |
chargeType |
string |
找零类型 0-微信 1-支付宝 |
UserAccount |
string |
用户微信账号或支付宝账号 |
paidTime |
string |
投币时间 yyyy-MM-dd HH:mm:ss |
chargeTime |
string |
找零时间 未找零的数据为空字符 |
remark |
string |
返回示例
{ "data":[{"status":"1"}],
"resCode":0,
"resMsg":[
{
"orderNo":"0215646456465",
"payMoney":1200,
"paidAmount":1500,
"ifCharge":0,
"chargeType":0,
"userAccount":"123123123123",
"paidTime":"2019-01-01 00:00:00",
"chargeTime":"2019-01-01 00:00:00",
"remark":""
}
]
}
4. 内部车管理部分
4.1固定车(同卡多车)新增接口AddCarCardNo
http://IP:端口/api/ParkingCard/AddCarCardNo
兼容旧版http://IP:端口/api/card2/AddCarCardNo
参数
string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
cardName |
string |
卡片名称 必填 |
useName |
string |
户主名 必填 |
tel |
string |
户主电话 选填 |
roomId |
string |
|
plateDetails |
string |
Json数组字符串 [{"plateNo":"A12345","etcNo":"XXXXXX"}] plateNo: 车牌号 etcNo: IC卡id: 建议用公司发卡器读出的卡号为准. 注:车牌号和IC卡号只支持2选一 必填 |
carType |
int |
固定车类型 详见附录 1.1必填 |
spaceNum |
String |
占用车位数 必填 |
validFrom |
string |
开始时间 必填 (yyyy-MM-dd HH:mm:ss) |
validTo |
string |
结束时间 必填 (yyyy-MM-dd HH:mm:ss) |
返回值数据体定义
名称 |
数据类型 |
说明 |
cardId |
int |
新增的卡片编号ID |
请求参数示例:
{
"parkCode": "123",
"cardName":"123"
"plateDetails": "[{\"plateNo\":\"A12345\",\"etcNo\":\"\"}]",
"carType": 1,
"spaceNum": "2",
"ValidFrom": "2018-08-01 00:00:00",
"ValidTo": "2018-08-31 23:59:59"
}
返回示例
{ "data":[{"cardId":5}],
"resCode":0,
"resMsg":null
}
4.2固定车(同卡多车)修改接口ModifyCarCardNo
http://IP:端口/api/ParkingCard/ModifyCarCardNo
兼容旧版http://IP:端口/api/card2/AddCarCardNo
参数
string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
cardId |
int |
卡片id 不能为空,修改需要正对指定的固定车卡 必填 |
cardName |
string |
卡片名称 选填 |
useName |
string |
户主名 选填 |
tel |
string |
户主电话 选填 |
roomId |
string |
房间号 选填 |
plateDetails |
string |
Json数组字符串 选填 [{"plateNo":"A12345","etcNo":"XXXXXX","type":1}] plateNo(string): 车牌号 etcNo(string): IC卡id: 建议用公司发卡器读出的卡号为准. 注:车牌号和IC卡号只支持2选一 type(int): 0 删除, 1: 新增 如不对车牌做处理请传空 |
validFrom |
string |
开始时间建议00:00:00 选填 (yyyy-MM-dd HH:mm:ss) 如果不修改,传空字符串 |
validTo |
string |
结束时间 建议23:59:59 选填 (yyyy-MM-dd HH:mm:ss) 如果不修改,传空字符串 |
spaceNum |
string |
总车位数 选填 如果不修改,传空字符串 |
返回值数据体定义
名称 |
数据类型 |
说明 |
请求参数示例:
{
"parkCode": "123",
"cardId": "135",
"plateDetails": "[{\"plateNo\":\"A12345\",\"etcNo\":\"\",\"type\":1}]",
"ValidFrom": "2018-08-01 00:00:00",
"ValidTo": "2018-08-31 23:59:59",
"totalSPNum": 10
}
返回示例
{
"resCode":0,
"resMsg":"",
"data":null
}
、
4.3固定车(同卡多车)删除接口DeleteCarCardNo
http://IP:端口/api/ParkingCard/DeleteCarCardNo
兼容旧版http://IP:端口/api/card2/AddCarCardNo
参数
string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
cardId |
int |
卡片id 不能为空,删除指定的固定车卡片 必填 |
返回值数据体定义
名称 |
数据类型 |
说明 |
请求参数示例:
{
"parkCode": "123",
"cardId":1
}
返回示例
{
"resCode":0,
"resMsg":"",
"data":null
}
4.4固定车(同卡多车)车牌管理接口CarCardNoManage
http://IP:端口/api/ParkingCard/CarCardNoManage
注意:该接口只做车牌处理,若卡片下只剩下一个车牌时,无法做删除处理,若要删除,请直接调用4.3接口删除卡片
参数
string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
cardId |
int |
卡片id 不能为空,指定的固定车卡片 必填 |
plateNo |
string |
车牌号码 |
oldplateNo |
string |
旧车牌号(修改删除时必填,其他时候放空即可) |
isCard |
int |
0-卡号 1-车牌号 |
modifyType |
int |
0-新增 1-修改 2-删除 |
返回值数据体定义
名称 |
数据类型 |
说明 |
请求参数示例:
{
"parkCode": "123",
"cardId":1,
"plateNo":"闽D02000",
"oldplateNo":"闽D02001",
"modifyType":1
"isCard":0
}
返回示例
{
"resCode":0,
"resMsg":"",
"data":null
}
4.5固定车(同卡多车)查询接口GetCarCardInfo
http://IP:端口/api/ParkingCard/GetCarCardInfo
兼容旧版http://IP:端口/api/card2/AddCarCardNo
参数
string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
|
plateNo |
string |
车牌号, 卡片id 若都不传,则默认返回全部车辆数据 |
cardId |
int |
返回值数据体定义
名称 |
数据类型 |
说明 |
cardId |
int |
卡片id |
carType |
int |
固定车类型 详见附录 1.1 |
cardName |
string |
用户名 |
tel |
string |
用户手机号 |
roomId |
string |
房间号 |
areaList |
array |
所属区域 ["地库","地面"] |
plateDetails |
string |
Json数组字符串 [{"plateNo":"A12345","etcNo":"XXXXXX"}] plateNo: 车牌号 etcNo: IC卡id: 建议用公司发卡器读出的卡号为准. 注:车牌号和IC卡号只支持2选一 |
validFrom |
string |
有效期开始时间 yyyy-MM-dd 00:00:00 |
validTo |
string |
有效期结束时间 yyyy-MM-dd 00:00:00 |
validValue |
int |
卡内余额(充值车:分,计次车:次) |
spaceNum |
string |
总车位数 |
lastUpdateTime |
string |
最后一次更新时间 yyyy-MM-dd 00:00:00 |
返回示例
{"data":[
{ "cardId":5,
"carType":1,
"cardName":"XXX",
"tel":"186********",
"roomId":"X-521",
"areaList":["地库","地面"],
"plateDetails":"[{\"plateNo\":\"A12345\",\"etcNo\":null},{\"plateNo\":null,\"etcNo\":\"AJSD5646SD\"}]",
"validForm":"2018-01-01 00:00:00",
"validTo":"2018-12-30 23:59:59"
"lastUpdateTime":"2018-12-30 23:59:59"}
],
"resCode":0,
"resMsg":null}
4.6固定车(同卡多车)充值接口PayCarCardFee
http://IP:端口/api/ParkingCard/PayCarCardFee
兼容旧版http://IP:端口/api/card2/AddCarCardNo
参数
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
cardId |
int |
卡片ID 必填 |
orderNo |
string |
订单号 选填 |
amount |
int |
支付金额(单位:分),必填 |
validFrom |
string |
充值开始时间建议00:00:00 (yyyy-MM-dd HH:mm:ss) 必填 |
validTo |
string |
充值结束时间建议23:59:59 (yyyy-MM-dd HH:mm:ss) 必填 |
返回值数据体定义
名称 |
数据类型 |
说明 |
返回示例
{
"resCode":0,
"resMsg":"",
"data": null
}
4.7固定车充值规则查询接口GetCardProduct
http://IP:端口/api/ParkingCard/GetCardProduct
兼容旧版http://IP:端口/api/card2/AddCarCardNo
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
carType |
int |
固定车类型 详见附录 1.1 必填 |
返回值数据体定义
名称 |
数据类型 |
说明 |
ruleName |
string |
规则名称 |
rechargeAmount |
int |
充值数额 |
rechargeType |
int |
充值类型(0 钱(单位:分),1 月,2 天,3 小时,4次) |
basicMoney |
int |
基本金额(单位:分) |
sentAmount |
int |
赠送数额 |
sentType |
Int |
赠送类型(0 钱(单位:分),1 月,2 天,3 小时,4次) |
返回示例
{
"resCode":0,
"resMsg":"",
"data":[{
"ruleName":"月租",
"rechargeAmount":1,
"rechargeType":1,
"sentAmount":1,
"snetType": 1}]
}
4.8黑名单管理接口BlackListControl
http://IP:端口/api/ParkingCard/BlackListControl
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
blackId |
int |
黑名单编号,新增时为0 修改和删除时为对应的黑名单编号 必填 |
plateNo |
string |
车牌号码(新增时必填,其他选填) |
remark |
string |
黑名单原因(备注) 选填 |
controlType |
int |
0-新增 1-修改 2-删除 |
返回值数据体定义
名称 |
数据类型 |
说明 |
blackId |
int |
黑名单编号(新增时返回新增的编号,修改和删除时原样返回) |
返回示例
{
"resCode":0,
"resMsg":"",
"data":[{"blackId":1}]
}
4.9黑名单查询接口GetBlackInfo
http://IP:端口/api/ParkingCard/GetBlackInfo
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
plateNo |
string |
车牌号码 选填(放空则返回所有黑名单车辆) |
返回值数据体定义
名称 |
数据类型 |
说明 |
blackId |
int |
黑名单编号 |
plateNo |
string |
车牌号码 |
remark |
string |
黑名单原因(备注) |
返回示例
{
"resCode":0,
"resMsg":"",
"data":[{"blackId":1,"plateNo":"闽A12345","remark":"违章停车"}]
}
5. 预约车部分
5.1预约车新增接口AddBookingCar
http://IP:端口/api/ParkingBook/AddBookingCar
兼容旧版http://IP:端口/api/book/AddBookingCar
注:暂时只支持预约全部区域
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
plateNo |
string |
车牌号码 必填 |
preMoney |
int |
预缴金额 单位:分 必填 |
validFrom |
string |
开始时间 yyyy-MM-dd HH:mm:ss 必填 |
validTo |
string |
结束时间 yyyy-MM-dd HH:mm:ss 必填 |
bookType |
int |
预约类型: 必填 0在预约时间内多次进出,1只能一次进出 |
promptly |
Int |
是否立即生效 0-是 1-否 |
注:立即生效 即车辆已在场内的且入场时间处于预约期内则直接变更为预约车出场即可享受预约车规则,反之在场内的该车辆类型不变,下次进场才生效。
返回值数据体定义
名称 |
数据类型 |
说明 |
bookId |
int |
预约编号 |
返回示例
{
"resCode":0,
"resMsg":"",
"data":[{"bookId":1}]
}
5.2预约车修改接口ModifyBookingCar
http://IP:端口/api/ParkingBook/ModifyBookingCar
兼容旧版http://IP:端口/api/book/AddBookingCar
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
bookid |
int |
预约编号 必填 |
validFrom |
string |
开始时间 选填 (yyyy-MM-dd HH:mm:ss) |
validTo |
string |
结束时间 选填 (yyyy-MM-dd HH:mm:ss) |
bookType |
int |
预约类型 选填 0在预约时间内多次进出,1只能一次进出 |
modifyType |
int |
修改类型 必填 0-修改 1-删除 |
promptly |
Int |
是否立即生效 0-是 1-否 |
注:立即生效 即车辆已在场内的且入场时间处于预约期内则直接变更为预约车出场即可享受预约车规则,反之在场内的该车辆类型不变,下次进场才生效。
返回值数据体定义
名称 |
数据类型 |
说明 |
bookId |
int |
预约编号 |
返回示例
{
"resCode":0,
"resMsg":"",
"data":[{"bookId":1}]
}
5.3预约车查询接口GetBookingCar
http://IP:端口/api/ParkingBook/GetBookingCar
兼容旧版http://IP:端口/api/book/AddBookingCar
注:只显示当前已生效或已经在使用的前五条记录
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
plateNo |
string |
车牌号 必填 |
返回值数据体定义
名称 |
数据类型 |
说明 |
bookId |
int |
预约编号 |
plateNo |
string |
车牌号 |
preMoney |
int |
预缴金额 单位:分 |
validFrom |
string |
开始时间 (yyyy-MM-dd HH:mm:ss) |
validTo |
string |
结束时间 (yyyy-MM-dd HH:mm:ss) |
bookType |
int |
预约类型:0在预约时间内多次进出,1只能一次进出 |
isCarIn |
Int |
预约时间内是否已入场 0-否 1-是 |
返回示例
{
"resCode":0,
"resMsg":"",
"data":[{
"bookid":1,
"plateNo":"闽D02000",
"preMoney":100,
"ValidFrom": "2018-08-01 00:00:00",
"ValidTo": "2018-08-31 23:59:59"
"bookType":1
}]
}
四、附录
注:该附录下所有类型值为标准系统的,非标的部分请车场自行裁定
1.1 车辆类型
名称 |
数据值 |
说明 |
临时车 |
0 |
临时车不属于固定车类型 |
VIP车 |
1 |
|
月租车 |
2 |
|
充值车 |
3 |
|
时租车 |
4 |
|
产权车 |
5 |
|
计次车 |
6 |
|
贵宾卡 |
7 |
|
员工卡 |
8 |
|
大客车 |
9 |
|
预约车 |
100 |
|
共享泊位车 |
99 |
共享泊位车辆,业务流程跟其他内部车一样,不计停车费,直接开闸入场,但是系统需要知道它是共享泊位车辆 |
1.2 出口岗亭/缴费机 支付类型
名称 |
数据值 |
说明 |
现金支付 |
0 |
|
POS支付 |
1 |
|
卡支付 |
2 |
|
易通卡支付 |
3 |
|
微信 |
4 |
|
支付宝 |
5 |
|
第三方微信 |
6 |
|
第三方支付宝 |
7 |
|
预约车 |
100 |
|
1.3 终端支付明细-标准系统 终端类型
名称 |
数据值 |
说明 |
商家客户端 |
0 |
|
中央交费点 |
1 |
|
出口岗亭 |
2 |
|
场内缴费机 |
3 |
|
手机 |
4 |
|
xxAPP |
5 |
|
后付费 |
6 |
|
飞凡网APP |
7 |
|
壁挂式自助终端 |
8 |
|
折扣券发放机 |
9 |
|
会员系统 |
10 |
|
找车机缴费 |
11 |
|
出口缴费机 |
13 |
|
第三方对接(云) |
14 |
|
第三方对接(单) |
15 |
|
1.4 终端支付明细-标准系统 支付方式
名称 |
数据值 |
说明 |
现金 |
100 |
|
银行卡 |
101 |
|
电子现金 |
102 |
|
交通卡 |
103 |
地方城市交通卡(E卡通) |
微信 |
104 |
|
支付宝 |
105 |
|
线上银联 |
106 |
|
抵用券 |
107 |
|
充值车卡 |
108 |
充值车账户扣支付停车费 |
转账 |
109 |
|
后付费 |
110 |
|
第三方微信 |
111 |
|
第三方支付宝 |
112 |
|
积分兑换 |
113 |
第三方会员系统 |
计次车卡 |
114 |
|
小票兑换 |
115 |
第三方系统 |
1.5 终端设备类型
名称 |
数据值 |
说明 |
收费电脑/缴费机 |
1 |
|
相机 |
2 |
|
LED屏 |
3 |
出入口显示屏 |
出入口道闸 |
4 |
|
相机拍照接口 GetPhoto
http://IP:端口/api/ParkingManage/GetPhoto
注:仅是控制相机拍照,不做任何进出车流程逻辑处理。慎用
Post 的参数string data (详见参数格式定义)
名称 |
数据类型 |
说明 |
parkCode |
string |
停车场编号 必填 |
deviceCode |
string |
设备编码/设备Ip 必填 进出口的设备编号/设备Ip |
deviceType |
int |
设备标识 0-设备编码 1-设备Ip |
返回值数据体定义
名称 |
数据类型 |
说明 |
imageUrl |
string |
图片地址 |
第 69 页 共 69 页