旅业系统pms-接口文档v2.5.3

第三方对接平台住宿信息入库1住宿信息入库接口说明表1SEQ表\*ARABIC\s11第三方对接平台住宿信息入库接口说明【接口地址】/other/api/guestCheckIn【接口方法】Post【接口说明】主要用于保存第三方对接平台临时住宿信息和人员照片信息【接口授权】需要在请求头中加入授权码（Authorization=授权码）【args参数】入住信息JSON字符串，具体内容详见REF_Ref431822972\r\h1.1args参数说明【header参数】Authorization：授权码（授权码湖南省旅馆业HPC预采集系统中接口设置-酒馆接口菜单中查看）【data结果】成功或失败，具体内容详见REF_Ref431822979\r\h1.2返回说明1.1 args参数说明表1SEQ表\*ARABIC\s12第三方对接平台住宿信息入库接args参数说明数据项类型长度可空备注hotelIdString10N旅馆编号guestNameString64N旅客姓名paperIdString64N证件号码paperTypeCodeString8N证件类型编号（字典paperType.dicCode）nationCodeString8N民族编号（字典nation.dicCode）addressString255N旅客证件详细地址liveTypeCodeString8N入住类型编号（字典liveType.dicCode）roomtypeCodeString64N房间类型编号（字典roomType.dicCode）comeTimeString64N入住时间（yyyy-MM-ddHH:mm:ss格式）roomNoString64N房间号（字典room.roomNo）faceOkString1N人脸比对情况(1：成功,0:不成功,9：未比faceScoreString32Y人脸比对得分（范围0-1）facePhotoStringY人脸抓拍图片（Base64字符串数据,1M以内）guardPaperIdString入住为未成年人则必填未成年人独立入住-监护人身份证guardNameString入住为未成年人则必填未成年人独立入住-监护人姓名guardTelString入住为未成年人则必填未成年人独立入住-监护人电话guardMemoStringY未成年人独立入住-备注guardKnowbooleanY未成年人独立入住-监护人是否知情guardSuspbooleanY未成年人独立入住-是否可疑guardChildSuspiciousesStringY未成年人独立入住-可疑情况编号(多条为编号逗号分割)withChildbooleanY成年人入住-是否带未成年人guardRelationbooleanY成年人入住-是否是随行未成年人的监护人withChildMemoStringY成年人入住-随行未成年人备注withChildSuspbooleanY成年人入住-随行未成年人是否可疑withChildSuspiciousesStringY成年人入住-随行未成年人可疑情况编号(多条为编号逗号分割)withChildCallPolicebooleanY未成年人入住可疑情况是否已通报公安durationDaysIntN计划入住天数paperPhotoStringN证件照（Base64字符串数据100k以内）withChildNumsIntY成年人入住-携带未成年人数量(携带必填)1.2 返回说明表13第三方对接平台住宿信息入库接口返回说明数据项类型长度备注codeint32是否成功（200-成功，其他-失败）messageString提示信息resultObject数据1.3范例说明1.3.1 args参数范例//入住functionguestLivein(){varguest={"guestName":"张三","paperId":,"address":"湖南省长沙市岳麓区岳麓大道218号","paperTypeCode":"11","nationCode":"01","liveTypeCode":"1","roomTypeCode":"1","comeTime":"2021-09-0112:12:12","roomNo":"A101","faceOk":"1","faceScore":"0.93","facePhoto":"/9j/4AAQSkZJRgABAQAAAQABAAD..........","guardPaperId":null,"guardName":null,"guardTel":null,"guardMemo":"","guardKnow":false,"guardSusp":true,"guardChildSuspiciouses":"05,06,09","withChild":false,"guardRelation":false,"withChildMemo":null,"withChildSusp":false,"withChildSuspiciouses":"","withChildCallPolice":true,"durationDays":2,"withChildNums":1,"paperPhoto":"/9j/4AAQSkZJRgABAQAAAQABAAD.........."}$.ajax({type:"POST",headers:{"Authorization":"032c378a005f496d1e3f8a4843e22f5d","Content-Type":"application/json;charset=UTF-8"},url:"http://localhost:8084/hpc/other/api/guestCheckIn?hotelId=4301021761",data:JSON.stringify(guest),dataType:"json",success:function(data){Console.log(data.resultCode)}});}1.3.2返回范例{ "code":200, "message":"操作成功", "result":true}2退房信息接口说明表1SEQ表\*ARABIC\s11第三方对接平台住宿信息入库接口说明【接口地址】/other/api/guestCheckOut【接口方法】POST【接口说明】主要用于保存第三方对接平台临时住宿信息和人员照片信息【接口授权】需要在请求头中加入授权码（Authorization=授权码）【args参数】【header参数】Authorization：授权码（授权码湖南省旅馆业HPC预采集系统中接口设置-自助开房机接口菜单中查看）【data结果】成功或失败，具体内容详见REF_Ref431822979\r\h1.2返回说明数据项类型长度可空备注hotelIdString10N旅馆编号roomNoString64N房间号paperIdString64N证件号码leaveTimeString64N离店时间（yyyy-MM-ddHH:mm:ss）2.3范例说明2.3.1 args参数范例//退房functionguestliveout(){$.ajax({type:"POST",headers:{"Authorization":"032c378a005f496d1e3f8a4843e22f5d","Content-Type":"application/json;charset=UTF-8"},url:"http://localhost:8084/hpc/other/api/guestCheckOut?hotelId=4301021761&roomNo=A101&paperIdleaveTime=2022-11-0115:03:14",dataType:"json",success:function(data){Console.log(data.resultCode)}});}3字典信息接口说明表2SEQ表\*ARABIC\s11第三方对接平台字典信息查询接口说明【接口地址】/other/api/get***List?hotelId=【接口方法】Get【接口说明】主要用于第三方对接平台字典信息查询【接口授权】需要在请求头中加入授权码（Authorization=授权码）【args参数】无【header参数】Authorization：授权码（授权码湖南省旅馆业HPC预采集系统中接口设置-自助开房机接口菜单中查看）【data结果】成功或失败，具体内容详见REF_Ref431822979\r\h1.2返回说明3.1 字典类型说明表2SEQ表\*ARABIC\s12字典类型参数说明字典数据类型接口接口/other/api/getRoomList获取房间列表信息/other/api/getLiveTypeList获取入住类型字典信息/other/api/getPaperTypeList获取证件类型字典信息/other/api/getNationList获取民族字典信息/other/api/roomTypeList获取房间类型字典信息/other/api/getwithChildSusList未成年人入住可疑情况字典3.2 返回说明表23第三方对接平台字典信息查询接口返回说明数据项类型长度备注codeint32是否成功（200-成功，其他-失败）messageString提示信息resultObject数据3.3范例说明3.3.1返回范例（入住类型字典信息）{"code":200,"message":"操作成功","result":[{"dicCode":"1","dicText":"全天房","dicSpell":"qtf","dicAspell":null},{"dicCode":"2","dicText":"长包房","dicSpell":"cbf","dicAspell":null},{"dicCode":"3","dicText":"钟点房","dicSpell":"zdf","dicAspell":null},{"dicCode":"4","dicText":"午夜房","dicSpell":"wyf","dicAspell":null},{"dicCode":"5","dicText":"其他","dicSpell":"qt","dicAspell":null}]}3返回码信息说明返回码返回信息200操作成功500内部异常9999100参数异常10010001Authorization信息无效10010002未查询到当前场所信息10010003场所信息授权异常接口正式地址:/hpc；前端安装步骤:安装旅业fap绑定e盾输入/hpc，获取接口key补充说明:鉴于公安服务器，网络稳定性欠佳，以及公安psb系统时常升级部署，可能偶然会造成接口接收数据异常，因此