旅業(yè)系統(tǒng)pms-接口文檔v2.5.3

第三方對(duì)接平臺(tái)住宿信息入庫1住宿信息入庫接口說明表1SEQ表\*ARABIC\s11第三方對(duì)接平臺(tái)住宿信息入庫接口說明【接口地址】/other/api/guestCheckIn【接口方法】Post【接口說明】主要用于保存第三方對(duì)接平臺(tái)臨時(shí)住宿信息和人員照片信息【接口授權(quán)】需要在請(qǐng)求頭中加入授權(quán)碼（Authorization=授權(quán)碼）【args參數(shù)】入住信息JSON字符串，具體內(nèi)容詳見REF_Ref431822972\r\h1.1args參數(shù)說明【header參數(shù)】Authorization：授權(quán)碼（授權(quán)碼湖南省旅館業(yè)HPC預(yù)采集系統(tǒng)中接口設(shè)置-酒館接口菜單中查看）【data結(jié)果】成功或失敗，具體內(nèi)容詳見REF_Ref431822979\r\h1.2返回說明1.1 args參數(shù)說明表1SEQ表\*ARABIC\s12第三方對(duì)接平臺(tái)住宿信息入庫接args參數(shù)說明數(shù)據(jù)項(xiàng)類型長度可空備注hotelIdString10N旅館編號(hào)guestNameString64N旅客姓名paperIdString64N證件號(hào)碼paperTypeCodeString8N證件類型編號(hào)（字典paperType.dicCode）nationCodeString8N民族編號(hào)（字典nation.dicCode）addressString255N旅客證件詳細(xì)地址liveTypeCodeString8N入住類型編號(hào)（字典liveType.dicCode）roomtypeCodeString64N房間類型編號(hào)（字典roomType.dicCode）comeTimeString64N入住時(shí)間（yyyy-MM-ddHH:mm:ss格式）roomNoString64N房間號(hào)（字典room.roomNo）faceOkString1N人臉比對(duì)情況(1：成功,0:不成功,9：未比faceScoreString32Y人臉比對(duì)得分（范圍0-1）facePhotoStringY人臉抓拍圖片（Base64字符串?dāng)?shù)據(jù),1M以內(nèi)）guardPaperIdString入住為未成年人則必填未成年人獨(dú)立入住-監(jiān)護(hù)人身份證guardNameString入住為未成年人則必填未成年人獨(dú)立入住-監(jiān)護(hù)人姓名guardTelString入住為未成年人則必填未成年人獨(dú)立入住-監(jiān)護(hù)人電話guardMemoStringY未成年人獨(dú)立入住-備注guardKnowbooleanY未成年人獨(dú)立入住-監(jiān)護(hù)人是否知情guardSuspbooleanY未成年人獨(dú)立入住-是否可疑guardChildSuspiciousesStringY未成年人獨(dú)立入住-可疑情況編號(hào)(多條為編號(hào)逗號(hào)分割)withChildbooleanY成年人入住-是否帶未成年人guardRelationbooleanY成年人入住-是否是隨行未成年人的監(jiān)護(hù)人withChildMemoStringY成年人入住-隨行未成年人備注withChildSuspbooleanY成年人入住-隨行未成年人是否可疑withChildSuspiciousesStringY成年人入住-隨行未成年人可疑情況編號(hào)(多條為編號(hào)逗號(hào)分割)withChildCallPolicebooleanY未成年人入住可疑情況是否已通報(bào)公安durationDaysIntN計(jì)劃入住天數(shù)paperPhotoStringN證件照（Base64字符串?dāng)?shù)據(jù)100k以內(nèi)）withChildNumsIntY成年人入住-攜帶未成年人數(shù)量(攜帶必填)1.2 返回說明表13第三方對(duì)接平臺(tái)住宿信息入庫接口返回說明數(shù)據(jù)項(xiàng)類型長度備注codeint32是否成功（200-成功，其他-失敗）messageString提示信息resultObject數(shù)據(jù)1.3范例說明1.3.1 args參數(shù)范例//入住functionguestLivein(){varguest={"guestName":"張三","paperId":,"address":"湖南省長沙市岳麓區(qū)岳麓大道218號(hào)","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第三方對(duì)接平臺(tái)住宿信息入庫接口說明【接口地址】/other/api/guestCheckOut【接口方法】POST【接口說明】主要用于保存第三方對(duì)接平臺(tái)臨時(shí)住宿信息和人員照片信息【接口授權(quán)】需要在請(qǐng)求頭中加入授權(quán)碼（Authorization=授權(quán)碼）【args參數(shù)】【header參數(shù)】Authorization：授權(quán)碼（授權(quán)碼湖南省旅館業(yè)HPC預(yù)采集系統(tǒng)中接口設(shè)置-自助開房機(jī)接口菜單中查看）【data結(jié)果】成功或失敗，具體內(nèi)容詳見REF_Ref431822979\r\h1.2返回說明數(shù)據(jù)項(xiàng)類型長度可空備注hotelIdString10N旅館編號(hào)roomNoString64N房間號(hào)paperIdString64N證件號(hào)碼leaveTimeString64N離店時(shí)間（yyyy-MM-ddHH:mm:ss）2.3范例說明2.3.1 args參數(shù)范例//退房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第三方對(duì)接平臺(tái)字典信息查詢接口說明【接口地址】/other/api/get***List?hotelId=【接口方法】Get【接口說明】主要用于第三方對(duì)接平臺(tái)字典信息查詢【接口授權(quán)】需要在請(qǐng)求頭中加入授權(quán)碼（Authorization=授權(quán)碼）【args參數(shù)】無【header參數(shù)】Authorization：授權(quán)碼（授權(quán)碼湖南省旅館業(yè)HPC預(yù)采集系統(tǒng)中接口設(shè)置-自助開房機(jī)接口菜單中查看）【data結(jié)果】成功或失敗，具體內(nèi)容詳見REF_Ref431822979\r\h1.2返回說明3.1 字典類型說明表2SEQ表\*ARABIC\s12字典類型參數(shù)說明字典數(shù)據(jù)類型接口接口/other/api/getRoomList獲取房間列表信息/other/api/getLiveTypeList獲取入住類型字典信息/other/api/getPaperTypeList獲取證件類型字典信息/other/api/getNationList獲取民族字典信息/other/api/roomTypeList獲取房間類型字典信息/other/api/getwithChildSusList未成年人入住可疑情況字典3.2 返回說明表23第三方對(duì)接平臺(tái)字典信息查詢接口返回說明數(shù)據(jù)項(xiàng)類型長度備注codeint32是否成功（200-成功，其他-失敗）messageString提示信息resultObject數(shù)據(jù)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":"鐘點(diǎn)房","dicSpell":"zdf","dicAspell":null},{"dicCode":"4","dicText":"午夜房","dicSpell":"wyf","dicAspell":null},{"dicCode":"5","dicText":"其他","dicSpell":"qt","dicAspell":null}]}3返回碼信息說明返回碼返回信息200操作成功500內(nèi)部異常9999100參數(shù)異常10010001Authorization信息無效10010002未查詢到當(dāng)前場所信息10010003場所信息授權(quán)異常接口正式地址:/hpc；前端安裝步驟:安裝旅業(yè)fap綁定e盾輸入/hpc，獲取接口key補(bǔ)充說明:鑒于公安服務(wù)器，網(wǎng)絡(luò)穩(wěn)定性欠佳，以及公安psb系統(tǒng)時(shí)常升級(jí)部署，可能偶然會(huì)造成接口接收數(shù)據(jù)異常，因此