DSS-H平台停车场接口(webservice).doc

停车场web接口文档1. 停车场webservice接口21.1 接口说明21.1.1 接口规范21.1.2 服务地址21.2 接口详情21.2.1 停车场信息查询（编号、名称）21.2.2 车位信息（编号、停车场区域、摄像头编号、VIP车牌号）61.2.3 二维码定位信息91.2.4 查询设备通道信息111.2.5 停车场电子地图反向寻车121.2.6 查询车辆进出场记录161.2.7 更新道闸系统卡片充值信息171.2.8 更新卡片中的可视对讲门禁功能有效截止日期171.2.9 获取停车场车位总数和余位总数181.2.10 停车信息查询接口181.2.11 第三方缴费成功的通知接口191. 停车场webservice接口与第三方物业相关的接口，主要用于向外提供数据；1.1 接口说明1.1.1 接口规范采用SOPA协议参数以及返回结构采用JSON格式；1.1.2 服务地址停车场接口WSDL：http:/ip:端口/admin/services/ThirdPartyService?wsdl反向寻车接口Wsdl:http:/ip:端口/admin/services/FindCarService?wsdl1.2 接口详情1.2.1 停车场信息查询（编号、名称）接口名称：getParkinglot (String conditionJson, String pagerJson)；请求参数：conditionJson，pagerJson分别为json字符串；例：conditionJson json字符串格式parkingLotCode:dr1213,parkingLot:dr名称类型必填备注parkingLotCodeString否车场编号parkingLotString否车场名称备注：如果不需要设置条件，传入空字符串即可 例：pagerJson json字符串格式pageSize:10,currentPage:1名称类型必填备注currentPageInt否页码pageSizeInt否每页显示数目备注：如果不需要分页而查询所有记录，传入空字符串即可返回结果：例pager:totalPage:0,currentPage:1,previousPage:0,nextPage:0,pageSize:10,total:1,pageListSize:8,arrayList:id:1,parkingLot:dh,parkingLotCode:A1,totalLot:1000,idleLot:6,defaultProvince:31,fullDeal:1,isAutoControl:0,isAutoOnSluice:0,isOutAutoOnSluice:0,discernMode:1,isMonthlyAutoExit:1,isFreeAutoExit:1,attribute6:1,unknownCarExitMode:1,updateDate:Apr 2, 2015 10:06:40 AM,feeRuleIdList:1,1,1,idleLotCountMode:1,specialCar:,inMatchByte:,outMatchByte:,isUnInteriorAutoAlarm:1,attribute1:,attribute2:0,attribute3:,attribute4:0名称类型备注totalPageInt总页数currentPageInt当前页previousPageIntnextPageIntpageSizeInt每页条数totalInt总条数pageListSizeIntidLongparkingLotString车场名称parkingLotCodeString车场编号totalLotLong总车位idleLotLong余位defaultProvinceString默认省份fullDealInteger车场满位后处理isAutoControlInteger道闸是否自动控制isAutoOnSluiceInteger内部车是否自动放行isOutAutoOnSluiceInteger外部车是否自动放行discernModeInteger识别模式：1-车牌识别为主，2-刷卡识别为主isMonthlyAutoExitInteger月卡用户自动放行：0-否，1-是isFreeAutoExitInteger收费为零自动放行：0-否，1-是attribute6String冗余属性6unknownCarExitModeInteger未识别车辆放行模式：1-自动放行，2-按最低金额收费updateDateDate更新时间feeRuleIdListList用户类别收费规则关联IDidleLotCountModeInteger余位计算方式specialCarInteger特殊车辆inMatchByteString入口关心匹配字符outMatchByteString出口关心匹配字符isUnInteriorAutoAlarmInteger非内部车进行报警attribute1String冗余属性1attribute2String冗余属性2attribute3String冗余属性3attribute4String冗余属性41.2.2 车位信息（编号、停车场区域、摄像头编号、VIP车牌号）接口名称：getParkings(String conditionJson, String pagerJson)；请求参数：conditionJson，pagerJson分别为json字符串；例：conditionJson json字符串格式carportCode:P001,channelId:100001$1$1$0,carNum:12,carportName:车位1,carportStatus:1名称类型必填备注carportCodeString否车位编号channelIdString否车位与探测器关联时关联的探测器ID，用于区域类型为车位的情况carNumString否车位配置的专用车辆车牌，用逗号分隔carportNameString否车位名称carportStatusString否是否停车: 1-已停车，2-未停车；备注：carportCode、carportName、 carportStatus 为一组输入参数，进行查询时每一项都允许为空，若该组参数有一个不为空，channelId、carNum请勿选择，否则查询冲突。channelId进行查询时，其它输入参数请勿选择，否则查询冲突。carNum进行查询时，其它输入参数请勿选择，否则查询冲突。例：pagerJson json字符串格式pageSize:10,currentPage:1名称类型必填备注currentPageInt否页码pageSizeInt否每页显示数目备注：如果不需要分页而查询所有记录，传入空字符串即可返回结果：例pager:totalPage:0,currentPage:1,previousPage:0,nextPage:0,pageSize:10,total:4,pageListSize:8,arrayList:id:1,carportCode:1,carportName:1,carportShape:-228.60984455959,-189.84404145078;-178.60984455959,-189.84404145078;-178.60984455959,-245.84404145078;-228.60984455959,-245.84404145078;-228.60984455959,-189.84404145078,carportAllocation:0,carportStatus:2,mapId:1427349437126,memo:,carportCenterX:-203.60984455959,carportCenterY:-217.84404145078,carportType:1,carAreaType:0,parkingLotId:1,channelId:1000169$1$0$0,errorcode:名称类型备注totalPageInt总页数currentPageInt当前页码previousPageIntnextPageIntpageSizeInt每页条数totalInt总条数pageListSizeIntIdLongcarportCodeString车位编号,可以为字符;唯一编码carportNameString车位名称carportShapeString车位形状carportAllocationString是否分配: 0-未分配；1-已分配carportStatusString是否停车: 1-已停车,2-未停车；mapIdLong车位图层memoString备注carportCenterXString车位中心点的X值carportCenterYString车位中心点的Y值carportTypeString车位类型carAreaTypeString是否是停车区域parkingLotIdLong所属的停车场IDchannelIdString车位与探测器关联时关联的探测器ID，用于区域类型为车位的情况errorcodeString错误信息（1：通过车位名称、车位编号、车位状态这组参数进行查询时，摄像头编号或车牌号请勿选择！2：请选择摄像头编号或车牌号其中一项进行查询，以免发生查询冲突。）1.2.3 二维码定位信息接口名称：getSemacodeList (String pagerJson)；请求参数： pagerJson为json字符串；例：pagerJson json字符串格式pageSize:10,currentPage:1名称类型必填备注currentPageInt否页码pageSizeInt否每页显示数目备注：如果不需要分页而查询所有记录，传入空字符串即可返回结果：例pager:totalPage:0,currentPage:1,previousPage:0,nextPage:0,pageSize:10,total:2,pageListSize:8,arrayList:id:1,serialNumber:23234,mapId:1427349437126,gpsX:324.77507598784,gpsY:-24.87537993921,memo:名称类型备注totalPageInt总页数currentPageInt当前页码previousPageIntnextPageIntpageSizeInt每页条数totalInt总条数pageListSizeIntidLongserialNumberString二维码序列号mapIdLong二维码所在地图gpsXString二维码在地图上的横坐标gpsYString二维码在地图上的纵坐标memoString二维码描述；1.2.4 查询设备通道信息接口名称：getEncoderChannel(String conditionJson, String pagerJson)；请求参数：conditionJson，pagerJson分别为json字符串；例：conditionJson json字符串格式category:1,type:2名称类型必填备注categoryString是设备种类typeString否设备类型备注：Category和type作为一组参数，不能分开查询，查询时两个参数都要同时赋值；Category是整形，不允许为空，如果要查询所有通道信息时，设置category为0，type为空。例如： category: 0, type: 例：pagerJson json字符串格式pageSize:10,currentPage:1名称类型必填备注currentPageInt否页码pageSizeInt否每页显示数目备注：如果不需要分页而查询所有记录，传入空字符串即可返回结果：例arrayList:name:YRC3CW18400016_1,code:1000000$1$0$0,errCode:名称类型备注nameString通道名称codeString设备编码errCodeString错误信息（设备种类不为0时,请输入设备类型,设备类型不为空时,设备种类不能为0,否则查询异常）1.2.5 停车场电子地图反向寻车获取路径信息流程图：结束开始通过地图的ID获取地图的图片地址URL获取最短路径根据车牌号获取停车信息通过二维码序列号获取二维码的位置（1）通过车牌号获取停车信息接口接口名称：searchCarInfoByPlateNumber(String searchJson, String pageJson, String extend)请求参数： searchJson，为json字符串；例：carNum:浙A8888名称类型必填备注searchJsonString是车牌信息pageJsonString否扩展字段，为分页预留extendString否扩展字段，暂时没使用返回结果：格式RspCode:1, RspMsg：xxx, RspData: json数组Json数组中各对象含义：名称类型备注idInt停车记录的IDcarNumString车牌号carImgUrlString抓拍图片地址URLcarportNameString车位名称parkDateString停车时间carportCodeString车位编码mapIdString停车所在地图IDcarportCenterXString车位位置横坐标carportCenterYString车位位置纵坐标（2）通过二维码序列号获取二维码的位置接口名称：getLocationBySerialNumber(String serialNumber, String extend);请求参数： serialNumber：二维码序列号 格式为;xxxxxx；extend 扩展字段，暂时没使用例如：10003名称类型必填备注serialNumberString是二维码序列号信息extendString否扩展字段，暂时没使用返回结果：格式RspCode:1, RspMsg：xxx, RspData: json对象 、Json数组中各对象含义：名称类型备注mapIdInt二维码所在地图IDpointXString二维码横坐标pointYString二维码纵坐标（3）通过地图的ID获取地图的图片地址URL接口名称：getMapImgUrlByMapId(String mapId, String extend);请求参数： mapId：地图ID 格式为：xxxxxxx extend 扩展字段，暂时没使用例如：1431573495673名称类型必填备注mapIdString是地图IDextendString否扩展字段，暂时没使用返回结果：格式RspCode:1, RspMsg：xxx, RspData: json对象 Json数组中各对象含义：名称类型备注imgUrlString地图图片的访问地址URL（4）获取最短路径接口名称：getRouter(String locations,String extend);请求参数： locations 包含两个点的位置的字符串，格式为： * mapId:xxxx,pointX:xxxx,pointY:xxxx,mapId:xxxx,pointX:xxxx,pointY:xxxx extend 扩展字段，暂时没使用例如：mapId: 1437099085289,pointX: 44.56782865071,pointY: -155.85381547,mapId: 1437099085289, pointX: 879.27367325702, pointY: 473.47398543184mapId: 1437026660665,pointX: -230.25390218522,pointY: 291.69458896982,mapId: 1437026660665, pointX: 1024.6971904266, pointY: 480.2065556711832/admin/services/FindCarService?wsdlmapId: 1436925384007,pointX:-960.06451612903,pointY: 38.549947970864,mapId: 1436925384007, pointX: 1043.5483870968, pointY: 485.59261186264mapId: 1436925384007,pointX: 224.86784599376,pointY: 394.0296566077,mapId: 1436925384007, pointX: 378.37044745057, pointY: 447.890218522371.1436925384007224.86784599376394.02965660772.1436925384007378.37044745057447.89021852237名称类型必填备注locationsString是包含两个点的位置的字符串extendString否扩展字段，暂时没使用返回结果：格式RspCode:1, RspMsg：xxx, RspData: json数组 Json数组中各对象含义：名称类型备注idint点的IDmapIdint二维码所在地图IDpointXString二维码横坐标pointYString二维码纵坐标carNum:浙A8888100031431573495673mapId: 1431652016795, pointX: 6.7429760665973, pointY: -5.3418314255983,mapId: 1431652016795, pointX: -21.727367325702, pointY: -54.290842872008我写的一个接口getParkings也没有数据，你传入参数如下： carportCode: 001, carportName: 车位1, carportStatus: 1 这组参数任意传那个都行channelId: 100001$1$1$0carNum:浙A1002（5）获取所有的地图接口String getAllMaps(String searchJson, String pageJson, String extend)参数searchJson：查询json字符串，该接口中目前没用到pageJson：分页json字符串，该接口中目前没用到extend：扩展json字符串，该接口中目前没用到返回成功：1，json数组字符串失败：0返回数据的json数组字段说明序号字段名名称类型长度必须备注1mapId地图ID2name地图名称1.2.6 查询车辆进出场记录接口getCarOutInHistoryWSDLhttp:/ip:端口/admin/services/ThirdPartyService?wsdl描述根据传入的时间范围参数查询相应的车辆进出场记录参数名 称类 型含 义startDateString查询起始时间，格式：2015-01-01 10:25:33endDateString查询结束时间，格式：2015-01-02 10:25:33返回String，进出场记录列表对应的json字符串 调用示例：getCarOutInHistory(“2015-01-01 10:25:33”, “2015-01-02 10:25:33”); 返回值示例：array: carNumber:浙AAN909,enterDate:2015-01-09 11:19:29.0,enterChannel:入口,exitDate:2015-01-09 11:21:43.0,exitChannel:出口,cardNumber:,money:null, carNumber:浙AN386Y,enterDate:2014-12-20 11:19:38.0,enterChannel:入口,exitDate:2014-12-20 11:14:44.0,exitChannel:出口,cardNumber:12345678,money:0.0000 1.2.7 更新道闸系统卡片充值信息接口updateCardsWSDLhttp:/ip:端口/admin/services/ThirdPartyService?wsdl描述从第三方同步卡片充值信息到道闸系统中参数名 称类 型含 义cardInfosString(标准Json字符串)卡片相关信息（支持多张卡）格式为： cardList: cardNumber: 1000001, money: 200, startTime: 2015-01-01 12:30:00, endTime: 2015-01-31 12:30:00, updateDate: 2015-01-01 12:30:00 , cardNumber: 1000003, money: 300, startTime: 2015-01-01 12:30:00, endTime: 2015-02-15 12:30:00, updateDate: 2015-01-01 12:30:00 返回int，更新成功返回 1，更新失败返回 0 参数字段说明：cardNumber：卡号money：充值金额startTime：充值有效期起始时间endTime：充值有效期截止时间updateDate：充值时间 调用示例：updateCards(相应的jsonString);1.2.8 更新卡片中的可视对讲门禁功能有效截止日期接口updateIntercomCardAvailableDateWSDLhttp:/ip:端口/admin/services/ThirdPartyService?wsdl描述根据传入的卡号和有效截止时间更新相关联所有卡片可视对讲功能的有效截止日期参数名 称类 型含 义cardNumberString卡号endDateStringString物业费缴纳的有效截止日期，格式：2015-02-15返回int，更新成功返回 1，更新失败返回 0 调用示例：updateIntercomCardAvailableDate (“2586D5F4”, “2015-02-15”1.2.9 获取停车场车位总数和余位总数接口名称getParkingSpotCount接口描述获取停车场车位总数和余位总数WSDLhttp:/ip:端口/admin/services/ThirdPartyService?wsdl接口方式webservice数据频度实时输入参数字段代码字段名称数据类型非空字段说明无：输出结果(json)字段代码字段名称数据类型非空字段说明totalSpots车位总数NumberYidleSpots余位总数NumberY入参：无返回：totalSpots:100,idleSpots:11.2.10 停车信息查询接口接口queryParkingInfo描述根据传入的车牌号码查询相关车辆停车产生的信息参数名 称类 型含 义carNumJson字符串车牌号码 carNum: 浙A123456返回String，(标准的json的字符串)对应车辆的停车信息 参数字段说明：carNum：车牌号码 调用示例：queryParkingInfo(对应的json字符串) 返回值示例：parkCode:1001,停车场编码parkName:xx停车场,停车场名称、carNum:浙A123456,车牌号码inParkTime:2016-4-20,进场时间parkTime:123,停车时长receiableMoney:20,应缴费用carInPicUrl:,车辆进场图片carInNumPicUrl:,车牌号图片payedMoney:20本次停车已缴费用 查询错误时返回为1.2.11 第三方缴费成功的通知接口接口queryPayInfo描述传入的参数为车辆缴费的信息参数名 称类 型含 义payInfoJson字符串缴费信息carNum : 浙A123456,payMoney :20,receivableMoney:20,queryTime :2016-05-01 12:00:00,serialNum : 1001返回String，（标准json字符串），是否缴费的字符串 参数字段说明：carNum：车牌号码，payMoney : 支付金额receivableMoney : 应收金额queryTime :缴费时间serialNum : 订单号 调用示例：queryPayInfo(相应的json) 通知成功时返回值示例：id :1,result :true,errorCode : 失败时返回为： 1.2.12生成二维码支