《ZKTecoParking数据推送协议.docx》由会员分享，可在线阅读，更多相关《ZKTecoParking数据推送协议.docx（36页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、ZKTecoParking数据推送协议协议版本:Ver: 1.2软件版本：ZKTecoParking 104.5更新时间:2022-06编 写：郑显勇字段说明字段字段类型备注是否必填操作状态statusint操作状态，大于等于0为成功Y状态描述messagestrng状态描述Y三、出场收费记录推送数据推送通信方式：HTTP数据格式：JSON提交方式：POST编码：UTF-8Headers 中 DataType=Outrecord字段说明字段字段类型备注是否必填流水号Parkingserialstrng停车流水，一次停车唯一，入场、出场使用同一个停车流水Y车牌号码CarNumberstrng车牌
2、号码Y出场通道名称ChannelNamestrng车辆出场的通道名称Y事件类型EventTypeint参照附录2Y出场时间OutTimeStrng 格式车辆出场时间Yyyyy-MM-ddHH:mm:ss”车牌颜色CarColorstrng车牌颜色Y出场抓拍图片base64ImageDatastmg抓拍的出场照片岗亭标识Workstationstring岗亭标识Y操作员OperationllserNamestring操作员Y应收金额ReceivableAmountint （单位分）应收金额Y实收金额ReceiveAmountint （单位分）实收金额Y优惠金额DiscountAmountint
3、（单位分）优惠金额Y付款方式PayMothint车主付款方式1 :现金、2 :刷卡、3:微 信、0云停车代扣、4支付宝、8微信 9：云停车代扣10公交卡11储值卡扣款12 ETC 13互通区域未到缴费口计费， 提前计费实际还未缴费，有部分重复的付 款方式，可以自己规划Y返回字段说明字段说明字段字段类型备注是否必填操作状态statusint操作状态，大于Y等于0为成功状态描述messagestrng状态描述Y设备状态推送数据推送通信方式：HTTP数据格式：JSON提交方式：POST编码：UTF-8Headers 中 DataType=Devicestatus每20秒推送一次字段说明字段字段类型备
4、注是否必填设备状态列表DeviceStatusListList设备状态信息参考设备状态信息Y设备状态信息字段说明字段字段类型备注是否必填设备IPDevicelPString设备的IP地址Y设备状态DevicestatusInt0离线,1在线Y设备名称DeviceNameString设备名称Y返回字段说明字段说明字段字段类型备注是否必填操作状态statusInt操作状态，大于Y等于0为成功状态描述messageString状态描述Y五、车辆进出场确认放行此功能只针对临时车并且收费为0时生效数据推送通信方式：HTTP数据格式：JSON提交方式：POST编码：UTF-8Headers 中 DataT
5、ype=CheckCarNumber字段说明字段字段类型备注是否必填通道名称ChannelNameString当前设别车牌的通道名称Y车牌号码CarNumberStringY进出状态InOrOutInt1入场2出场Y进出场抓拍图片 base64ImageDataStringN操作员OperationllserNamestring操作员Y返回字段说明字段说明字段字段类型备注是否必填操作状态statusInt操作状态，大于等于0Y为成功状态描述messageString状态描述Y是否允许通行canpassInt0不允许,1允许Y缘由reasonString不允许放行的原因canpass 为 0时必
6、填六、剩余车位推送当车位数量变化时推送数据数据推送通信方式：HTTP数据格式：JSON提交方式：POST编码：UTF-8Headers 中 DataType=ParkFreeSpaces字段说明字段字段类型备注是否必填区域剩余车位信息列表ParkFreeSpacesListList区域车位信息参考区域车位信息Y区域车位信息字段说明字段字段类型备注是否必填区域名称NameStringY区域总车位ParkLotIntY区域剩余车位FreeSpacesIntY返回字段说明字段说明字段字段类型备注是否必填操作状态statusInt操作状态，大于等于0为成功Y状态描述messageString状态描述Y
7、七、获取部门信息第三方从停车场软件中获取信息，软件需先开启服务数据请求通信方式：HTTP返回数据格式：JSON请求方式：GET编码：UTF-8例：baseurl+?RequestDataTypeDepLrtment字段说明字段字段类型备注是否必填请求数据类型RequestDataTypeStringDepartmentY返回字段说明字段说明字段字段类型备注是否必填操作状态statusInt操作状态，大于等于0为成功Y状态描述messageString状态描述Y返回的数据DataListv部门信息部门新消息参考部门信息说明Y部门信息字段说明字段字段类型备注是否必填IDIDIntY编号CodeSt
8、ringY部门名称NameStringY上级部门IDParentIDIntN八、获取车辆类型信息第三方从停车场软件中获取信息，软件需先开启服务数据请求通信方式：HTTP返回数据格式：JSON请求方式：GET编码：UTF-8请求地址：baseurl+?RequestDataTyperCaType字段说明字段字段类型备注是否必填请求数据类型RequestDataTypeStringCarTypeY返回字段说明字段说明字段字段类型备注是否必填操作状态statusInt操作状态，大于等于0为成功Y状态描述messageString状态描述Y返回的数据DataList车辆类型信息参考车辆类型信息说明Y车
9、辆类型信息字段说明字段字段类型备注是否必填IDIDIntY名称NameStringY类型TypeInt1固定车2临时车Y编号CodeStringY九、获取人员车牌信息8.1获取人员车牌数数据请求通信方式：HTTP返回数据格式：JSON请求方式：GET编码：UTF-8例：如查询 车主张三的所有车辆的数量，则URL为：baseurl+?RequestDataType二CarNumberCount&PersonName=5byg5LiJ字段说明字段字段类型备注是否必填请求数据类型RequestDataTypeStringCarNumberCountY车主姓名PersonNameString经过bas
10、e64编码后N车牌号码CarNumberString经过base64编码后的车牌号码(utf-8 )N(当车主姓名 与车牌号码同 时存在时，优先 使用车牌号码 作为查询条件)返回字段说明操作状态statusInt操作状态，大于等于o为车牌数量Y状态描述messageString状态描述Y8.2分页获取人员车牌信息数据请求通信方式：HTTP返回数据格式：JSON请求方式：GET编码：UTF-8例：如获取车主张三所有车辆的第一页（页面大小为1 ）,则URL为：baseurl+?RequestDataType=CarNumber&PersonName=5byg5LiJ&Pagesize=1&Ciir
11、renPage=1字段说明字段字段类型备注是否必填请求数据类型RequestDataTypeStringCarNumberY车主姓名PersonNameString经过base64编码后N车牌号码CarNumberString经过base64编码后的车牌号码（utf-8 ）N（当车主姓名 与车牌号码同 时存在时，优先 使用车牌号码 作为查询条件）页面大小PagesizeI ntY页码CurrenPageI ntY返回字段字段说明字段字段类型备注是否必填目录ZKTecoParking数据推送协议1更新记录4使用说明5一、车牌号码推送6二、入场记录推送8三、出场收费记录推送10四、设备状态推送12
12、五、车辆进出场确认放行13六、剩余车位推送14七、获取部门信息15八、获取车辆类型信息16九、获取人员车牌信息17十、获取访客贵宾车信息21十一、获取设备信息23十二、获取通道信息24十三、获取区域信息26十四、获取区域剩余车位信息27十五、获取入场记录28十六、获取出场记录30十七、获取收费记录32十八、添加车辆信息34操作状态statusInt操作状态，大于等于0为成功Y状态描述messageString状态描述Y返回的数据DataList人员车牌信息参考人员信息说明Y人员车牌信息字段说明字段字段类型备注是否必填人员IDPerson IDIntY人员姓名PersonNameStringY车
13、主编号PersonNoStringY车牌号码IDCarNumberlDIntY车牌号码CarNumberstringY车辆类型CarTypestring05 08Y车辆类型描述CarTypeDisplaystringY有效期开始时间StartTimestring时间格式“丫丫丫丫-MM-DD”,当车辆类型为B时，有效期不生效Y有效期结束时间EndTimestring时间格式“丫丫丫丫-MM-DD”,当车辆类型为B时，有效期不生效Y余额Amountint余额，单位分N部门名称DepartMentstring车主所在部门N十、获取访客贵宾车信息9.1 获取访客车辆数*数据请求通信方式：HTTP返回
14、数据格式：JSON请求方式：GET编码:UTF-8例：如查询车牌号码为辽A32111的数量，则URL为：baseurl+?RequestDataType=/IPCarNumberCoijnt&CarNijmbe=6L69QTMyMTEx字段说明字段字段类型备注是否必填请求数据类型RequestDataTypeStringVIPCarNumberCountY车牌号码CarNumberString经过base64编码后的车牌号码（utf-8 ）N返回字段说明操作状态statusI nt操作状态，大于等于0为获取到得数据数量Y状态描述messageString状态描述Y9.2 分页获取访客信息数据请
15、求通信方式：HTTP返回数据格式：JSON请求方式：GET编码：UTF-8例：如分页获取辽A32111的车牌记录，第一页，页面大小为3 ,则URL为：baseurl+?RequestDataType二VIPCaNumber&Pagesize=3&CurrenPage=1字段说明字段字段类型备注是否必填请求数据类型RequestDataTypeStringVIPCarNumberY车牌号码CarNumberString经过base64编码后的车牌号码(utf-8 )N页面大小PagesizeI ntY页码CurrenPageI ntY返回字段说明操作状态statusInt操作状态，大于等于0为成
16、功Y状态描述messageString状态描述Y返回的数据DataListv访客车辆,参考访客车辆信息说明Y访客车辆字段说明字段字段类型备注是否必填IDIDIntY人员姓名PersonNameStringN车牌号码PersonNoStringY车牌类型CarTypeString“W”访客贵宾 车，黑名 单，“C永久VIP车辆Y有效期开始时间StartTimeString时间格式“ yyyy-MM-ddHH:mm:ss”,当车辆类型为B时，有效期不生效车牌类型为W时必填，其他类型无意义有效期结束时间EndTimeString时间格式yyyy-MM-ddHH:mm:ss”,当车辆类型为B时，有效期
17、不生效车牌类型为W时必填，其他类型无意义H一、获取设备信息第三方从停车场软件中获取信息，软件需先开启服务数据请求通信方式：HTTP返回数据格式：JSON请求方式：GET编码：UTF-8例:baseurl+?RequestDataType=Device字段说明字段字段类型备注是否必填请求数据类型RequestDataTypeStringDeviceY返回字段说明字段说明字段字段类型备注是否必填操作状态statusInt操作状态，大于等于0为成功Y状态描述messageString状态描述Y返回的数据DataListv设备信息,参考设备信息说明Y设备信息字段说明字段字段类型备注是否必填IDIDIn
18、tY设备IPIPStringY设备名称NameStringY设备所属通道IDChannellDIntN十二、获取通道信息第三方从停车场软件中获取信息，软件需先开启服务数据请求通信方式：HTTP返回数据格式：JSON请求方式：GET编码：UTF-8例：baseurl+?RequestDataType=Channel字段说明字段字段类型备注是否必填请求数据类型RequestDataTypeStringChannelY返回字段说明字段说明字段字段类型备注是否必填操作状态statusInt操作状态，大于等于0为成功Y状态描述messageString状态描述Y返回的数据DataListv通道信息参考通
19、道信息说明Y通道信息字段说明字段字段类型备注是否必填IDIDIntY通道名称NameStringY通道类型StatusInt1 :大入、2 :大 出、3 :小进、4 :小出、5 :中央收 费定点、6 :中央 收费出口Y十三、获取区域信息第三方从停车场软件中获取信息，软件需先开启服务数据请求通信方式：HTTP返回数据格式：JSON请求方式：GET编码：UTF-8例：baseurl+?RequestDataTypeAea字段说明字段字段类型备注是否必填请求数据类型RequestDataTypeStringAreaY返回字段说明字段说明字段字段类型备注是否必填操作状态statusInt操作状态，大于
20、等于0为成功Y状态描述messageString状态描述Y返回的数据DataListv区域信息参考区域信息说明Y区域信息字段说明字段字段类型备注是否必填IDIDIntY区域名称NameStringY区域车位数ParkLotIntY十四、获取区域剩余车位信息第三方从停车场软件中获取信息，软件需先开启服务数据请求通信方式：HTTP返回数据格式：JSON请求方式：GET编码：UTF-8例：baseurl+?RequestDataType=PerkFneSpaces字段说明字段字段类型备注是否必填请求数据类型RequestDataTypeStringParkFreeSpacesY返回字段说明字段说明字
21、段字段类型备注是否必填操作状态statusInt操作状态，大于等于0为成功Y状态描述messageString状态描述Y返回的数据DataList区域剩余车位信息参考区域剩余车位信息说明Y区域剩余车位信息字段说明字段字段类型备注是否必填区域名称NameStringY区域总车位ParkLotI ntY区域剩余车位FreeSpacesI ntY十五、获取入场记录第三方从停车场软件中获取信息，软件需先开启服务数据请求通信方式：HTTP返回数据格式：JSON请求方式：GET编码:UTF-8例：如查询2021-01-08 11:51:56到2021-10-28 11:51:56期间，车牌号码为 辽AF1
22、C33的入场记录,贝ij URL 为：baseurl+?StartTime=2021 0811:51:56&RequestDataType=lnRecord&EndTime=2021 02811:51:56&CarNumber=6L69QUYxQzMz字段说明字段字段类型备注是否必填请求数据类型RequestDataTypeStringIn RecordY记录开始时间StartTimeString时间格式“ yyyy-MM-ddY记录结束时间EndTimeString时间格式yyyy-MM-ddHH:mm:ssMY车牌号码CarNumberString经过base64编码后的车牌号码(utf-
23、8 )N返回字段说明字段说明字段字段类型备注是否必填操作状态statusInt操作状态，大于等于0为成功Y状态描述messageString状态描述Y返回的数据DataListv入场记录,参考入场记录说明Y入场记录字段说明字段字段类型备注是否必填记录IDIDIntY入场通道IDChannellDIntY通道类型ChannelstateInt参考通道信息说明Y事件类型EventTypeIntY车辆状态StatusInt0已出场1未出场Y车牌号码CarNumberStringY入场通道名称ChannelNameStringY入场时间InTimeString格 式yyyy-MM-ddHH:mm:ss
24、十九、删除车辆信息36二十、标记车辆已出场37入场抓拍照片保存路径PhotoPathStringN停车流水ParkingserialStringN十六、获取出场记录第三方从停车场软件中获取信息，软件需先开启服务数据请求通信方式：HTTP返回数据格式：JSON请求方式：GET编码:UTF-8例：如查询2021-01-08 11:51:56到2021-10-28 11:51:56期间，车牌号码为 辽AF1C33的出场记录,贝ij URL 为：baseurl+?StartTime=2021 01 0811:51:56&RequestDataType=OutRecord&EndTime=2021 02
25、811:51:56&CarNumber=6L69QUYxQzMz字段说明字段字段类型备注是否必填请求数据类型RequestDataTypeStringOutRecordY记录开始时间StartTimeString时间格式yyyy-MM-ddY记录结束时间EndTimeString时间格式yyyy-MM-ddHH:mm:ssMY车牌号码CarNumberString经过base64编码后的车牌号码(utf-8 )N返回字段说明字段说明字段字段类型备注是否必填操作状态statusInt操作状态，大于等于0为成功Y状态描述messageString状态描述Y返回的数据DataListv出场记录参考出
26、场记录说明Y出场记录字段说明字段字段类型备注是否必填记录IDIDIntY出场通道IDChannellDIntY通道类型ChannelstateInt参考通道信息说明Y事件类型EventTypeIntY车牌号码CarNumberStringY出场通道名称ChannelNameStringY出场时间OutTimeString格 式yyyy-MM-ddHH:mm:ss出场抓拍照片保存路径PhotoPathStringN停车流水ParkingserialStringN十七、获取收费记录第三方从停车场软件中获取信息，软件需先开启服务数据请求通信方式：HTTP返回数据格式：JSON请求方式：GET编码:U
27、TF-8例：如查询2021-09-26 11:51:56到2021-10-28 11:51:56期间，车牌号码为 京A12356的收费记录,贝ij URL 为：baseurl+?StartTime=2021092611:51:56&Requ6stDataType=ChargeRecod&EndTime=2021102811:51:56&CaNumber=5LqsQTEyMzU2字段说明字段字段类型备注是否必填请求数据类型RequestDataTypeStringChargeRecordY记录开始时间StartTimeString时间格式“ yyyy-MM-ddHH:mm:ssY记录结束时间En
28、dTimeString时间格式yyyy-MM-ddHH:mm:ssY车牌号码CarNumberString经过base64编码后的车牌号码(utf-8 )N返回字段说明字段说明字段字段类型备注是否必填操作状态statusInt操作状态，大于等于0为成功Y状态描述messageString状态描述Y返回的数据DataListv收费记录参考收费记录说明Y收费记录字段说明字段字段类型备注是否必填记录IDIDIntY对应的入场记录IDIn record IDIntN对应的出场记录IDOutRecordIDIntY收费时间ChargeTimeInt时间格式“ yyyy-MM-ddHH:mm:ssnY付款
29、方式PayMethodInt车主付款方式1:现金、2 :刷卡、3:微信、0云停 车代扣、4支付 宝、8微信9: 云停车代扣10公交卡11储值 卡扣款12 ETC 13互通区域未到Y缴费口计费，提前 计费实际还未缴 费，有部分重复的 付款方式，可以自 己规划应收ReceivableAmountInt单位：分Y实收ReceiveamountInt单位：分Y停车流水ParkingserialStringN十八、添加车辆信息第三方向停车场软件中添加固定车，软件需先开启服务数据请求通信方式：HTTP返回数据格式：JSON请求方式：POST编码：UTF-8请求地址：baseurl(Headers 中 Da
30、taType=CarNumber)字段说明字段字段类型备注是否必填车牌号码CarNumberstringY车主姓名PersonNamestring车辆类型为固定车时为车主姓名车辆类型为固定车时为Y车主编号PersonNostring车辆类型为固定车时为车主编号车辆类型为固定车时为Y车辆类型CarTypestring05-08为固定 车，亚为访客贵 宾车，B为黑名 单车辆Y人员所属部门DepartMentstring人员所属部门N有效期开始时间StartTimestring时间格式“ yyyy-MM-ddHH:mm:ss”,当车辆类型为B时，有效期不生效Y（车辆类型为黑名单时不生效）有效期结束时
31、间EndTimestring时间格式“ yyyy-MM-ddHH:mm:ss”,当车辆类型为B时，有效期不生效Y（车辆类型为黑名单时不生效）车位号码ParkLotstring车位号码N金额AmountInt固定车续费金额N操作类型OperationTypeInt1增加、2延期、3、删除Y（删除请参考删除车辆信息说明）返回字段字段说明字段字段类型备注是否必填操作状态statusint操作状态，大于等于0为成功Y状态描述messagestrng状态描述Y例：如添加车牌号为京A11111的访客贵宾车车辆：鼾建接口斯日受口OCT新建授口新建接口接口说明 10 蝌Q分享文档0 脸与备份“ R开发中,S生
32、成代图POST-92.168.53.22:8231/ZKTecoParkingAPI/夕保存并归档Header Query Body 认证预执行国本后执行卸本Mock服刍汉本引入第三方妁S?“美化 出面化3提取字般和缁迹applicaton/)son -Cartiurter: “京Alllll，CarType: W, OperationType:l, -StrtTii*：-2e21-12-ei 2):59:59,*En(JTimew：-2022-12-01 23:59:59、字 ts殖POST- http:/192.168.53.22:8231/ZKTecoParkingAPI/Header
33、Query Body 认证预执行脚本后执行脚本Mock服务个导入参数位导出参数DataTypeCarNumber必埴 y类型十九、删除车辆信息字段说明字段字段类型备注是否必填车牌号码CarNumberstring需要删除的车牌号码用#号分隔Y车辆类型CarTypestring0508为固定 车，亚为访客贵 宾车，B为黑名 单车辆（删除固 定车时传05、Y06 , 07 , 08 都 可，否则就删除 访客和黑名单)操作类型OperationTypeInt3、删除Y二十、标记车辆已出场第三方向停车场软件发送车辆已经不在场内命令，软件需先开启服务数据请求通信方式：HTTP返回数据格式：JSON请求方
34、式：POST编码：UTF-8请求地址：baseurl(Headers 中 DataType=SetCarNumberHasOut)字段说明字段字段类型备注是否必填车牌号码CarNumberstringY返回字段字段说明字段字段类型备注是否必填操作状态statusint操作状态，大于等于0为成功Y状态描述messagestmg状态描述Y更新记录版本更新时间更新内容更新人员Ver : 1.02021.10基础版本郑显勇Ver : 1.12022.01增加使用说明郑显勇Ver : 1.22022.06增加剩余车位获取以及推送功能郑显勇使用说明协议分两部分ZK五：6焰基监控工作台车场管理爱）车辆仁息收
35、费规则系统设质报表查询用户权限第一部分：接口一至六，为停车场软件主动向第三方系统中推送数据，需要配置如下内容基本设2E数据库备份与还原配置文件特殊车牌处理数据上传车辆限行数据推送I服务器地址设置服务器地址|忸务器埴城|开启政建推送I数据推送设置推送数据口入场记录 口 出场收费记录 Q saAafge 口设备状森 口入场确认 口出场确认I其他设置本机服务|请输入开启眼务所使用的ips址| 启用眼芬保存参数说明服务器地址：第三方系统的服务地址；数据推送设置：勾选需要软件推送的数据；注：停车场软件无推送失败补传再次推送功能。如果停车场有多个岗亭,每个岗亭端软件都需要配置参数；第二部分：接口六至二十，
36、为第三方系统向停车场软件中请求数据参数说明本机服务：填入安装停车场软件所在计算机的IP地址，并启用服务;注：设置完成后软件需要重启，并以管理员身份运行，如果无法访问，请检查端口 8231是否被占用以及防火墙是否开启。如果停车场有多个 岗亭，并且公用一个数据库，只需要其中一台软件配置此参数即可； 停车场软件监听服务地址：baseurl 为 http:安装软件计算机的 IP 地址:8231/ZKTecoPakingAPI/一、车牌号码推送数据推送通信方式：HTTP数据格式：JSON提交方式：POST编码：UTF-8Headers 中 DataType=CarNumber字段说明字段字段类型备注是否
37、必填车牌号码CarNumberstringY车主姓名PersonNamestring车辆类型为固定车时为车主姓名车辆类型为固定车时为Y车主编号PersonNostring车辆类型为固定车时为车主编号车辆类型为固定车时为Y车辆类型CarTypestring0508为固定 车，川为访客贵 宾车，B为黑名 单车辆Y车辆类型描述CarTypeDisplaystring车辆类型为固定车时为Y有效期开始时间StartTimestring时间 格式“ yyyy-MM-ddHH:mm:ss”,当车辆类型为B时，有效期不生效Y（车辆类型为黑名单时不生效）有效期结束时间EndTimestring时间格式yyyy-MM-ddHH:mm:ss”,当车辆类型为B时，有效期不生效Y（车辆类型为黑名单时不生效）操作类型OperationTypeint1 :添加2 :删除（参考删除说明）3 :修改Y操作员OperationllserNamestring操作员Y车牌号码IDCarNumberlDint车牌号码的唯一ID ,第三方系统 不要使用此ID 作为自己的唯一ID，修改时可以 根据此ID来确 定需要修改的车 牌号码添加、修改时必传数据推送通信方式：HTTP提交方式：POST编码：UTF-8删除说明(Headers 中 DataType=DeleteCarNu