物联网智慧酒店应用平台接口通用技术要求

物联网智慧酒店应用平台接口通用技术要求

国家标准 GB/T37976一2019 物联网智慧酒店应用 平台接口通用技术要求 nmternelofthing一Smarthelapplieaton- Generalteehniealrequirementsoftheplatforminterfaee 2019-08-30发布 2020-03-01实施 国家市场监督管理总局 发布 币国国家标准化管理委员会国家标准
GB/37976一2019 目 次 前言 范围 2 规范性引用文件 术语和定义 缩略语 概述 平台接口 6. 应用技术要求 6.2接口定义方式和数据类型说明 6.2.1数据接口定义方式 6.2.2接口数据类型 6.3PMS接口 基础代码获取接口 6.3.1 l0 6.3.2 客房管理 客房订单 6,3.3 前台业务 46 6,3.4 6.3.5会员服务 86 6.4酒店其他管理系统接口 l10 6.4.1门锁服务 l10 6.4.2客房控制服务 131 客房娱乐服务 134 6,4.3 公安数据接人 146 6,4.4 接口安全要求 148 7.1结构安全 148 7.2访问控制 149 7.3安全审计 149 7.4边界完整性检查 149 7.5人侵防范 149 149 7.6网络设备防护
GB/37976一2019 前 言 本标准按照GB/T1.1一2009给出的规则起草 请注意本文件的某些内容可能涉及专利 本文件的发布机构不承担识别这些专利的责任 本标准由全国信息技术标准化技术委员会(SAC/TC28)提出并归口 本标准起草单位:电子技术标准化研究院、新新人类(北京)科技有限公司、智慧壹号(北京)酒 店管理有限公司、杭州绿云软件有限公司、深圳赛西信息技术有限公司、公安部第三研究所、山东比特智 能科技股份有限公司、快住智能科技(苏州)有限公司、上海别样红信息技术有限公司、上海逸邻网络科 技有限公司、广东必达保安系统有限公司、惠州市尊宝智能控制股份有限公司、深圳市盛阳科技股份有 限公司、杭州云柚科技有限公司、TCI王牌电器惠州)有限公司深圳欢旅科技有限公司、常州市邦威 电子科技有限公司 本标准起草人张晖、郭迪胜、,耿力、李孟良、杨宏、信宏业、赵焕众,荀亮亮、路小北、谷慧敏、曹现贵 朱形,黄华、,杨铭魁、陈海滨,郭迎光、冯震维、陈伟禧、黄晓凌、张勇、昌坡、张敬字、曾文涛,刘乃钢 王建青,余晖、陈雪明,唐建国,陈妙强、黄俭、杨枫、穆林、张华,李翔、邹子平、裘永强、沈伟明、李桂琴 朱家川,王加梁、李广飞、闫宏诃,闻涛、李云鹏,刘卫东,田彩云,李东升周山,王炸,王踏曼,王袖祷 汤铭,孟周俊、俞海钟、刘宗科、邹宇航杨诗兵、李俱顺
GB/37976一2019 物联网智慧酒店应用 平台接口通用技术要求 范围 本标准规定了基于物联网技术的智慧酒店应用平台接口通用技术要求 本标准适用于基于物联网技术的智慧酒店应用平台接口设计 规范性引用文件 下列文件对于本文件的应用是必不可少的 凡是注日期的引用文件,仅注日期的版本适用于本文 件 凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件 GB/T33745一2017物联网术语 术语和定义 GB/T33745一2017界定的以及下列术语和定义适用于本文件 3.1 智慧酒店 smarthotel 通过应用先进的信息和通信技术,实现管理数字化、网络化和智能化的酒店 3.2 综合信息管理平台 integratedinformmationmanagementplatform 将酒店的客户管理,客房管理、接待管理、账务管理、审核管理、销售管理等多个管理模块或系统汇 集并形成的管理平台 3.3 平台接口platforminterfaee 平台内部子系统、子模块之间,以及该平台与外部平台、系统之间的相互连接与交互的接口 缩略语 下列缩略语适用于本文件 待修房(OutofOrder) OOO P\MS酒店管理系统(PropertyManagementsystem) 概述 智慧酒店应用一般通过基于物联网技术的智慧酒店综合信息管理平台实现,平台架构如图1所示、 由PMS和酒店其他管理系统组成 物联网传感单元信息通过事务处理系统及其他系统与PMS进行 数据交换,智慧酒店通过该平台提供应用服务
GB/T37976一2019 互联网应用服务 集团应用服务 酒店管理系统PMS) 其他管理系统 前 客 客 客 客 消 础 台 房 房 房 工 防 房 安 业 控 智控 代 管 娱 数 乐 据 酒店其他处理系统 物联网传感单元 酒店综合信息管理平台 平台接口及其数据流方向 图1基于物联网的智慧酒店综合信息管理平台架构 智慧酒店综合信息管理平台接口包括PMS接口和酒店其他管理系统接口 PMS接口包括:基础 代码接口、客房管理接口、客房订单接口,前台业务接口和会员服务接口等 酒店其他管理系统接口包 括:门锁服务接口、客房控制接口、人工智能机器人服务接口、智能消防控制接口、客房娱乐接口和公安 传输数据接口等 智慧酒店综合信息管理平台的各接口之间可进行相互调用,也可以供外部应用服务调用,以满足具 体业务服务需求 6 平台接口 6.1应用技术要求 智慧酒店应围绕物联网六域模型体系建立包括PMS及相关联的应用技术内容 智慧酒店建设应 用技术体系架构如图2所示
GB/37976一2019 用户域 用户管理 客户管理 第三方授权 业主管理 供应商 资源交换域 服务提供域 酒店信息 PMS酒店管理系统 Os餐饮管理系统 RMS收益管理系统 运维管控域 户关系系统 CRM客户 订单信息 CRS中央预订系统 CMS渠道管理系统 法规监管 经营分析 运行维护 S&C宴会与销售 电商服务系统 营销活动管理 酒店产品 卡券管理系统 自助服务系统 智能客控系统 安全保障 用户客户 客服与点评 支付服务 多媒体服务 个性定制 跨界信息 门禁服务 公安户籍管理 感知控制域 在线服务直连 环境设备控制 RCU客房控制器 全面网络服务 触摸屏服务接口 VR控制与服务 定位与导航 生物识别 网络打印控制 扫描扫码处理 卡证读写器 -=*-= 目标对象域 机器人 环境传感器 PAD、手机、手表 门锁、门卡、开关 智能电视 微信、支付宝 扫描、签名板 证件、RFID. 二维码、条码 位置信息 VR设备 -*## 图2智慧酒店建设应用技术体系架构 6.2接口定义方式和数据类型说明 6.2.1数据接口定义方式 规定如下 数据接口分类 aa 按PMS接口和酒店其他管理系统接口归纳各子类数据接口,并在各类数据接口进一步划分为细 类数据接口
GB/T37976一2019 b接口格式描述 l)各个接口定义按以下格式描述 条款号接口名(说明:使用中文和原语给出接口名 [功能说明] 说明简要陈述该接口的功能 [请求参数]说明:用以下列表形式给出所请求的参数 字段 数据类型 说明 中文名称 数量 用原语给出该字段 用于描述该参数的 所请求的该参数的 对前面栏目的 该参数的中文名 包含的参数名 数据类型 数量 补充说明 [响应数据]说明:用以下列表形式给出响应数据 字段 中文名称 数据类型 数量 说明 用原语给出该字段 用于描述该数据的 所请求的该数据的 对前面栏目的 该参数据的中文名 包含的数据名 数据类型 数量 补充说明 XXXXto 说明:1.Dto表示数据传输对象;2.“Dto”前的“XXXX”,对于基础代码获取接口,用接口原语名中 “get”后面的部分取代;对于PMS接口或酒店其他管理系统接口,用接口原语名取代;3.个别接口包含 不止一个此项 字段 中文名称 数据类型 数量 说明 用原语给出该字段 用于描述该字段的 所请求的该字段的 对前面栏目的 该字段的中文名 补充说明 包含的数据名 数据类型 数量 [请求示例]说明下面给出具体请求示例 关于接口定义中的“数量”,说明如下: 2 1:表示有且仅有一个 0.n:表示可以没有,也可以为多个,数量没有上限 1..n;表示最少一个,可以为多个,数量没有上限 关于接口定义中的“示例”,本标准主要采用国际通行的数据交换数据格式Json来说明 6.2.2接口数据类型 包括如下几种类型 字符型数据,用String表示; a b 整数型数据,用Number表示 c 小数型数据,用Deecimal表示; 对象型数据(用后缀Do的字符串表示),自定义数据传输对象,该类型的数据应进行单独 d 说明
GB/37976一2019 6.3PMS接口 6.3.1基础代码获取接口 6.3.1.1获取国家信息getCo" ountries [功能说明] 获取国家信息 [请求参数] 字段 中文名称 数据类型 数量 说明 酒店集团代码 hotelGiroupCode String [响应数据 字段 数据类型 数量 中文名称 说明 结果代码 字段操作结果 resultCode String resultMsg 结果信息 返回提示信息 String resultOb 结果对象 CoutryDto 返回数据对象 0.,n CoutryDto 字段 中文名称 数据类型 数量 说明 代码 code String 名称 String descript [请求示例咖 "hotelGroupCode""HTLG" [返回示例] "resultCode":0. "resultMsg";"查询成功" "esultInfo" "code""CHN" deseript""" "code""USA", "deseript""美国"
GB/T37976一2019 6.3.12获取城市信息eities [功能说明] 获取指定酒店集团的城市信息 请求参数 数据类型 数量 字段 中文名称 说明 酒店集团代码 hotel(GiroupCode String [响应数据 字段 中文名称 数据类型 数量 说明 结果代码 result(Code String resultMsg 结果信息 String resultlnfo 返回信息 CityDto口 0..n CityDro 字段 中文名称 数据类型 数量 说明 代码 code String 名称 String descript 请求示例] "hotelGroupCode";"HTLG" [返回示例 "resultCode":0. esulMsg";"查询成功" resultlnfo': "code";"Hz" "deserip";"杭州" "code";"SH" descript";"上海" 6.3.1.3获取证件类型信息etcwtes [功能说明] 获取证件类型信息
GB/37976一2019 [请求参数 数据类型 字段 中文名称 数量 说明 酒店集团代码 hotel(GroupCode String hotelCode 酒店代码 String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String A resultlnfo 返回信息 ldCodeDto] 0., IdCodeDto 字段 中文名称 数据类型 数量 说明 code 代码 String deseript 名称 String [请求示例] "hotelGroupCode";"HTLG" "hotelCode""GCBZ" [返回示例] rresultCode" :0 'esuMsg";"查询成功" "esullnfo";[ "code";"o1" "deseript";"身份证" "code":"99" "descrip";"其他证件" 6.3.1.4获取性别信息getSexCodes [功能说明] 获取证件类型信息 [请求参数]
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 hotel(GroupCode 酒店集团代码 String hotel(Code 酒店代码 String [响应数据 数量 字段 数据类型 说明 中文名称 resultCode 结果代码 String esultMsg 结果信息 String resultInfo 返回信息 SexDto门 0..n SexDto 字段 中文名称 数据类型 数量 说明 代码 code String 名称 descript String [请求示例] hotelGroupCcode""HTLG" "hotelCode";"GCBZ" [返回示例] "esultCode";0, "esultMsg""查询成功" "resultInfo"; 'code";"1" "descript";"男" "code";"2" "deseript";"女" 6.3.1.5获取酒店信息getHotes [[功能说明 获取指定酒店集团相关条件下的酒店列表 请求参数]
GB/37976一2019 字段 中文名称 数据类型 数量 说明 lhotelGroupCode 酒店集团代码 String hotelCode 酒店代码 0..l String 城市代码 cityCode String 0.. brandCodes 品牌代码 0..n String [响应数据 字段 说明 数量 中文名称 数据类型 resultCode 结果代码 String esultMsg 结果信息 String resultnfo 返回信息 HotellnfoDto口 0..7 HlotellnfoDto 字段 中文名称 数据类型 数量 说明 code 酒店代码 String status 酒店状态 String 酒店名称 deseript String 酒店所在国家代码 countryCode String eityCode 酒店所在城市 String address 地址 String phone 电话 String website 网址 String 电子邮箱 email String remark 备注 String 酒店类型 度假,商务 Te String 酒店星级 starlevel String 酒店坐标 String 经纬度坐标 coordinates [请求示例 "hotelGroupCode";"HTILG [[返回示例] "resultCode":0. "resultMsg""查询成功" "resultlnfo";[ 'code";"HTL"
GB/T37976一2019 status""I" descript";"黄山大酒店" ;"CHN" ountryCodle" ;"HS" stycoadte" "安徽省黄山市" address phone website emai 11 'remark" 6.3.2客房管理 6.3.2.1 获取房型信息getRoomIypes [功能说明 获取酒店的房型信息列表 [C请求参数 中文名称 数量 字段 数据类型 说明 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String resultlnfo 返回信息 RoomTypeDto口 0." RoomTypeDto 字段 中文名称 数据类型 数量 说明 code 房型代码 String descript 房型描述 String maxAdults 最大成人数 number maxChildren 最大儿童数 number 请求示例] "hotelGroupCode";"HTLG" "hotelCode";"HTL" 10
GB/37976一2019 [返回示例 "resultCode":0 res sulMsg";"查询成功", "resullnfo":;C "code";"HHSC" "deseript";"豪华双床房" "code";"HwDC" "deseript";"豪华大床房" 6.3.2.2获取楼层信息getFloors [功能说明] 获取酒店楼层信息 [请求参数 字段 数据类型 数量 说明 中文名称 hoeGuCcode 酒店集团代码 String HotecCode 酒店代码 String [响应数据 字段 说明 中文名称 数据类型 数量 resultCode 结果代码 String resultMsg 结果信息 String resulnfo 返回信息 FloorDto 0..7n FloorDto 字段 中文名称 数据类型 数量 说明 code 代码 String descript 名称 String [请求示例] "hotelGroupCode";"HTLG" [返回示例] 11
GB/T37976一2019 resultCode":0, "esulMsg";"查询成功", "esultlnfo":[ "code";"1" "deseript";"第一层" "code":"2" "descript";"第二层" 6.3.2.3获取客房特征信息getFeatures [[功能说明] 获取酒店客房特征信息 请求参数] 数据类型 数量 字段 中文名称 说明 酒店集团代码 hotelGroupCode String hotelCode 酒店代码 String 0..！ [响应数据 字段 中文名称 数据类型 数量 说明 resulCode 结果代码 String resultMsg 结果信息 String resulnfo 返回信息 FeatureDo[ 0..n FeatureDto 字段 中文名称 数据类型 数量 说明 code 代码 String descript 名称 String [请求示例] "hotelGroupCode";"HTLG" [[返回示例 "esultCode":0. 12
GB/37976一2019 "esultMsg";"查询成功" "esullnfo"[ "code";"NS' "deserip""无烟房" "code";"sM！" "descript";"吸烟房" 6.3.2.4 查询房间状态getRoomSta [功能说明门 查询房间状态 [请求参数 字段 数据类型 数量 说明 中文名称 hoteGrouCode 酒店集团代码 String hotelcode 酒店代码 String VR(空净);VD(空) std 状态 String 0.l oR(住净);oD住脏 flag String 是否返回人住人 针对在住的房间 0..l eurrentPage 当前页 number 0. pageSize 分页数量 number 0.1 [响应数据 字段 说明 中文名称 数据类型 数量 resultCode 结果代码 String resultMsg 结果信息 String resultlnfo 返回信息 RoomDto口 0., RoomDto 数据类型 字段 中文名称 数量 说明 bwumang 楼栋 String loor 楼层 String isDep 是否将离 String roonmType 房型 String 住客信息 GuestDto口 guests roomNo 房号 String 13
GB/T37976一2019 GuestDto 字段 中文名称 数据类型 数量 说明 name 姓名 String idNo 证件号码 0 String rsvClass F;散客;G;团队 预订类型 String 0..1 arrDate 到达时间 String yMM-ddHH:mm:ss yyy depDate 离开时间 String yyyy-MM-ddHH:;mm:ss mobile 手机号码 String [请求示例 "hotelGroupCode";"HTLG" "hotelCode""HTL" "sta";"OR" lag""T" [返回示例 "resultCode":1. "esultMsg";"查询成功" esullnfo"[ "building";"A" "floor" "OR" sta updateTime":1476342877000. "F" isDep" "HHISC" roomIype" guests name "qwert" "421000198604266658" "F" rSvlass" "2016-10-131553:23" arrlDate name "qwert" "depDate" "2016-10-1412:00:00" "mobile";"13567165880" "roomNo";"002" "id":3156 14
GB/37976一2019 "bulding" "floor""2" "sta";"OR" teTime":1476342877000 updat isDep" "F" ;"HHISC" e" roomType guests nam6 gwert "421000198604266658" arrDate";"2016-10-1316:4239" depDate":"2016-10-1412:00:00" mobile";"13567165880" "roomNo":"08" 6.3.2.5更新房间状态updateRoomsta [[功能说明] 更新房间状态 [请求参数] 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String 房号 roomNo String 新的房态(D,脏房;l检查; T:toueh-up;R;干净;o,维修; roomSta 状态 String S锁定;TMP:临时态 开始日期 beginDate String 0.l 格式yyyy-MM-dd 结束日期 格式yyy-\MMdd endDate 0..l String 仅针对维修、锁定、 维修或锁定理由 String 0.1 reason 临时态有效 [响应数据 字段 中文名称 数据类型 数量 说明 结果代码 resultCode String esaMss" 结果信息 String [请求示例] 15
GB/T37976一2019 "hotelGr roupCode";"HTLG" "hotelCode";"HTL" "roomNo";"201" "roomSta";"R" [返回示例] resultCode":0 "resultMsg";"成功" 6.3.2.6获取可用房量elRwmAoal [[功能说明 获取酒店可用房量 [请求参数 字段 数据类型 数量 说明 中文名称 hotel(GroupCode 酒店集团代码 String hoteCode 酒店代码 String arrDate 到达日期 格式yyyy-MM-dd String 格式yyyyMM-dd 结束日期 depDate String 注:不含本日 多房型间使用逗号隔开; 房型 String 0..n roomTypes 不传递该参数表示所有 [[响应数据 中文名称 数量 字段 数据类型 说明 resutCode 结果代码 String esultMsg 结果信息 String resultlnfo 返回信息 availDto 0.n availDto 字段 中文名称 数据类型 数量 说明 hotel(GroupCode 酒店集团代码 String hotelCode 酒店代码 String roomTy 房型 String ype roomClass 房型类别 String 日期 0ccDate String roomTypeNum 房型总房数 number 16
GB/37976一2019 字段 中文名称 数据类型 数量 说明 oooNum 维修房数 number 维护房数 osNum number avail 可用房数 number 超预留数量 imitNumm number availwithLimit 包含超预留可用房数 number [请求示例] "hotelGroupCode";"HTLG" "hotelcCode";"HTL" "arrDate";"2016-10-l8" "depDate";"2016-10-19" rroomTypes";"DXK" [返回示例] "resultCode" :l "resultMsg";"查询成功" "esultlnfo":[ "hotelGroupCode";"HTIG" "hotecode";"HTL" roommType";"DxK" roomClass";"A" oceDate";"2016-10-18" roomTypeNum";0. oooNum":0 osNum avail" "limitNu Num".0 "availwithLimit";0, 6.3.2.7获取可卖房getRoomSaleable [[功能说明] 获取酒店指定时间内的可卖房号 [请求参数] 17
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 酒店集团代码 hotelGroupCode String hotelCode 酒店代码 String arrDate 到达日朋 格式yy-MMdd String depDate 结束日期 String 格式yyyyMMdd 房型 多房型逗号隔开 roomTypes String 0..n roomsFilter 指定房号 String 0." 多房号逗号隔开 isClean 是否仅干净房 T/F String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 结果信息 rresultMsg String 返回信息 RoomSalea abeDo口 0.,n resultInfo RoommSaleableDto 字段 数据类型 数量 说明 中文名称 roomNo 房号 String roomType 房型 String bedNum 床数 number D,脏房;l检查;o维修 状态 roomSta String R;干净;S:锁定;T:Touch-Up oceSta 占用状态 String ;占用;V;空闲 featureCodes 特征代码 0..n String 楼层 fioorCode String 6.3.2.8获取酒店预订信息getHoteorderable [[功能说明 获取酒店指定时间内的可卖房 [请求参数 说明 字段 中文名称 数据类型 数量 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 0.,n 多酒店逗号分附 String 到达日期 格式yymmdd arrdate String dayCount 人住天数 number cityCode 城市代码 String brandCode 品牌代码 String 0. irstPage 起始页数 number 0.l 18
GB/37976一2019 字段 中文名称 数据类型 数量 说明 分页数量 pageSize number 0.l 房价码 rateCodes 0..n String channel(cCode 渠道代码 String 0.. [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String 返回信息 resultnfo HotelOrderableDto自 0.n HotelOrderableDto 字段 中文名称 数据类型 数量 说明 RateListDtoC 可订列表 rateQueryist totalRows 总行数 number RateListDto 字段 中文名称 数据类型 数量 说明 hotelCode 酒店代码 String 房价信息 ratelist RateDto自 ln 最小房价 minRate decimal 房价代码 rateCodes String l.,1 roonmTypes 房型代码 String RateDto 字段 中文名称 数据类型 数量 说明 rateCode 房价码 String roomType 房型 String firstRate 首日房价 Deeimal 均价 avgRate Deeimal sourceCode 来源码 String markeCode 市场 String packageCodes 包价 String 0..l 最小提前天数 advMin number 0.l advMax 最大提前天数 number 0. staMin 最小人住天数 number 0. stayMax 最大人住天数 0.1 number 可订房数 avai number bookingSum 总数量 number 19
GB/T37976一2019 请求示例] "hotelGroupCode""HTLG", "hotelCode""HTL" "arrdate""2016-10-18”" "dayCount":l， eityCode" channelCode";"WEB" rateCodes";"GOV" [返回示例] "resulCode":0. resultMsg";"查询成功" resultlnfo'; "RateQueryList":[ "hotelCode";"HTL" "roomlist": "ratecode";"GO" 'roomType";"HHHIsC" "firstRate";"275.00" avgRate";"275.00" sourceCode":"HDR" marketCode";"G0V" packageCodes" "advMin":0. "advMax';:0 stayMin":0. "stayMax":0. "avail";99. Z ookingSum":730 "atecode";"GOV" "oomType""HwD" "firstRate";"275.0o" avgRate";"275.00" sourceCode""HDR" "markeCode","GO" eCodes" packagel "advMin";0. 20
GB/37976一2019 "adMax";0. "stayMin";0. "stayMax":0. "avail"28， "bookingSum"28 "minRate""180.00" "t.Code","GoV,SK" "oomType""HHsC,HwIC" "otalRows";1 6.3.3客房订单 6.3.3.1获取宾客市场分类信息getMarkets [[功能说明] 获取酒店市场分类代码信息 请求参数] 字段 数据类型 数量 说明 中文名称 hotelGroupCode 酒店集团代码 String HotelCode 酒店代码 String 0. [响应数据] 说明 字段 中文名称 数据类型 数量 resulCode 结果代码 String resultMsg 结果信息 String resultlnfo 返回信息 MarketDto口 0., MarkeDtot 字段 中文名称 数据类型 数量 说明 代码 code String 名称 String descript [请求示例] "hotelGroupCode";"HTLG" 21
GB/T37976一2019 [[返回示例 "resultCode":0 resultMsg";"查询成功" resultlnfo"; "code":"COR" "deseript":"协议公司" "code";"FIT" "deseript";"散客" 6.3.3.2获取宾客来源分类信息getSourees [功能说明 获取酒店来源分类代码信息 请求参数] 字段 数据类型 数量 说明 中文名称 酒店集团代码 String hotelGroupCode HoteCode 酒店代码 String 0..1 [响应数据 说明 字段 中文名称 数据类型 数量 resultCode 结果代码 String rresultMsg 结果信息 String resultInfo 返回信息 SourceDo[ 0..7 SourceDto 字段 中文名称 数据类型 数量 说明 code 代码 String deseript 名称 String C请求示例] "hotelGroupCode";"HTLG" [返回示例] 22
GB/37976一2019 "result(Code" :0 "esultMsg""查询成功", "esultlnfo":[ "code""INT" "deserip";"境外宾客" "code";"L0CAL" "descript":"本地客人" 6.3.3.3获取客房销售渠道信息getChannels [[功能说明] 获取酒店客房销售渠道分类代码信息 [请求参数 字段 中文名称 数据类型 数量 说明 酒店集团代码 hotelGroupCode String HotelcCode 酒店代码 0..l String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String resultlnfo 返回信息 ChannelDto 0.,n ChannelDto 字段 数据类型 数量 说明 中文名称 code 代码 String deseript 名称 String [请求示例] "hotelGroupCode";"HTLG" [返回示例] "resultCode" ":0, ulMsg""查询成功" resu 23
GB/T37976一2019 "esullnfo";[ "code""CRS" "de lescript";"CRS" "code";"OTA" "descript";"OTA" 6.3.3.4获取宾客特殊要求信息getSpeetals [[功能说明] 获取宾客特殊要求信息 [请求参数 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String 酒店代吗 HotelCode String 0.l [响应数据 数据类型 字段 中文名称 数量 说明 结果代码 result(Code String resultMsg 结果信息 String resultlnfo SpecialDto口 返回信息 0..n SpecialDto 字段 中文名称 数据类型 数量 说明 代码 code String 名称 String descript [请求示例 "hotelGroupCode""HTLG" [返回示例] "resultCode":0. "esultMsg";"查询成功" "resultlnfo" 24
GB/37976一2019 "code""EARLYCI" "descript";"提前人住" 6.3.3.5获取客房销售包价信息getPackages [功能说明] 获取酒店包价信息 [请求参数] 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String Hotel(Code 酒店代码 String [响应数据 中文名称 字段 数据类型 数量 说明 resultCode 结果代码 String 结果信息 resultMsg String 返回信息 PackageDtoC resultlnfo 0.,n PackageDto 字段 数据类型 中文名称 数量 说明 代吗 code String 名称 descript String [请求示例] "hotelGroupCode";"HTLG" [返回示例] "resultCode":0. "resultMsg";"查询成功" "esullnfo" "code";"BF" "descript""早餐" "code";"sVC" 25
GB/T37976一2019 "deseript";"服务费" 6.3.3.6获取入账代码etIransactionCodes [功能说明] 获取证件类型信息 [请求参数] 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String hoteCode 酒店代码 String [[响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String rresultMsg 结果信息 String resultlnfo 返回信息 TransactionDto[ 0..7 TransactionDto 字段 数据类型 说明 中文名称 数量 代码 code String 是 名称 String descript categoryCode 类别代码 否 String appSeope 适用范围 String 否 arrangeCode 账单码 String 否 [请求示例 "hotelGroupCode";"HTLG" "hotelCode";"GCBZ" 返回示例 "resultCode":0. sultMsg";"查询成功" res 'res sulInfo"[ "code";"0001" "desc trip""夜审房费" "categoryCode";"10", 26
GB/37976一2019 "appScope";"FAP" "10" "rngcole" "code";"9000" "de leserijpt";"人民币现金" yCode""A" 'category e" ”;"FAP" pSscope "appS eCode";"98" arrange 6.3.3.7步入散客walkin [功能说明] 客人不经过预订,直接在酒店前台办理人住 [请求参数 字段 说明 中文名称 数据类型 数量 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String rsvClass 人住类型 String F;散客;D;钟点 arrDate 人住时间 String 格式yyyy-MMddHH:mm;:ss 退房时间 depDate String 格式yyyy-MM-ddHH:mm;ss 房型代码 roomType String roomNo 房号 String String 姓名 name idCode 证件类型 String idNo 证件号码 String 性别 String seX 生日 birthday String 0. nation 国籍 0. String cardNo 会员卡号 String 0..l rateCode 房价码 String 0.. 房价 Decimal rate packageCodes 包价代码 String 0." markeCode 市场代码 String 来源代码 sourceCode String 渠道 channelCode String 27
GB/T37976一2019 [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 结果信息 resultMsg String RegEisteaD口 resultlnfo 返回信息 RegisterldDto 字段 中文名称 数据类型 数量 说明 id 登记单id String [请求示例] hotelGroupCode";"HTL.G", hotelCode";"HTI" "E rsvClass arrDate":"2016-11-0920:58:54" epDate";"2016-11-1012;00,00" roomType";"B" roomNo":"201 name idCode";"99 idNo":"1234567" birthday";"1996-1l1-10" nation':"CN" 1 CardNo" rateCode";"RACK" rate":189.00, packageCodes";"BF1" marketCode";"WAK" sourceCode";"WIK" channelCode";"OTH" [返回示例] "resultCode":0， "esultMsg""查询成功" "resultlnfo" "id";"100362" 28
GB/37976一2019 ereateReservatiom 6.3.3.8创建订单 功能说明] 创建订单 [请求参数] 数据类型 字段 中文名称 数量 说明 hoteGroupCode 酒店集团代码 String hotelCode 酒店代码 String arrDate String 格式 到达日期 yyMMddHHmm;ss depDate 离开日期 String 格式yyyy-MM-ddHH:mm;ss roomType 房型 String rateCode 房价码 String 房数 roomNum number rsvPerson 预订人 String 性别 sexCode String mobile 联系电话 String idType 证件类型 String 证件号码 idNo String email 邮箱 String 会员卡类别 cardType String 会员卡号 cardNo String aadutNumm 人数 number String 备注 remmark 0..l iscAnmount 优惠金额 decimmal 0. channeCode 销售渠道 String 0.1 special(Codes 特殊要求 String 0.l 付款状态 paySta String 0.l 来源 sourceCode 0..l String 市场 0. marketCode String channelCode 渠道 String 0..l packageCodes 包价 String 多选 0.,n dailyRate 每日房价 String 0.n 房号 String 0.l rooms 付款 charge decimal 0. 结账提醒 checkoutMsg String 0.l oTA渠道 otahannel String otaRsvNo 0TA预订号 String 0.. 29
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 其他预定号 otherRsvNo String 0.l 第 三方应用d 0..！ appid String 第三方应用的用户id openid String 0.. unionid 0..1 String [响应数据 字段 中文名称 数据类型 数量 说明 结果代码 resultCode String rresulMs 结果信息 sg String resultnfo ResrvDto 返回信息 ResrvDto 字段 中文名称 数据类型 数量 说明 crsNo 中央订单号 String 支付状态 paySta String 定金 Decimal deposit 请求示例] "hotelGroupCode""HTLG", "hotelCode";"HTI "ehcckoutMsg""aa" arrDate";"2016-08-1518;00;00" "depDate";"2016-08-1620;00;00" roomType";"ExT" rateCode";"BAR" roomNum" rsvMan";"aabbcc" t seX mobile""13567165880" 1 "idType tt "idNo" email";"134140@gg.com" paySta""o" cardTy ype cardNo adult remark "discAmount "0" "ehannel";"OTHI" 30
GB/37976一2019 "channelCode""WEB" "src";"WIK" "market""WAK" "crsNo""P201610180001" [返回示例咖 "resultCode":0. "resultMsg";"成功" "resultlnfo":' "crsNo""w1610180001" 6.3.3.9排房assignkomm [[功能说明] 给预订单分配房间 [请求参数 字段 说明 中文名称 数据类型 数量 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String crsNo 与rsvNo最少一个有值 中央订单号 String 0.l svNo 酒店订单号 String 与crsNo最少一个有值 0.l roomType 房型 String 房号 多房号逗号分隔 roomNos String 77 [响应数据 字段 数据类型 说明 中文名称 数量 resultCode 结果代码 String resultMsg 结果信息 String [请求示例] "hotelGroupCode";"HTIG"， "hotelcCode";"HTL" "crsNo";"w1610180001" "roomType";"ExT" "roomNo""1007" [返回示例] "esulCode":0. 31
GB/T37976一2019 "esultMsg";"成功" [[其他说明] -般先调用“获取订单列表”接口查询到酒店预订单,然后再调用此接口排房 6.3.3.10获取订单列表getReservationm [功能说明] 查询订单列表 [请求参数 字段 数据类型 数量 说明 中文名称 heGoup DCode 酒店集团代码 String crsNo 中央订单号 String 0..1 cardNo 会员号 String 0.1 arrDate 开始日期 String 0.1 yyyy-MMdd depDate 结束日期 yyyyMMdd String 0.l 开始行 irstResult number 0.l 分页数量 number pageSize 0.l [响应数据] 字段 数据类型 数量 说明 中文名称 resultCode 结果代码 String rresultMsg 结果信息 String resultlnfo 返回信息 ReservationDto门 ReservationDto 字段 中文名称 数据类型 数量 说明 ResrvDetailDto口 resrvlist 订单列表 1..n totalRows 总数 number ResrvDetailDto 字段 中文名称 数据类型 数量 说明 id 订单唯一标示 number 酒店代码 hotelCode String 酒店描述 hotelDeseript String 中央订单号 crsNo String rsvNo 酒店订单号 String 状态 String sta staDescript 状态描述 String paySta 支付状态 String 32
GB/37976一2019 字段 中文名称 数据类型 数量 说明 deposit 定金 Deeimal MMdd 到达日期 arrDate String yyyy-！ -MM-dd 离开日期 deplDate String yyyy！ roomType 房型 String roomTypeDeseript 房型描述 String 房价 Deeimal rate [请求示例] "hotelGrroupCode""HTLG," "crsNo";"w161o180001" [[返回示例] "resultCode":0. "resultMsg";"成功" 'resultlnfo'" "resrvList": "crsNo";"w1610180001" "sta";"R" "aysia";"o" deposit" :0 "arrDate";"2016-10-18" roomType""ExT" "hotelDeseript""××标准版标准库" ityCode";"HZZ1" "staDescript";"预订" "hotelCode";"HTL" "rate":499.00， "oomTypeDescript""行政双床", "depDate","2016-10-19” "totalRows";l 6.3.3.11支付pay [功能说明] 33
GB/T37976一2019 给订单支付款项 请求参数 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String crsNo 中央订单号 String money Decimal 金额 voucherNo 单据号 String 人账代码 TxnCode' String TxnRemark 人账备注 String hoteCode 酒店代码 String 0.1 酒店订单付款时必填 registerld 订单id String 0.l 酒店订单付款时与roomNo二选 酒店订单付款时与registerld二选 roomNo 房号 String 0.l [响应数据 字段 中文名称 数据类型 数量 说明 resulCode 结果代码 String resltMsg 结果信息 String 请求示例] "hoteGroupCode";"HTLG" ersNo""w1610180001" money""2.00" voucherN";"23400" "TxnCode";"9000" "TxnRemark""test" [返回示例 "resultCode":0. "resultMsg":"成功" 6.3.3.12消费charge [功能说明] 录人订单费用 请求参数 中文名称 数据类型 说明 字段 数量 hoteGroupCode 酒店集团代码 String rsNo 中央订单号 String 34
GB/37976一2019 字段 中文名称 数据类型 数量 说明 money 金额 Deeimal oueherNo 单据号 String TxnCode 人账代码 String TxnRemark 人账备注 String hotelCode 酒店代码 String 0.1 酒店订单付款时必填 registerld 订单id String 0.1 酒店订单付款时与roomNo二选 酒店订单付款时与registerld二选 roomNo 房号 String 0.l [[响应数据] 中文名称 数据类型 数量 字段 说明 resultCode 结果代码 String resultMsg 结果信息 String 请求示例] "hotelGroupCode";"HHTIG"， crsNo":"W1610180001" money";"2.00" "VoucherNo":"234001" "TxnCode";"4000" "TxnRemark";"test" [返回示例 resultCode";0, "resultMsg""成功" 6.3.3.13获取每日房价getDailyRate [功能说明] 获取指定日期、房型、房价代码的每日房价 [请求参数 字段 中文名称 数据类型 数量 说明 酒店集团代码 hotelGiroupCode String hoteCode 酒店代码 String arrDate 到达日期 String y-MM-ddl 格式 dayCount 格式yyyy-MM-dd 人住天数 String roomType 房型 String ateCode 房价码 String 35
GB/T37976一2019 [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String esultMsg 结果信息 String resultlnfo 返回信息 DailyRateDto 0." DailyRateDto 字段 数据类型 说明 中文名称 数量 日期 date String 价格为空值,则表示不可用 价格 rate decimmal rateCode 房价码 String 0. roomType 房型 String [请求示例] "hoteGiroupCode""HTLG" "hotelCode";"HTL" "arrDate";"2016-10-18" "dayCount";"1" "roomType";"HHsc" "rateCode":"RAC" 返回示例] "esultCode":0. "resultMsg";"成功" "resultlnfo";[ "date";"2016-10-1800:00;00" "rate";"500.00" "rateCode";"RAC" 'roo1m mType";"HHsC" 6.3.3.14保存每日房价saveDailyRate [[功能说明 保存或更新订单的每日房价 请求参数 36
GB/37976一2019 字段 中文名称 数据类型 数量 说明 lhotelGroupCode 酒店集团代码 String 中央订单号 crsNo String RsvRatewebDo dailyRate 每日房价 RsvRatewebDto 字段 说明 中文名称 数据类型 数量 日期 yyyyMMdd String date 价格 Deeimal rate [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 结果信息 resultMsg String 请求示例] "hotelGroupCode";"HTLG"， "ersNo";"w1610180001" "dailyRate""[("date""2015-12-01","realRate";"128.00")" [返回示例] "resultCode":0. "resultMsg";"成功" 6.3.3.15取消订单 cancelReservation [功能说明] 取消订单 请求参数] 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String crsNo 中央订单号 String 备注 String remark [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 37
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 结果信息 resultMsg String [请求示例] "crsNo""W1610180001" "remark" "其他原因" "hotelGroupCode""HTLG" [返回示例] "resulCode";0. "resultMsg";"成功" 6.3.3.16查询订单详情getReservationDetail [[功能说明 查询订单详情,包括中央预订和酒店预订的订单 请求参数 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String 非接口产生的订单则此参数必填， hotelCode 酒店代码 String 0. 如:打电话到酒店预订的订单 rsvNo 酒店订单号 String 0 酒店预订单通过此参数查询 中央订单号 中央订单通过此参数查询 crsNo String 0..1 [响应数据] 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 number resultMsg 结果信息 String Resultlnfo 返回信息 GuestDto GuestDto 字段 数据类型 数量 说明 中文名称 hotelCode 酒店代码 String hoteDeseript 酒店描述 String 预订单唯一标示 number id rsvType 预订类型 String rsvMan 预订人 String 38
GB/37976一2019 字段 中文名称 数据类型 数量 说明 手机 mobile String 0.l idIype 证件类型 0..l String idNo 证件号码 String 0.. sexDeseript 性别描述 String 性别代码 String sex roomType 房型 String roomTypeDescript 房型描述 String 房价 rate Decimal 房数 number rmNum -MM-dd arrDate 到达日期 String yyyy-！ depDate String y-MM-dd 离开日期 yyyy 状态 String sta staDeseript 状态描述 String 0;无需支付;l;待支付;2;已支付; 支付状态 paySta String 3:已退款 deposit 定金 Deeimal rateSum 房费合计 Deeimal 总消费 rateTotal Decima 备注 remark Decimal eityCode String 城市 0..l ereateDatetimme 创建时间 String modifyDatetime 修改时间 String roomlnfo 房间人住信息 RoomlnfoDto自 0.n 订单没排房的时候没有此信息 RoomlnfoDto 字段 中文名称 数据类型 数量 说明 登记单唯一标示 d number 住客姓名 name String 房号 roomNo String [请求示例] "hotelGroupCode";"HTLG" "crsNo";"w1610180001" [返回示例] 39
GB/T37976一2019 resultCode":0, "esultMsg""成功" resultlnfo" guest "idType sex payS "EXT" ype hotelIDescript";"××标准版标准库" eityCode";"HZZ1 staDescript""预订" rsvMan":"aabbce" sexDescript";"男" roomlnfo":L "id":l569021,"name";"张三","roomNo";"201" "hotelCode";"GCBz" "rate":720 "rmNum":l， "ereateDatetimme";"2016-10-0920;22;31" name";"aabbcc" roomTypeDeseript";"行政双床" depDate""2016-10-19" 'svType""002" idNo" "w1610180001" No" ersN sta":"R" 'arrDate";"2016-10-09”" 'modifyDatetime""2016-10-0920;22:31" email";"1341@qq.com' "ityDeserip""杭州" "ateSum".720. "mobile";"13567165880" 6.3.3.17查询入住订单详情getRegisterDetail [功能说明] 包括在住、结账、挂账的订单 40
GB/37976一2019 [请求参数 字段 中文名称 数据类型 数量 说明 酒店集团代码 hotelGroupCode String hotelCode 酒店代码 String registerld 订单id number 0..l 以下参数最少包含 roomNo 房号 String 0..l idNo 证件号 String 0.1 mobile 手机 String 0.l [[响应数据] 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 number resultMsg 结果信息 String resultlnfo 返回信息 String 0..n 同住人以多条记录返回 resultlnfo 字段 中文名称 数据类型 数量 说明 id 订单唯一标示 number name 住客姓名 String 手机 mobile 0. String idIype 证件类型 String idNo 证件号码 String 0.. sexDeseript 性别描述 String 性别代码 String seX roomNo 房号 String roomType 房型 String 房型描述 roomTypeDeseript String rate 房价 Decima 格式 MM-dd yyyy arrDate 到达时间 String HH.mm.8 格式yyy-MM-dd depDate 离开时间 String HH;mm;ss 状态 sta String 状态描述 String staDescript deposit 定金 Decimal rateSum 房费合计 Decimal rateTotal 总消费 Deeimal remark 备注 Deeimal 1
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 创建时间 createDatetime String 修改时间 nmodifyDatetime String 请求示例] "hotelGre roupCode" "GCG" "hoteCode";"GCBZ" "roomNo""0520" 返回示例] "resultCode""0" "resultMsg";"成功” "resultlnfo": "id":l6598 "张三" name mobile":"13588148120" "idType""99 "idNo";"1234567" seX sexDeseript";"男" 'roomNo":"0520" 'roomType";"B" 'roomTypeDeseript";"标间" 'rate":188 "arrDate";"2016-11-1014:16;46" depDate";"2016-11-1112;00;00" 'sta";"" 'staDeseript""在住" "deposit";"188" 'rateSum":l28 rateTotal";158. 'remark""" "ereateDatetime";"2016-11-0914:19;33" "modfyDatetime";"2016-1l1-1014:16;46" 42
GB/37976一2019 6.3.3.18入住cheekinm 功能说明] 订单人住 [请求参数] 字段 中文名称 数据类型 数量 说明 酒店集团代码 hotelGroupCode String hotelcode 酒店代码 String crsNo 中央订单号 String 0.. registerlds 订单ID集合 String 0.7n roomNos 房号 String 0., [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String esultMsg 结果信息 String [请求示例] "hoteGroupCode";"HTLG," "hotelCode":"HTI" "ersNo";"W1610180001" "roomNos":"301" [返回示例] "resultCode":0. "resultMsg”"成功" 6.3.3.19查询账单getBil [[功能说明] 给订单支付款项 [请求参数] 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String registerlds 订单ID集合 String ln 账目类别 0;不限;l消费项;2;支付项 taType String 结账状态 String 0;不限;l;未结账;2;已结账 closeSta 43
GB/T37976一2019 [响应数据 字段 中文名称 数据类型 数量 说明 结果代吗 resultCode String resultMs 结果信息 Msg String resullnfo 返回结果 String 0..n resultlnfo 字段 数据类型 数量 说明 中文名称 登记单ID number registerld 账次编号 number number accountld 账务编号 number roomNo 房号 String 0. taCode 账务代码 String aDescript 账务名称 String 金额 amount Decimal taRemmark 账务备注 String 0 创建人 ereateUser String createDatetime 创建时间 String [请求示例] "hoteGroup(Code" "HTIG" "registerlds";""692" "taType":"0" "closeSta";"0" [返回示例 "resultCode":0. "resultMsg""成功" : "resultlnfo" "registerld";:692. "mumber";l "accountld";10946. "roomNo""0530" "taCode""o001" taDescrip";"夜审房费", "amount":100. "taRemark": 44
GB/37976一2019 "ereateUser""ADMIN" "createDatetime";"2016-11-101l:4l;20" 6.3.3.20续住extendStay [功能说明] 宾客延长离店日期 [请求参数 字段 数据类型 数量 说明 中文名称 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String registerlad 登记单id String 0.l 与crsNo二选一必填 crsNo 中央订单号 String 0.l 与registerld二选一必填 离店日期 格式yy-MMIMddHH;mm;s depDate String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String [请求示例] "hotelGroupCode";"HTLG"， "hotelCode":"HTI" "registerld";"100326" "depDate";"2016-ll-l912:00:00" [返回示例] "resultCode":0. "resultMsg""成功" 6.3.3.21退房checkout [功能说明] 客人退房离店 45
GB/T37976一2019 请求参数 字段 数据类型 数量 说明 中文名称 酒店集团代码 hotelGroupCode String hotelCode 酒店代码 String registerlds 登记单id集合 String 与ersNo二选一必填 0..n crsNc 中央订单号 String 0.1 与registerlds二选一必填 roomNos 房号 String 0.n departureSta 离店状态 String O;结账;S;挂账 [响应数据] 数据类型 数量 说明 字段 中文名称 resulCode 结果代码 String resultMsg 结果信息 String [请求示例] "hotelGroupCode";"HTLG" "hotelCode";"HTL" "crsNo";"w1610180001" "roomNos";"201" "departureSta""O" [返回示例] "resultCode":0. "resultMsg";"成功" 6.3.4前台业务 6.3.4.1查询协议单位geCompany [功能说明] 获取协议单位信息 请求参数 字段 数据类型 说明 数量 中文名称 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String companyld 协议单位ID String 0.l companyName 协议单位名称 String 0.l 46
GB/37976一2019 [响应数据 字段 中文名称 数据类型 数量 说明 结果代码 resultCode String esaMss" 结果信息 String resultlnfo CompanyDto们 返回信息 0..l CompanyDto 数据类型 数量 说明 字段 中文名称 协议单位ID companyld String 协议单位名称 String comapnyName inkman 联系人 String mobile 手机号码 String phone 电话号码 String sta 状态 String 房价码 rateCode String arno 应收账户 String 6.3.4.2锁房lockRoom [功能说明] 锁房 [请求参数] 字段 中文名称 数据类型 数量 说明 Code 酒店集团代码 hotelGiroup String hotelCode String 酒店代码 registerld 订单ID String 0.1 房号 String 可多个,逗号分隔 rmno operationType 操作类型 String 0.l l:上锁;2:解锁 [[响应数据] 字段 中文名称 数据类型 数量 说明 result(Code 结果代码 String resultMsg 结果信息 String 返回信息 resultlnfo 0." String 6.3.4.3房卡数量查询findRomCardNum [功能说明] 查询房卡数量 47
GB/T37976一2019 请求参数] 字段 中文名称 数据类型 数量 说明 hoteGroupCode 酒店集团代码 String 酒店代吗 hotelCode String 订单 ID String 0 registerld [响应数据] 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String esultMsg 结果信息 String resultlnfo 返回信息 Message口 Message 数量 说明 字段 中文名称 数据类型 String 固定值;l num roomCardNum 房卡数量 String 6.3.44更新房卡数量updaeRmCariNum [功能说明] 更新房卡数量 [请求参数] 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String hoteCode 酒店代码 String registerld 订单lD String 0.l number 房卡数量 0 String [响应数据] 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String resultlnfo 返回信息 String 成功:l;失败;2 6.3.4.5联房linkRoom [功能说明 联房 48
GB/37976一2019 [请求参数 字段 中文名称 数据类型 数量 说明 酒店集团代码 hotelGroupCode String hotelCode 酒店代码 String registerld 订单lID String 0..l inkld 联房ID String 可多个,用“|”分隔 0.7n [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String esultMsg 结果信息 String resultlnfo 返回信息 String 成功:l;失败:2 6.3.4.6查找订单findOrder [功能说明] 查找订单 [请求参数] 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String hotel(Code 酒店代码 String 1,订单号;2;预订人公民身份号 码;3;预订人手机号码;4营业员 earehrye 查询值类型 0..l String 5:人住人姓名;6;公民身份号码井 姓名 [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String resultlnfo 返回信息 Orderlnfo口 订单信息 0., O)rderlnfo 中文名称 字段 数据类型 数量 说明 registerld 订单ID String 姓名 String name mobile 电话号码 String 预定时间 reserveTime String 抵达日期 arr String 49
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 dep 离店日期 String 担保类型 guaranteeType String 已支付金额 pay String rmtype 房间类型 String 房间数量 String rmnum 房号 String rmno arrDate 人住日期 String 包价 packages String memberNo 会员号 String 会员类型 String memberType ompanyName String 协议单位名称 companyld 协议单位ID String sourceName 渠道商名称 String rsvno 订单号 String remark 备注 String 预定类型 rsvClass String 支付方式 String payCode linkld 联房ID String isMainMaster 是否主单 String 1;是;2;否 Ratecode 房价码 String isSecretRate 房价是否保密 String rsvld 预定lID String 订单状态 sta String rsvsrecla 纯预留D String 6.3.4.7 mforFront 预定排房assignRoom [功能说明] 预定排房 请求参数 字段 数据类型 数量 说明 中文名称 hotel(GroupCode 酒店集团代码 String hoteCode String 酒店代码 registerld 订单ID String rsvsreld 纯预留ID String 纯预留id与房型二选 0. rmtypeCode 房型代码 String 0. 纯预留id与房型二选一 可多个,用"|”分割 rmno 房号 String 0." 50
GB/37976一2019 [响应数据 字段 中文名称 数据类型 数量 说明 结果代码 resultCode String resultMsg 结果信息 String 返回信息 resultlnfo String 6.3.4.8是否存在入住单existOrder [功能说明] 是否存在人住单 [请求参数] 字段 中文名称 数据类型 数量 说明 lhotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String searchType 查询类型 String 2:身份证;3:房号;4:订单ID 查询值匹配类型 String 1;模糊匹配;2;完全匹配 searchValueType 可多个,用“|"分割 searchValue 查询值 String 0.n [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String 返回信息 resultlnfo 0." Message自 Mesage 字段 中文名称 数据类型 数量 说明 registerld 订单ID String allowCheckOut 是否允许结账 String l:是;2:否 6.3.49发房卡预处理sendRoomCard [功能说明] 发房卡预处理 [请求参数] 字段 说明 中文名称 数据类型 数量 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String featureType 特征类型 1:;房号;2;订单ID String cardOperationType 卡操作类型 String 1;发新卡;2;发同住人房卡 featureValue 特殊值 String 特殊值 51
GB/T37976一2019 [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 结果信息 resultMsg String resulnfo 返回信息 String 6.3.4.10查询订单付款情况nimdorderwithrPay [功能说明] 查询订单付款情况 [请求参数 字段 中文名称 数据类型 数量 说明 酒店集团代码 hotelGiroupCode String hotelCode String 酒店代码 registerld 订单ID String 预定号 rsVno String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 结果信息 rresultMsg String resultlnfo 返回信息 Message Mesage 字段 中文名称 数据类型 数量 说明 totalRmFee 总房费 String 预付款 imprest String registerlad 订单ID String allowCheckin 是否允许自助机人住 ;允许;2;不允许 String 6.3.4.11 保存发卡记录saveSendCardRecord [功能说明 保存发卡记录 [请求参数 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String hoteCode 酒店代码 String 52
GB/37976一2019 字段 中文名称 数据类型 数量 说明 registerld 订单ID String 客人姓名 0..l guestName String cardNo 卡号 String 0.. [响应数据 字段 中文名称 数据类型 数量 说明 结果代码 resultCode String esaMss" 结果信息 String 返回信息 Message[口 resultlnfo Messge 中文名称 数据类型 字段 数量 说明 num String 固定值;0000001 6.3.4.12查询发卡记录findSendCardRecord [[功能说明] 查询发卡记录 C请求参数] 字段 中文名称 数据类型 数量 说明 hotel(GroupCode 酒店集团代码 String hotelCode 酒店代码 String registerld 订单ID String cardNo 卡号 String [[响应数据] 字段 说明 中文名称 数据类型 数量 resulCode 结果代码 String esultMsg 结果信息 String resultlnfo 返回信息 Message口 0.1 Message 字段 数据类型 数量 说明 中文名称 erld 订单D register String ereateDatetime 发卡时间 String 6.3.4.13升级订单房型updateRmtype [功能说明] 53
GB/T37976一2019 升级订单房型 请求参数 字段 数据类型 数量 说明 中文名称 酒店集团代码 hotelGroupCode String hotelCode 酒店代码 String 订单ID registerld String rmType 房型 String certigier 授权人 String 房号 String rmno 0.. [响应数据 说明 字段 中文名称 数据类型 数量 telcode 结果代码 String rresultMsg 结果信息 String 返回信息 固定值 resullnfo String 6.3.4.14取消 cancel [功能说明] 取消 [请求参数 字段 中文名称 数据类型 数量 说明 hotel(GroupCode 酒店集团代码 String hotelCode 酒店代码 String registerld 订单lID String 备注 remark 0..1 String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String resultlnfo 返回信息 String 固定值;0000001 6.3.4.15修改订单备注信息updateOrderRemark [功能说明] 修改订单备注信息 请求参数] 54
GB/37976一2019 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String 酒店代码 hotelCode String registerld 订单ID String 备注 remark String 0.l [[响应数据] 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String esultMsg 结果信息 String resultlnfo 返回信息 String 固定值:0000001 6.3.4.16修改订单允许记账信息updateOrderPostimng [[功能说明] 修改订单允许记账信息 [请求参数] 字段 中文名称 数据类型 数量 说明 lhotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String 订单ID registerld String *;全部打开 .;全部关闭 其他;指定项目允许记账,多个项 posting 允许记账信息 String 目之间用“”符号隔开,没有指定 的项目将关闭允许记账 [[响应数据] 中文名称 字段 数据类型 数量 说明 reslCode 结果代码 String esltMsg 结果信息 String resultlnfo 返回信息 String 固定值:0000001 6.3.4.17查询指定房号房态findRmstaByRmno [功能说明] 查询指定房号房态 55
GB/T37976一2019 请求参数 数据类型 字段 中文名称 数量 说明 酒店集团代码 hotel(GiroupCode String hotelCode 酒店代码 String beginDate 开始日期 String -MM-dd 格式 endDate 结束日期 String 格式;yyyy-MMdd 房号 String rmno [响应数据] 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String 返回信息 resultlnfo 0.,n RmStalnfo RmStalnfo 字段 中文名称 数据类型 数量 说明 房号 rmno String beginDate 开始日期 String registerld 订单ID String 0:未知;l:空净房;2;空脏房 房态 roomSta String 3在住房4,维修房5,临时房x 6.3.4.18可用空房列表findFreeRoomList [[功能说明 查询可用空房列表 请求参数 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String 房类 String 0..！ rmtype building 楼宇 String 0.l 楼层 floor String 0.. staOce 是否包含临时可用房 String 0.l 房态 rmsta String 0..1 rmno 房号 String 0." 到达日期 arrD)ate 0..1 String depDate 离店日期 String 0.l maxResult 最大数量 String 0. 56
GB/37976一2019 [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String ewlMsg 结果信息 String resultlnfo 返回信息 Roomlist[口 0., RoomList 数据类型 字段 中文名称 数量 说明 building 楼宇 String floor 楼层 String 房号 String rmno d 主键 String 房态表主键 房型 String rmtype 6.3.4.19查询所有房态findAIMRoomSta [功能说明] 查询所有房态 [请求参数 字段 中文名称 数据类型 数量 说明 酒店集团代码 lhotelGroupCode String hotelCode 酒店代码 String mtype 房类 String 0.l building 楼宇 String 0..l loor 楼层 String [响应数据 字段 说明 中文名称 数据类型 数量 resultCode 结果代码 String esultMsg 结果信息 String resulnfo 返回信息 RoomStaList[ 0..7n RoomStalist 字段 数据类型 说明 中文名称 数量 building 楼宇 String loor 楼层 String 房号 String rmno 57
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 id 主键 String 房态表主键 房型 rmtype String isDep 是否本日离开 1香;2;是 String countRoomSta 6.3.4.20当前房态统计 [功能说明] 当前房态统计 请求参数] 字段 中文名称 数据类型 数量 说明 hoteGroupCode 酒店集团代码 String boeode 酒店代码 String 房类 String 0. rmtype 楼宇 bilding String 0.l 房态 String rmsta 0.1 房号 rmno String 0." [响应数据 字段 中文名称 数据类型 数量 说明 结果代吗 resultCode String resultMsg 结果信息 String resullnfo 返回信息 RoomStaCount口 0." Roomlist 字段 数量 说明 中文名称 数据类型 rmtype 房型 String totalNum 房间总数 String 空净房数 cleanNum String 空脏房数 dirtyNum String maintainNum 维修房数 String 临时不可用房数 String empporary checknNum 在住房数 String 6.3.4.21 入住cheekIn [功能说明] 人住 58
GB/37976一2019 [请求参数 字段 中文名称 数据类型 数量 说明 酒店集团代码 lhotelGroupCode String hotelCcode 酒店代码 String registerld 订单ID String 房型 rmtype String 0.l ateCode 房价码 String 0. 房号 rmno String 0.l 人住日期 String arrDate 0..l 总房费 otalRoomFee String 0.l mealITieketMonesy 餐券金额 0.. String menberNo 会员卡号 String 0. memberl.evel 会员级别 0..l String 人住人姓名 String 0. name 手机号码 0. mobile String payType String 0. 支付类型 设备人工 operationer String 0. cashier 班别 String 0.1 联房人住单ld linkld String 0.l checklnTime 人住时间 String 0.1 格式 y-MM-ddHH:;MM:SS ;yyyy checkOutTime 离店时间 String 0.l 格式;yyyy-MMddHHMM;SS ehecklnType 人住类型 String 0..l makeOrderObjeet 下单方 String 0.1 make(Order:Time 下单时间 0..l String 房号 String 0.1 rmno bekFlug" 锁房标记 0. String date 日期 String 0.1 备注 remark String 0.l [[响应数据] 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String esultMsg 结果信息 String resultlnfo 返回信息 Message[口 0. 59
GB/T37976一2019 Message 字段 中文名称 数据类型 数量 说明 registerld 订单ID String 支付记录 payRecordl String idNo 客 人证件号 String 6.3.4.22添加账务addAccount [功能说明] 添加账务 [请求参数] 字段 数据类型 数量 说明 中文名称 酒店集团代码 String hotel(GiroupCode hotelCode 酒店代码 String 订单D registerld String 操作者 String 0. oprato6 casie 班别 String 0.l tacode 人账代码 String 0.1 人账备注 taRemark String 0.l cardNo 卡号 String 0.. authNo 预授权号 String 0.l curExchgNo 水单号 String 0..1 remark 预授权备注 String 0.l [响应数据 字段 中文名称 数据类型 数量 说明 结果代吗 resultCode String resultMsg 结果信息 String resultlnfo 返回信息 String 0.. 6.3.4.23网站预付webPay [功能说明] 网站预付 请求参数 中文名称 数据类型 字段 数量 说明 hoteGroupCode 酒店集团代码 String hotelCode 酒店代码 String 60
GB/37976一2019 字段 中文名称 数据类型 数量 说明 registerld 订单ID String 付款码 tacode 0..l String [响应数据 数据类型 数量 说明 字段 中文名称 结果代码 resultCode String esaMss" 结果信息 String resultlnfo 返回信息 固定值0 String 0..l 6.3.4.24查询客房账单findRoomBi [功能说明] 查询客房账单 [请求参数 字段 数据类型 中文名称 数量 说明 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String registerld 订单ID String tacode 付款码 String 0.1 账务ID String 0.1 accnt [[响应数据] 字段 中文名称 数据类型 数量 说明 reslCode 结果代码 String esultMsg 结果信息 String resultlnfo 返回信息 RoomBillnfo口 0.n RoomBil 字段 中文名称 数据类型 数量 说明 accnt 账务ID String number 账次 String 房号 rmno String 主键 String Account表 描述 descript String arrangeCode 账单码 String genDate 人账时间 String taCode 付款码 String createUser 创建者 String 81
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 taRemark 备注 String 代码 code String 6.3.4.25查询会员详情findmMemmberlnfo [功能说明] 查询会员详情 C请求参数] 字段 数量 说明 中文名称 数据类型 hotelGroupCode 酒店集团代码 String 酒店代码 hoteCode String l:会员卡号;2;公民身份号码; 查询类型 searchType String 3:手机号码 searchValue 查询值 String 0.l rmemberCardPassType 会员卡密码类型 String 0.l l:;登录密码;2:消费密码 member(CardlPass 会员卡密码 String 0.l [[响应数据 字段 数据类型 数量 说明 中文名称 resultCode 结果代码 String esultMsg 结果信息 String resultlnfo 返回信息 Memberlnfo口 0." Memberlnfo 字段 说明 数据类型 中文名称 数量 memberl.evel String 会员级别 memberNo 会员卡号 String 姓名 String name birthday 生日 String nmobile 手机号码 String 证件类型 idType String idNo 证件号码 String memberCardBanlance 会员卡余额 String R;初始;l;有效;X;销卡;L;挂失; memberCardSta 会员卡状态 String M损坏;o.停用;s;休眠 rateCode 会员对应房价码 String date 会员延迟退房时间 String otalConsume 总消费 String 62
GB/37976一2019 字段 中文名称 数据类型 数量 说明 freezeMoney 冻结金额 String 关联电子券信息 couponlnfo String 6.3.4.26注册会员registerMember [功能说明] 注册会员 [请求参数] 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String emberPlan 会员计划 String 姓名 name String 0.l 公民身份号码 identitvCard 0. String mobile 手机号码 0..l String payCode 付款码 String 0. payMoney 支付金额 String 0.1 授权人工号 String 0.1 operatr memberNo 会员卡号 String 0.l [[响应数据] 字段 数据类型 数量 说明 中文名称 resulCode 结果代码 String resultMsg 结果信息 String resultnfo 返回信息 String 卡号 0. 6.3.4.27 会员卡充值rechargeNlemberCard [功能说明 会员卡充值 [请求参数] 数据类型 字段 中文名称 数量 说明 酒店集团代码 hotelGiroupCode String hoteCode 酒店代码 String memberNo 会员卡号 String 充值金额 0. String money 消费密码 String 0. password 支付方式 payCode String 63
GB/T37976一2019 [响应数据 字段 中文名称 数据类型 数量 说明 结果代吗 resultCode String resultMs 结果信息 Msg String resullnfo 返回信息 String 0..1 充值记录 6.3.4.28处理储值卡消费,退款方法dealVaueCardChargeOrRefund [功能说明] 处理储值卡消费退款方法 [请求参数 字段 中文名称 数据类型 数量 说明 hoteGroupCode 酒店集团代码 String hoteCode 酒店代码 String registerld 订单ID String 刷卡金额 String 0.1 money 1;刷卡消费;2;消费撒销一退款> 交易类型 type String 0..1 3;预授权;4;预授权撤销 record 原始交易记录ID String 0.l 0 password 消费密码 String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 结果信息 rresultMsg String resultIno 返回信息 String 0 6.3.4.29会员卡刷卡swipeCard [功能说明] 会员卡刷卡 请求参数] 字段 中文名称 数据类型 数量 说明 酒店集团代码 hotelGroupCode String hotelCode 酒店代码 String memberNo 会员卡号 String 刷卡金额 String money 0. 交易类型 String 0. type record 原始交易记录ID String 0.l 64
GB/37976一2019 字段 中文名称 数据类型 数量 说明 password 消费密码 String 0.l 订单ID 0..l registerld String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMs 结果信息 E String resultlnfo 返回信息 刷卡记录编码 String 0..l 6.3.4.30查询过夜房价findOerNightRoomRate [功能说明] 查询过夜房价 [请求参数 字段 数据类型 数量 说明 中文名称 酒店集团代码 lhotelGroupCode String hotelCode String 酒店代码 beginDate 开始日期 String 结束日期 endD)ate String roomType 房型 String 0. ateCode 房价码 String 0..l [[响应数据] 中文名称 数据类型 字段 数量 说明 resulCode 结果代码 String 结果信息 esultMsg String resultlnfo Message口 返回信息 0.,n Message 字段 中文名称 数据类型 数量 说明 date 业务日期 String 房型 roomType String ratel 标准过夜房价 String rate2 标准凌晨房价 String 折后过夜房价 rate3 String rate4 折后凌晨房价 String 65
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 rateCode 房价码 String 价格类别 rateTyp String sureRate 成交价格 String 6.3.4.31查询多天房类资源findRomIypeResouree [功能说明] 查询多天房类资源 [请求参数] 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String hoteCode 酒店代码 String beginDate 开始日期 String 结束日期 endDate String 房型 String 0 roomType [响应数据] 字段 中文名称 数据类型 数量 说明 result(Code 结果代码 String 结果信息 resultMsg String 返回信息 resultlnfo 0..n Message Mesuge 字段 中文名称 数据类型 数量 说明 beginDate 开始日期 String roomType 房型 String 房数 roomNuum String 6.3.4.32查询预订单findAdvanceOrder [[功能说明] 查询预订单 [请求参数 字段 数据类型 数量 说明 中文名称 hotelGroupCode 酒店集团代码 String 酒店代码 hoteCode String idNo 证件号码 String registerld 订单ID String 66
GB/37976一2019 字段 中文名称 数据类型 数量 说明 rmNo 房号 String 0.l 手机号码 mobile 0..l String 2;公民身份号码 searhType 查询类型 String 0.1 3;房号;4;订单D [[响应数据] 字段 说明 中文名称 数据类型 数量 resulCode 结果代码 String resultMsg 结果信息 String resultnfo 返回信息 Orderlist[口 0., OrderList 字段 中文名称 数据类型 数量 说明 rregisterld 订单ID String 预住人姓名 name String date 人住时间 String 离店时间 depTime String rmType 房型 String 房号 rmno String linkld 联房标记 String 会员卡号 memberNo String eheekType 人住类型 String memberl.evel 会员卡级别 String 是否允许续住 是;2否;3.自定义 allowStay(Over String banlance 账单余额 String 每日房价 everyRate String allowCheckInByAceredit 是否用预授权人住 String l;是;2:否 协议单位中文描述 description String inkRoomlnfo 联房房间信息 String 付款码 payCode String 预定类型描述 String rsvTypeDese 6.3.4.33续住stayOver [功能说明 续住 87
GB/T37976一2019 请求参数 字段 中文名称 数据类型 数量 说明 酒店集团代码 hotelGroupCode String hotelCode 酒店代码 String ylnfo 支付信息 String pay registerld 订单ID String cashier 班别 String 0.1 1:早班;2;中班;3;晚班;4;夜审 ouponNo 优惠券号 String 0.l couponVaue 优惠券面值 String 0.l date 人住日期 String 设备人工编号 operator String [响应数据 数据类型 字段 中文名称 数量 说明 结果代码 result(Code String resultMs 结果信息 String Msg resullnfo 返回信息 固定值.0000001 String 0..1 6.3.4.34转账transferAccount [功能说明] 转账 [请求参数] 字段 数据类型 中文名称 数量 说明 hotel(GroupCode 酒店集团代码 String hoteCode 酒店代码 String fromRegisterld 源订单ID String destinationRegisterld 目标订单ID String [响应数据] 字段 中文名称 数据类型 数量 说明 result(Code 结果代码 String resultMsg 结果信息 String 返回信息 resullnfo String 6.3.4.35查询是否过夜审indlsOverNightAudit [功能说明] 查询是否过夜审 请求参数] 68
GB/37976一2019 字段 中文名称 数据类型 数量 说明 lhotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String [[响应数据] 数据类型 数量 字段 说明 中文名称 resultCode 结果代码 String esultMsg 结果信息 String resultlnfo 返回信息 String 1:自动夜审;2:已过夜审;0;未过夜审 6.3.4.36自助退房serCheckOut [功能说明] 自助退房 [请求参数] 字段 数量 说明 中文名称 数据类型 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String registerlad 订单ID String [响应数据 字段 中文名称 数据类型 数量 说明 结果代码 resultCode String esaMss 结果信息 String resultlnfo 订单ID 返回信息 String 6.3.4.37 结账checkOut [[功能说明] 结账 [请求参数] 数据类型 数量 说明 字段 中文名称 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String ahekTye 结账类型 1/2退房;4挂AR;5:挂账 String 加收方法数量 String amount 0..l registerld 0. 订单ID String arAccnt AR账户 String 0. acent 账务ID String 0.l 69
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 arrangeCode 人账代码 String 0.l 稽核用 mode 0..！ String [响应数据 中文名称 数据类型 数量 说明 字段 resultCode 结果代码 String esultMsg 结果信息 String 返回信息 resultlnfo String 账务lD 6.3.4.38查询楼宇列表findBuildList [功能说明 查询楼宇列表 [请求参数 字段 数量 数据类型 说明 中文名称 酒店集团代码 String hotelGroupCode hotelCode 酒店代码 String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 结果信息 rresultMsg String resultlnfo 返回信息 0.,n Message自 Mesuge 字段 中文名称 数据类型 数量 说明 buildingCode 楼宇编码 String buildingDes 楼宇描述 String 6.3.4.39查询楼层列表findFloorList [功能说明 查询楼层列表 请求参数 字段 中文名称 数据类型 数量 说明 hotel(GroupCode 酒店集团代码 String 酒店代码 hotelCode String wanCe 楼宇编码 String 70
GB/37976一2019 [响应数据 字段 中文名称 数据类型 数量 说明 reslCode 结果代码 String 结果信息 resultMsg String resultlnfo 返回信息 Message口 0., Mesage 中文名称 字段 数据类型 数量 说明 buildingCode 楼宇编码 String 楼层编码 floorCode String floorName 楼层名称 String floorSta 楼层状态 String 6.3.4.40查询房型列表indRoomIypeList [功能说明] 查询房型列表 [请求参数] 数据类型 字段 中文名称 数量 说明 酒店集团代码 lhotelGroupCode String 酒店代码 hotelCode String [[响应数据] 字段 数量 说明 中文名称 数据类型 resultCode 结果代码 String resultMsg 结果信息 String 返回信息 Message口 resultlnfo 0.n Message 字段 说明 中文名称 数据类型 数量 rmtypeCode 房型编码 String rmtypeName 房型名称 String 6.3.4.41查询房间列表fimdRoomList [功能说明] 查询房型列表 [请求参数] 71
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 hotel(GroupCode 酒店集团代码 String hotel(Code 酒店代码 String [响应数据 中文名称 数量 说明 字段 数据类型 resultCode 结果代码 String resultMsg 结果信息 String 返回信息 resultlnfo 0..n Message Message 字段 中文名称 数据类型 数量 说明 rmnoCode 房号编码 String rmno 房号 String rmtypeCode 房型编码 String buildingCode 楼宇编码 String floorCode 楼层编码 String 门锁串号 nuum String 公安系统房号 String rmnol 门锁设备楼栋 buildingl String floorl 门锁设备楼层 String 门锁设备流水 serialNum 号 String lockNum 门锁设备微信开门锁号 String 房间特征编码 roomFeature String 6.3.4.42查询会员级别indMemberLeve [功能说明] 查询会员级别 [请求参数 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String brandCode 品牌代码 String [[响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String esultMsg 结果信息 String resultlnfo 返回信息 Message自 0.n 72
GB/37976一2019 Message 字段 中文名称 数据类型 数量 说明 会员卡类别 memberCardType String menmberCardlevel 会员卡等级 String memberl.eveName 会员等级名称 String depTime 最晚离店时间 String rateCode 房价码 String 6.3.4.43查询钟点房价格findHourRoom [[功能说明] 查询钟点房价格 [请求参数] 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String [[响应数据] 字段 中文名称 数据类型 数量 说明 result(Code 结果代码 String resultMsg 结果信息 String 返回信息 resultlnfo 0." Message自 Mesugee 字段 中文名称 数据类型 数量 说明 rmtypeCode 房型代码 String 0.l 价格是否和客人 ratewithGuestType String 0. 类型有关 房价代码 rateCode 0. String 第一阶段时长 0..l stepl String step2 String 0.1 第二阶段时长 step3 第三阶段时长 String 0. step4 第四阶段时长 String 0.1 earliestArrDate 最早人住时间 String 0.l 最晚人住时间 latestDepDate String 0.l 会员级别 memberl.evel 0..l String 6.3.4.44查询入住单房价findOrderRate [功能说明] 73
GB/T37976一2019 查询人住单房价 请求参数 字段 中文名称 数据类型 数量 说明 hotel(GroupCode 酒店集团代码 String hotelCode 酒店代码 String 订单 ID registerld String checkInDate 人住日期 String [响应数据] 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String 返回信息 resultlnfo Message自 0." Message 字段 数据类型 数量 说明 中文名称 ehecklnlDate 人住日期 String 0. 房价 String 0.1 rate registerld 订单ID String 0.1 6.3.4.45加收房费addRoomFee [功能说明 加收房费 请求参数] 字段 中文名称 数据类型 数量 说明 hotel(GroupCode 酒店集团代码 String 酒店代码 hotelCode String 订单D registerld String 房费类型 ERT 0,不限;l;全天;2;半天 room String 0.. String 加收金额 money 0.1 自助设备专用工号 String operatorl 存储于账务摘要， 设备人工编号 operator2 String 区分人账客户端 1:早班;2:中班; 班别 cashier String 3;晚班;4;夜审 [[响应数据 74
GB/37976一2019 字段 中文名称 数据类型 数量 说明 结果代码 resultCode String eswlMg 结果信息 String resultlnfo 返回信息 String 6.3.4.46查询房费加收状态findAddRoomFeeSta [功能说明] 查询房费加收状态 [请求参数] 字段 说明 中文名称 数据类型 数量 hotelGroupCode String 酒店集团代码 hotelCode 酒店代码 String registerld 订单ID String [响应数据 字段 数据类型 数量 中文名称 说明 resultCode 结果代码 String resultMsg 结果信息 String resultlnfo Message口 返回信息 0.7n Message 字段 中文名称 数据类型 数量 说明 registerld 订单ID String 是否加收房费 1;是;2;否;3;不确定 isAddRoomFee 0. String inereasedRoomFee 应加收的房费 String 0..l accountBalance 账户余额 String 0.. 6.3.4.47查询工号列表findworkNumList [功能说明] 查询工号列表 请求参数] 字段 说明 中文名称 数据类型 数量 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String [响应数据 75
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 结果代码 resultCode String rresulMs 结果信息 sg String resultnfo Message口 返回信息 0..n Message 字段 中文名称 数据类型 数量 说明 workNum 工号 String name 姓名 String 6.3.4.48查询酒店详情findHotellnfo [功能说明 查询酒店详情 [请求参数 字段 数量 数据类型 说明 中文名称 酒店集团代码 String hotelGroupCode hotelCode 酒店代码 String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 结果信息 rresultMsg String resultlnfo 返回信息 0.,n Message自 Mesuge 字段 中文名称 数据类型 数量 说明 brandCode 品牌代码 String hoteCode 酒店代码 String hotelDescript 酒店描述 String 6.3.4.49查询品牌列表findBrandList [[功能说明 查询品牌列表 [请求参数 数据类型 字段 中文名称 数量 说明 酒店集团代码 hotelGroupCode String hotelCode 酒店代码 String 76
GB/37976一2019 [响应数据 字段 中文名称 数据类型 数量 说明 结果代码 resultCode String esaMss" 结果信息 String resultlnfo Message门 返回信息 0.. Message 字段 数据类型 说明 中文名称 数量 brandCode 品牌代码 String 品牌名称 brandName String 6.3.4.50查询酒店夜审状态indHoteINighAditSta [功能说明] 查询酒店夜审状态 请求参数 字段 说明 中文名称 数据类型 数量 酒店集团代码 hotelGroupCode String hotelCode 酒店代码 String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String esultMsg 结果信息 String resultnfo 返回信息 Message口 0.1 Message 字段 数据类型 数量 说明 中文名称 bizDate 营业日期 String isAudit 是否已夜审 String 6.3.4.51查询房价码findRateCode [[功能说明] 查询房价码 [请求参数] 字段 中文名称 数据类型 数量 说明 hoteGroupCode 酒店集团代码 String hoteCode 酒店代码 String 房价码类别 rateCodeType String 77
GB/T37976一2019 [响应数据 数据类型 字段 中文名称 数量 说明 结果代码 result(Code String resultMs9 结果信息 String resultlnfo 返回信息 Message 0.n Message 字段 说明 中文名称 数据类型 数量 rateCode String 房价码 rateCodeDeseript 房价码描述 String package 包价 String 6.3.4.52自助退房(查询查房结果 [[功能说明] 自助退房(查询查房结果). [请求参数 字段 中文名称 数据类型 数量 说明 酒店集团代码 hotelGiroupCode String hotelcode 酒店代码 String registerld 订单ID String [响应数据 字段 中文名称 数据类型 数量 说明 resulCode 结果代码 String resltMsg 结果信息 String resultInfo 返回信息 Message印 0. Message 字段 中文名称 数据类型 数量 说明 registerld 订单ID String 9;查房完成 结果 result String 其他值查房未完成 6.3.4.53迷你吧入账p0stMiniBar [功能说明] 迷你吧人账 请求参数] 78
GB/37976一2019 字段 中文名称 数据类型 数量 说明 lhotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String 订单ID egisterld String 0.. articleCode 商品代码 String 0..l articleNum 商品数量 String 0. [响应数据 字段 说明 中文名称 数据类型 数量 resulCode 结果代码 String esultMsg 结果信息 String resultnfo 返回信息 String 人账成功或失败消息 6.3.4.54迷你吧物品查询findMiniBarArticle [[功能说明] 迷你吧物品查询 [[请求参数 字段 数据类型 数量 说明 中文名称 hotelGroupCode 酒店集团代码 String hoteCode 酒店代码 String [[响应数据] 字段 数据类型 数量 说明 中文名称 resultCode 结果代码 String esultMsg 结果信息 String resultlnfo 返回信息 Articlelnfo口 0.n Articlelnfo 字段 中文名称 数据类型 数量 说明 feeCode 迷你吧费用编码 String articleCode 迷你吧商品编码 String articleDescript 迷你吧商品描述 String articlePrice 迷你吧商品价格 String articleUnit 迷你吧商品单位 String 6.3.4.55设置房态updatekomsSta [功能说明] 设置房态 79
GB/T37976一2019 请求参数] 字段 中文名称 数据类型 数量 说明 hoteGroupCode 酒店集团代码 String 酒店代码 hotelCode String 楼宇 building String 房号 rmno String rrmSta 房态 String [响应数据 数据类型 数量 说明 字段 中文名称 结果代码 resultCode String resultMsg 结果信息 String resultInfo 返回信息 String 0.1 6.3.4.56查询酒店营业日期findBiaDate [[功能说明 查询酒店营业日期 请求参数 字段 中文名称 数据类型 数量 说明 酒店集团代码 hotelGroupCode String hotelcode 酒店代码 String [响应数据 中文名称 数量 说明 字段 数据类型 resultCode 结果代码 String resultMs 结果信息 String E心 返回信息 营业日期 resultlnfo String dPieture 6.3.4.57证件头像上传uploadl [功能说明] 证件头像上传 请求参数] 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String 订单D registerld String pictureData 头像数掘 String 80
GB/37976一2019 [[响应数据] 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String 0;上传成功; -l;图像为空; -2:指定主单不存在; resultlnfo 返回信息 String -3;文件名转换失败 -4:目录创建失败; -5保存数据失败 6.3.4.58住客消费对应发票归类查询getReeipt315 [功能说明] 住客消费对应发票归类查询 [请求参数 字段 中文名称 数据类型 数量 说明 lhotelGroupCode 酒店集团代码 String hotelcCode 酒店代码 String registerlad 订单ID number [[响应数据] 中文名称 字段 数据类型 数量 说明 resultCode 结果代码 String 结果信息 resultMsg String resultlnfo 返回信息 Receipt[Dto[ 0., ReceiptDto 字段 数据类型 数量 说明 中文名称 Code 发票代码 String descript 发票描述 String 费用 Money BigDecimal 6.3.4.59发票记录接口reordReeipt [功能说明] 该接口只能在住客没有有效的发票记录情况才能调用,如果存在有效记录无法另行记录 也就是 说该发票记录接口对同一个pms人住只能记录一次开发票记录 [请求参数] 81
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String 酒店代码 hotelCode String registerld 订单ID number 发票明细 detail 发票明细 String 发票号|项目|消费金额)》 otalMoney 发票总金额 BigDecimmal companyName 开票单位 String 不填,默认住客姓名 0.1 [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resltMsg 结果信息 String 6.3.4.60打印发票记录作废printReceiptCancel [[功能说明 打印发票记录作废 [请求参数 字段 数据类型 数量 说明 中文名称 hotelGroupCode 酒店集团代码 String hoteCode 酒店代码 String registerld 订单ID number 发票号 receiptNo String [响应数据 字段 中文名称 数据类型 数量 说明 result(Code 结果代码 String 结果信息 resultMsg String 6.3.4.61取消排房caneelAssign [功能说明] 取消排房 请求参数 字段 中文名称 数据类型 数量 说明 hotel(GroupCode 酒店集团代码 String 酒店代码 hotel(Code String registerld 订单ID number 82
GB/37976一2019 [[响应数据] 字段 中文名称 数据类型 数量 说明 结果代码 resultCode String 结果信息 resultMsg String 6.3.4.62查看房间特征getRmnoreature [[功能说明] 查看房间特征 [请求参数] 字段 说明 中文名称 数据类型 数量 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String loor 楼层代码 String 0.n rmtype 房型代码 String 0..n 房号 rmno String 0.n [[响应数据] 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String resultlnfo 返回信息 RmnoFeatureDto口 0..n RmnoFeatureDto 中文名称 数据类型 数量 字段 说明 房型代码 String rmtype rmtypeDeserijpt 房型描述 String 房号 String rmno feature 房间特征代码 String 0..n 6.3.4.63查看特征getreature [功能说明] 查看特征 请求参数] 字段 说明 中文名称 数据类型 数量 hotelGroupCode 酒店集团代码 String hotelCode String 酒店代码 [响应数据 83
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String rresulMs 结果信息 sg String resultnfo FeatureDto 返回信息 0..n FeatureDto 字段 中文名称 数据类型 数量 说明 code 特征代码 String 特征描述 descript String 6.3.4.64查询会员电子券信息getCoupon [功能说明] 查询会员电子券信息 [请求参数 字段 中文名称 数据类型 数量 说明 hoteGroupCode 酒店集团代码 String hotelCode 酒店代码 String cardNo 会员卡号 String [响应数据 字段 数据类型 数量 说明 中文名称 resulCode 结果代码 String resultMsg 结果信息 String resultlnfo 返回信息 CouponDto口 0..n CouponDto 字段 中文名称 数据类型 数量 说明 couponCode 券型编码 String couponTypeDescript 券型描述 String deseript 券描述 String 券使用类型 D抵扣券;R;折扣券 useType String 面值/折扣如果是抵扣券 券面他 就是抵扣金额;若是折扣 couponMoney BigDecimal 券就是享受折扣(01之间 适用酒店 suitHotelCode 0 String 适用房型 String 0..！ suitRmtype 使用房价码 suitRatecode String 0.. suitCashierPoint 适用营业点 String RM:客房、会议;FB;餐饮 0.. 84
GB/37976一2019 字段 中文名称 数据类型 数量 说明 ONLINE(线上;网站、微信). suitScope 使用范围 String 0..l FRONT(线下;PMS前台 订单总金额满 suitTotalPriee BigDeeimal 0..l 多少可用; no 券号 String 有效起始日期 validFromDate IDate 0. validToDate 有效结束日期 IDate 0..l 如果是抵扣券就是抵扣 电子券实际 presentValue igDecimal 金额;若是折扣券就是 面值/券折扣 享受折扣(0~1之间 R:发行状态;l:已销售状态 U;已使用状态但可撤销; 券状态 O;已使用不可撒销， sta String X作废状态;C;状态纸质券特有， 表示被领用或待销售状态 6.3.4.65会员卡冻结freezCard [[功能说明] 会员卡冻结 [请求参数] 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String cardNo 会员卡号 String 冻结金额 BigDecimal money bilINo 冻结流水号 String [响应数据 字段 中文名称 数据类型 数量 说明 结果代码 resultCode String resultMsg 结果信息 String resultlnfo 返回信息 冻结记录ID number 6.3.4.66会员卡解除冻结unfreezeCardl [[功能说明] 会员卡解除冻结 [请求参数] 85
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 hotel(GroupCode 酒店集团代码 String hotel(Code 酒店代码 String 会员卡号 cardNo String freezeld 冻结记录D number srcMoney 冻结原始金额 BigDeeimal chargeMoney 消费金额 BigDecimal [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String rresultMsg 结果信息 String 6.3.5会员服务 6.3.5.1获取会员类型getMemberLevels [功能说明] 获取关于会员分类定义的信息 请求参数] 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String 不填时,表示集团卡; hoteCode 酒店代码 String 0.l 填写时表示,仅该酒店 允许使用会员卡 [响应数据 字段 数据类型 数量 说明 中文名称 resulCode 结果代码 String resltMsg 结果信息 String resultlnfo 返回信息 Memberlevellnfo口 0..n MemberlevelInfo 数据类型 数量 字段 中文名称 说明 会员卡类型代码 ardIypCode String 会员卡类型名称 String eardTypeName cardleveCode 会员卡等级代码 String cardlevelName String 会员卡等级名称 rateCode 房价码 String 0."n 由酒店管理系统解析该优惠方案代码 由餐饮系统解析该优惠方案代 posCode 餐饮码 String 0." 86
GB/37976一2019 字段 中文名称 数据类型 数量 说明 T/E isPoint 是否支持积分 String T/F 是否支持储值账务 isAccount String T/F是全集团都可以使用 isGroup 是否集团卡 String 还是仅当前酒店可以使用 [其他说明] 会员类别保留两级代码定义,第一级称为会员卡类型,第二级称为会员卡等级 由实现接口双方约 定其实现与对照 memberleve作为cardType十cardl.eel的统称 关于两级代码与一级代码的适配,对于只有一个级别会员类别的系统,可采用强制ceardllevelCode- ardTypeCode的方法来输出 并用cardTypeCode十cardlevelCode的方式获取输人 car 6.3.5.2获取会员来源getNMemherSoures [功能说明] 获取关于会员发展来源定义的信息 [请求参数] 字段 中文名称 数据类型 数量 说明 hoteG 酒店集团代码 String roupCode 不填时,表示集团定义来源;填写 时表示,仅该酒店定义来源 一般 hotelCode 酒店代码 String 0. 集团与所有酒店应保持一致定义 数据 [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 结果信息 resultMsg String 返回信息 MemberSouree叫口 resultlnfo 0..n MembersSource 字段 中文名称 数据类型 数量 说明 发展来源代码 sourceCode String 发展来源名称 如前台、网站、.app sourceName 等 String [其他说明] 独立于会员分类代码,主要字段会员的发展方式 .3.5.3获取积分兑换物品分类eGidscat tegories [功能说明] 获取关于可使用积分兑换物品的分类 心
GB/37976一2019 Goods 数据类型 字段 中文名称 数量 说明 EdCode 物品代码 String 物品名称 goodsName String categoryCode 物品分类代码 String 可兑换数量 amount number unit 兑换单位 String cashRate 购买需要金额 现金购买 deeimal pointRate 兑换需要积分 number reUrl 物品图片 String 0.,n pieturel [其他说明] 积分可兑换物品代码表,及兑换要求 仅供积分兑换记录映射 6.3.5.5会员注册检查checkRegister [功能说明] 会员注册前检查,防止重复注册 [请求参数] 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String 不填时,表示集团卡 hotelCode 酒店代码 String 0.1 填写时表示,仅该酒店 允许使用会员卡 idCode 证件类型 String 0.1 证件、手机email至少一个必填 idNo 证件号码 String 0.l 手机 mobile 0. String email emai 0..l String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg String 结果信息 C其他说明] 根据实际,检查需要数据唯一的部分 6.3.5.6会员注册memberRegister [[功能说明] 会员信息注册 [请求参数 S
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 酒店集团代码 hotelGiroupCode String hotel(Code 酒店代码 可指定为某一家酒店的数据 0..！ String memberld String 会员编号 仅1人多卡时需要填写 0.. String name 姓名 性别 String seX idCode 证件类型 String 0.1 ido 证件号码 String 0.l 手机 nmobile String 0.l emai email String 0. 0. 生日 birthday String address 地址 String 0.. loginPassword 登录密码 String 0.1 cardType 会员卡类别 String 0.l cardl.evel 会员卡等级 String 0.l ardSre 来源 String 0.l 销售员 cardSales String 0.l nTy8 第三方账号类型 String 0..1 openlad 第三方账号id或tokenm String 0.1 第三方账号识别号 String 0.1 openAccnt [[响应数据 字段 数据类型 数量 中文名称 说明 结果代码 resultCode String resultMsg 结果信息 String resullnfo 注册结果 MemberIndexDo MemberIndexDto 数据类型 字段 中文名称 数量 说明 menmberld 会员编号 String cardld 会员卡编号 String cardNo String 会员卡对客号 [其他说明] 会员信息部分包含人的信息和关于卡的信息,可定义为1人多卡的结构和方式,即能体现一个人拥 有多张会员卡的事实 6.3.5.7重置密码resetlPassword [功能说明] 90
GB/37976一2019 更改会员(卡)的密码 [请求参数] 字段 中文名称 数据类型 数量 说明 酒店集团代码 hotelGroupCode String hotelCode 酒店代码 可指定为某一家酒店的数据 String nmenmberld 会员编号 String cardld 会员卡编号 String 0. newPassword 新密码 String 当需要区分登录密码、消费 swordTye 操作类型 0..l String 峦码等不同种类的密码时使用 [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String C其他说明] 若需要对客使用注意根据业务需要添加一些验证会员身份的参数或前置步骤 如,先通过短信等 方式验证客人的手机是否与会员系统中保存的一致 6.3.5.8通过手机验证重置密码resetPasswordByobile [[功能说明] 用于在客人忘记密码时,换一个新密码 先通过短信等方式验证客人的手机是否正确 [请求参数 中文名称 数据类型 字段 数量 说明 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String 0.l 可指定为某一家酒店的数据 手机号码 mobile String 新密码 newPassword String 当需要区分登录密码、消费 passwordType 操作类型 String 0.1 密码等不同种类的密码时使用 [响应数据 字段 中文名称 数据类型 数量 说明 结果代码 resultCode String esaMss" 结果信息 String [其他说明] 注意处理有重复手机号码的情况,一人多卡时的情况 91
GB/T37976一2019 6.3.5.9修改密码mdifyPau aSSwOrd [功能说明] 仅对客操作时使用,由客人输人新旧密码 请求参数 数据类型 数量 字段 中文名称 说明 酒店集团代码 oC String hotelcode 酒店代码 可指定为某一家酒店的数据 0..1 String mberld 会员编号 String mem cardld 会员卡编号 String 0.1 oldPassowrd 原密码 String newPassword 新密码 String 当需要区分登录密码,消费 passwordType 操作类型 String 0..1 密码等不同种类的密码时使用 [[响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String esultMsg 结果信息 String 6.3.5.10第三方账号绑定bindOpenld [[功能说明] 将会员与第三方应用账号进行绑定,用于免登等业务 请求参数] 字段 中文名称 数据类型 数量 说明 hotel(GroupCode 酒店集团代码 String 酒店代码 可指定为某一家酒店的数据 hotelCode String 0.l 会员编号 memberld String cardld String 会员卡编号 0.. 第三方账号类型 String openldType 如微信,支付宝等 openld 第三方账号id或token String openAcent 第三方账号识别号 String 0.1 [[响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String esultMsg 结果信息 String 92
GB/37976一2019 6.3.5.11第三方账号绑定解除unbindOpenld [功能说明] 解除会员与第三方应用账号的绑定,用于免登等业务 [请求参数] 字段 说明 数据类型 中文名称 数量 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String 0.1 可指定为某一家酒店的数据 memberld 会员编号 String cardld 会员卡编号 String 0. 第三方账号类型 openldType String 第三方账号d或token openld String [[响应数据] 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String 6.3.5.12获取会员详细信息getmemberDetail [功能说明] 用于获取会员详细信息 通常不可对客使用,如需对客应用,请注意验证和安全,防止按编号规则、 手机号码的重试来非法获取会员资料 [请求参数] 字段 中文名称 数据类型 数量 说明 Code 酒店集团代码 hotelGiroup String idCode 证件类型 String 0.. idNo 证件号码 String 0.1 mobile 手机 String email email String 0.l memberld 会员编号 String 0.l 会员卡编号 cardId 0. String cardNo 会员卡对客编号 String 0..l [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String esultMsg 结果信息 String resultlnfo 会员详细信息 MemberCardDto[ 0.n 93
GB/T37976一2019 MemberCardDto 字段 中文名称 数据类型 数量 说明 会员d memberld String name 会员姓名 String sex 会员性别 String 0..1 sexDescript 会员性别描述 String 0.1 birthday 生日 String 0. 证件类型 idType String idTypeDeseript 证件类型描述 String idNo 证件号码 String 手机 mobile String 邮件 email String aaddress 地址 String 0.1 eardlnfos cardnfoDo[ String cardInfoDto 字段 数量 说明 数据类型 中文名称 eardld 会员卡编号 String cardNo 会员卡对客卡号 String sta 卡状态 String staDeseript 卡状态描述 String 会员卡类别 cardType String cardTypeDescript String 会员卡类别描述 卡等级 cardl.evel String 0.l 卡等级描述 String 0..1 cardLevelDeseript pointBalance 卡积分余额 deecimal 卡储值余额 balcance decimal rateCode 房价码 String 0.1 由pms系统解析该优惠方案代码 餐饮码 由餐饮系统解析该优惠方案代码 0..！ posCode String createDate 创建时间 String 包含日期时间 过期时间 仅含日期 expireDate String 6.3.5.13会员凭密码登录memberlogin [[功能说明 用于获取会员详细信息 通常对客使用,由客人输人密码,凭密获取会员信息 [请求参数] 94
GB/37976一2019 字段 中文名称 数据类型 数量 说明 lhotelGroupCode 酒店集团代码 String hotelcCode 酒店代码 可指定为某一家酒店的数据 0..l String dCode 证件类型 String 0.. idNo 证件号码 0..l String mobile 手机 String 0.1 至少一项信息 email emai String 0.1 cardNo 会员卡对客编号 String 0.l 0. password 会员登录密码 String [响应数据 字段 数据类型 数量 说明 中文名称 resultCode 结果代码 String resultMsg 结果信息 String resultlnfo 会员详细信息 MemberCardDto MemberCardDto 字段 中文名称 数据类型 数量 说明 会员id memberld String 会员姓名 String name 会员性别 String 0. sexDeseript 会员性别描述 String 0.1 birthday 生日 String 0.l 证件类型 idType String 证件类型描述 idTypeDesceript String idNo 证件号码 String mobile 手机 String emai 邮件 String aaddress 地址 String 0.. cardlnfos cardllnfoDo[ String l,,n cardlnfoDto 字段 说明 中文名称 数据类型 数量 cardld 会员卡编号 String cardNo 会员卡对客卡号 String 卡状态 String sta staDeseript 卡状态描述 String cardType 会员卡类别 String 95
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 会员卡类别描述 cardTypeDeseript String 卡等级 cardI.evel 0..！ String 卡等级描述 cardl.evelDescript String 0.. pointBalance 卡积分余额 decimal baleance 卡储值余额 deeimal rateCode 房价码 String 0.1 由pms系统解析该优惠方案代码 posCode 餐饮码 String 0.l 由餐饮系统解析该优惠方案代码 创建时间 createDate String 包含日期时间 过期时间 仅含日期 expirelDate String 6.3.5.14会员第三方账号登录 LoginOpen memberl [功能说明] 用于获取会员详细信息 通常对客使用,由客人输人密码,凭密获取会员信息 请求参数] 字段 数据类型 数量 中文名称 说明 酒店集团代码 hotelGroupCode String mi 第三方账号类型 open String openld 第三方账号id或token String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String resultInfo 会员详细信息 MemberCardDto MemberCardDto 字段 说明 中文名称 数据类型 数量 memberld 会员id String 会员姓名 String nanme 会员性别 String 0.1 seX sexDesceript 会员性别描述 String 0.l birthday 生日 String 0.l 证件类型 drype String 4 证件类型描述 String peDescrip idNo 证件号码 String mobile 手机 String 96
GB/37976一2019 字段 中文名称 数据类型 数量 说明 email 邮件 String address 0..l 地址 String cardllnfoDto口 cardlnfos String l.,1 cardlnfoDto 字段 中文名称 数据类型 数量 说明 cardld 会员卡编号 String cardNo 会员卡对客卡号 String 卡状态 String sta staDeserip 卡状态描述 String cardType 会员卡类别 String cardTypeDescript 会员卡类别描述 String 卡等级 0 cardlevel String 卡等级描述 0..l cardlevelDescript String pointBalance 卡积分余额 decimmal balcance 卡储值余额 decimmal rateCode 房价码 String 0. 由pms系统解析该优惠方案代码 pos(Code 餐饮码 String 0.1 由餐饮系统解析该优惠方案代码 createDate 创建时间 String 包含日期时间 过期时间 仅含日期 expireDate String 6.3.5.15会员信息修改updateNMember [[功能说明] 修改会员信息 [请求参数] 数据类型 说明 字段 中文名称 数量 酒店集团代码 hotelGroupCode String memberld 会员编号 String 姓名 name 0..l String 性别 String sex 0.. birthday 0. 生日 String idType 证件类型 String 0. idNo 证件号码 String 0.l 手机号码 mobile String 0.l 邮箱 emai 0. String 地址 address String 97
GB/T37976一2019 [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 结果信息 rresultMsg String C其他说明] 可以通过nul和空的区别来处理全部修改和部分修改 6.3.5.16会员卡挂失lostCardl [[功能说明 用于客人在会员卡卡片丢失时,挂失锁定卡片使用 [请求参数 字段 数据类型 数量 说明 中文名称 heCode 酒店集团代码 String cardld 会员卡编号 String [响应数据 字段 中文名称 数据类型 数量 说明 result(Code 结果代码 String 结果信息 resultMsg String 会员升降级upgradeCard 6.3.5.17 [功能说明 用于客人满足一定条件,将等级提升的操作 [请求参数 字段 数据类型 数量 中文名称 说明 hoteGroupCode 酒店集团代码 String 会员卡编号 cardld String oldCardType 原会员卡类型 String oldCardlevel 原会员卡等级 String newCardType 新会员卡类型 String 新会员卡等级 newCardl.evel String 原因 String reason remark 备注 String [响应数据] 中文名称 数据类型 字段 数量 说明 resultCode 结果代码 String esultMsg 结果信息 String 98
GB/37976一2019 [其他说明] 可结合收费,扣积分等一起操作 6.3.5.18获取积分余额etPointbalance [[功能说明] 用于获取指定会员卡的积分余额 应尽量避免使用,尽量在没有积分变更操作返回结果中的积分 余额来得到积分余额 [请求参数 字段 数据类型 数量 说明 中文名称 hoteGuCcode 酒店集团代码 String cardldl 会员卡编号 String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 结果信息 resultMsg String 详细结果 resultlnfo cardPointDto cardPointDto 中文名称 数据类型 数量 字段 说明 pointBalance deeimmal 积分余额=积分获取一积分消费 积分余额 pointFreeze 冻结积分 deeimal pointBalaneeUseable 可用积分 decimal 可用积分=积分余额一冻结积分 系统内部交易编号 与本方法无关.仅保持结构 billNo String 6.3.5.19获取积分明细getPointDetail [功能说明] 用于获取指定会员卡的积分获取和消费的明细信息 [请求参数] 字段 中文名称 数据类型 数量 说明 lhotelGroupCode 酒店集团代码 String 会员卡编号 cardld String 开始日期 beginDate String endDate 截止日期 String currentPage 开始页码 number pageSize 每页数据量 number [响应数据 S
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 结果信息 resultMsg String resultInfo 详细结果 ardPointDetailDto 记录总行数 totalRows number cardPointDetailDto 字段 中文名称 数据类型 数量 说明 cardNo 会员卡对客卡号 String pointPay 产生积分 decimal pointCharge 消费积分 decimal pointGenDate 产生日期 仅含日期 String 失效日期 仅含日期 invalidDate String 积分来源 String source 6.3.5.20积分新增cardPointPay [功能说明] 用于增加会员卡积分的操作,如签到等业务 不得用于积分商城等积分扣减行为 请求参数 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String hotelcode 酒店代码 String 0..1 eardld 会员卡编号 String 积分数 point String invalidDate 失效日期 String 0.1 不指定失效日期时,由系统自行指定 新增积分活动标然 promotionTag String 交易编号 由接口调用方生成交易凭证 bilINo String 备注 remark String [[响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String resultlnfo 详细结果 cardPointDto ardPointDto 100
GB/37976一2019 字段 中文名称 数据类型 数量 说明 pointBalanee 积分余额 decimal 积分余额=积分获取一积分消费 冻结积分 pointFreeze decimal pointBalanceUseable 可用积分 可用积分一积分余额-冻结积分 decimmal bilINo 系统内部交易编号 String 0..l 6.3.5.21 积分消费eardPointCharge [[功能说明] 用于积分商城等积分扣诚行为 [请求参数 说明 字段 中文名称 数据类型 数量 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String 0..l cardld 会员卡编号 String point 积分数 String 消费积分活动标签 promotionTag String billNo 交易编号 String 由接口调用方生成交易凭证 备注 remarlk String [响应数据 字段 数据类型 数量 中文名称 说明 resultCode 结果代码 String resultMsg 结果信息 String 正常时返回变化后的积分余额 A resultlnfo 详细结果 cardPointDto cardPointDto 字段 中文名称 数据类型 数量 说明 积分余额 积分余额=积分获取一积分消费 pointBalance decinmall pointFreeze 冻结积分 decimmal pointBalanceUseable 可用积分 deeimal 可用积分=积分余额一冻结积分 bilINo 系统内部交易编号 String 6.3.5.22积分兑换cardPointExchange [[功能说明] 兑换有会员系统指定的兑换物品时,扣减对应积分 01
GB/T37976一2019 请求参数] 字段 中文名称 数据类型 数量 说明 酒店集团代码 hotelGroupCode String hotelCode 酒店代码 0 String cardld 会员卡编号 String goodsCode 物品编号 String 兑换数量 String amount address 客人收货地址 String 客人到指定的酒店 addressHotel String 0..！ 收取兑换物品 交易编号 billo String 由接口调用方生成交易凭证 remark 备注 String [响应数据 字段 中文名称 数据类型 数量 说明 result(Code 结果代码 String resultMsg 结果信息 String 详细结果 cardPointDto resultlnfo eardPointDto 字段 中文名称 数据类型 数量 说明 pointBalance 积分余额 deecimal 积分余额=积分获取一积分消费 冻结积分 pointFreeze deeimal U9 可用积分 可用积分=积分余额一冻结积分 pointBalanceUseable decimal iNo 系统内部交易编号 0..1 String 6.3.5.23积分冻结cardPointFreeze [功能说明] 冻结会员积分,使得不能被使用,但这部分积分仍然是客人拥有的 请求参数] 数量 说明 字段 中文名称 数据类型 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 0 String cardld 会员卡编号 String 积分数 String point expiryDate 冻结有效日期 String ilINo 交易编号 String 由接口调用方生成交易凭证 remark 备注 String 102
GB/37976一2019 [响应数据 字段 中文名称 数据类型 数量 说明 结果代码 resultCode String 结果信息 resultMsg String cardPointDto resultlnfo 详细结果 cardPointDto 字段 中文名称 数据类型 数量 说明 积分余额=积分获取一积分消费 pointBalanee 积分余额 decimal 冻结积分 pointFreeze decimal 可用积分 decimal 可用积分=积分余额一冻结积分 pointBalanceUseable bilINo 系统内部交易编号 String 0..l 6.3.5.24积分冻结取消cardPointUnfreeze [功能说明] 取消由bilNo指定冻结会员积分业务 [请求参数] 字段 中文名称 数据类型 数量 说明 lhotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String 0.l cardld 会员卡编号 String 积分数 point String oldBlINo 原冻结操作交易编号 String bilINo 交易编号 String 由接口调用方生成交易凭证 remark 备注 String [[响应数据] 字段 说明 中文名称 数据类型 数量 resulCode 结果代码 String resultMsg 结果信息 String resultlnfo 详细结果 cardPointDto cardPointDto 字段 说明 中文名称 数据类型 数量 pointBalance 积分余额 积分余额一=积分获取一积分消费 decimmal pointFreeze 冻结积分 deeimmal pointBalaneeUseable 可用积分 deeimal 可用积分=积分余额一冻结积分 bilINo 系统内部交易编号 String 03
GB/T37976一2019 6.3.5.25获取储值余额getAecountBalanee [功能说明] 获取会员卡储值账户余额 [请求参数] 字段 数据类型 数量 说明 中文名称 hotelGroupCode 酒店集团代码 String cardld 会员卡编号 String [响应数据 字段 中文名称 数据类型 数量 说明 结果代吗 resultCode String 正常时返回变化后的 resultMsg 结果信息 String 积分冻结合计 resultIno 详细结果 CardAccountDto CardAccountDto 字段 数据类型 数量 说明 中文名称 accountBalance 储值账户余额 deecimal 余额=储值一消费 储值账户冻结金额 accountFreeze decimal accountBalanceUseable储值账户可用余额 deeimal 可用余额=余额一冻结金额 illNo 系统内部交易编号 String 与本方法无关,仅保持结构 6.3.5.26获取储值明细getAeeountDetai [功能说明] 获取会员卡储值账户充值和消费的具体明细 [请求参数 说明 字段 中文名称 数据类型 数量 hoteGroupCode 酒店集团代码 String 会员卡编号 cardld String beginDate 开始日期 String endDate 截止日期 String eurrentPage 开始页码 number 每页数据量 number pageSiz [响应数据 中文名称 数据类型 数量 字段 说明 resultCode 结果代码 String esultMsg 结果信息 String 正常时返回变化后的积分冻结合计 104
GB/37976一2019 字段 中文名称 数据类型 数量 说明 详细结果 resultnfo cardAecountDetailDto口 记录总行数 totalRows nummber ardAecounDetaiDn 数据类型 数量 字段 中文名称 说明 eardNo 会员卡对客卡号 String accountPay 产生积分 decimal accountCharge 消费积分 decinmall accountGenDate 产生日期 仅含日期 String 积分来源 String source 6.3.5.27 储值卡充值cardAecountPay [[功能说明] 用于会员卡储值,在线支付等功能使用 C请求参数] 数据类型 数量 字段 说明 中文名称 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String 0.1 cardld 会员卡编号 String 支付方式 payCode String 0.l 不指定则由系统自行生成 decimal amount 金额 iINo 交易编号 由接口调用方生成交易凭证 String transNo 第三方交易记录编号 String 0..l 备注 remark String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String resultlnfo 详细结果 CardAceountDto CardAccountDto 字段 说明 中文名称 数据类型 数量 accountBalance 储值账户余额 余额=储值一消费 decimmal accountFreeze 储值账户冻结金额 decimmal accountBalanceUseable储值账户可用余额 deeimal 可用余额=余额一冻结金额 bilINo 系统内部交易编号 String 05
GB/T37976一2019 cardAccount 6.3.5.28储值卡消费 mtchurse [功能说明] 储值卡扣款行为 请求参数 数据类型 数量 字段 中文名称 说明 酒店集团代码 oC String hotelcode 酒店代码 0..1 String cardld 会员卡编号 String txnCode 付款代码 carchar(20 不指定则由系统自行生成 password 储值卡消费密码 String 0.1 amount 金额 String 由接口调用方生成交易凭证 iNo 交易编号 String 备注 remark String [响应数据 字段 中文名称 数据类型 数量 说明 结果代码 resultCode String 结果信息 resultMsg String resultnfo 详细结果 CardAccountDto CardAccountDto 数据类型 数量 字段 中文名称 说明 accountBalance 储值账户余额 decimal 余额=储值一消费 储值账户冻结金额 accountFreeze decimal accountBalanceUseable储值账户可用余额 可用余额=余额一冻结金额 decimal 系统内部交易编号 billNo String 0. 6.3.5.29储值卡消费撤销cardAccountstrike [[功能说明 撤销由billNo指定的消费行为 [请求参数 中文名称 字段 数据类型 数量 说明 hoteGroupCode 酒店集团代码 String hotelCode 酒店代码 String 0.1 cardld 会员卡编号 String 不指定则由系统自行生成 txnCode carehar(20) 付款代码 或使用原消费对应代码 106
GB/37976一2019 字段 中文名称 数据类型 数量 说明 amount 金额 String 应与原消费金额一致 oladBilNo 原冻结操作交易编号 String bilINo 交易编号 由接口调用方生成交易凭证 String 备注 remark String [响应数据 字段 说明 中文名称 数据类型 数量 resultCode 结果代码 String esultMsg 结果信息 String resulnfo 详细结果 CardAceountDto CardAccountDto 字段 数据类型 数量 说明 中文名称 accountBalance 储值账户余额 余额=储值一消费 decimmal accountFreeze 储值账户冻结金额 decimal accountBalanceUseable储值账户可用余额 decimal 可用余额=余额一冻结金额 系统内部交易编号 billNo String 0. 6.3.5.30储值卡冻结eardrPointFreee [功能说明] 冻结储值卡上的金额使其不会被使用,但其金额仍然属客人所有 [请求参数] 中文名称 数据类型 数量 字段 说明 hotelGroupCode 酒店集团代码 String 酒店代码 hotelCode String 0.l cardld 会员卡编号 String 冻结金额 amount String expiryDate 冻结有效日期 String bilINo 交易编号 String 由接口调用方生成交易凭证 remark 备注 String [[响应数据] 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String esultMsg 结果信息 String 详细结果 resultlnfo CardAccountDto 07
GB/T37976一2019 CardAccountDto 字段 中文名称 数据类型 数量 说明 储值账户余额 余额=储值一消费 aecountBaance deeimal accouuntFreeze 储值账户冻结金额 decimal aecoumlBalaneUseable储值账户可用余额 decimal 可用余额=余额一冻结金额 bilINo 系统内部交易编号 String 0.1 6.3.5.31储值冻结取消cardAccountUnfreeze [功能说明 取消由b;ilINo指定的冻结业务,返回金额 [请求参数 字段 数量 说明 中文名称 数据类型 酒店集团代码 hotelGroupCode String hoteCode 酒店代码 String 0. 会员卡编号 cardld String 取消冻结金额 amount decimmal oldBilINo 原冻结操作交易编号 String 交易编号 bilINo 由接口调用方生成交易凭证 String remark 备注 String [响应数据 说明 字段 中文名称 数据类型 数量 resultCode 结果代码 String resltMsg 结果信息 String resultInfo 详细结果 CardAccountDto CardAccountDto 字段 数据类型 数量 说明 中文名称 accountBalance 储值账户余额 余额=储值一消费 decimal aecountFreea 储值账户冻结金额 decImmal accountBalanceUseable储值账户可用余额 deecimal 可用余额=余额一冻结金额 iNo 系统内部交易编号 String 0.l 6.3.5.32会员入住记录查询总计memberPrdwetonm [功能说明] 会员人住情况统计 108
GB/37976一2019 [请求参数 字段 中文名称 数据类型 数量 说明 酒店集团代码 hotelGroupCode String hotelCode 酒店代码 0. String memberld 会员编号 String cardld 会员卡编号 String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String esultMsg 结果信息 String resultlnfo 详细结果 MemberProductionDto MemberProductionDto 字段 中文名称 数据类型 数量 说明 hoteGroupCode 酒店集团代码 String hotel(Code 酒店代码 String lastVisitDate 最后访问日期 String lastVisitlotel 最后访问酒店 String lastVisitRoom 最后人住房间 String 人住天数 daysln 总 number imesln 总人住次数 number 取消次数 timescx number times_noshow 应到未到次数 number productionRm 房费合计 decimmal productionFb 餐费合计 decimal 其他费用合计 productionOt decimmal productionTl 总费用合计 deeimal 6.3.5.33会员入住记录查询明细 memberPr0ductionDetail [功能说明] 会员人住情况统计 [请求参数 数据类型 字段 中文名称 数量 说明 GCwde 酒店集团代码 hotelGre String hotelCode 酒店代码 String 0.. memberld 会员编号 String cardd 会员卡编号 String 09
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 beginDate 开始日期 String 截止日期 endDate String 开始页码 currentPage number 每页数据量 number pageSize [响应数据 字段 中文名称 数据类型 数量 说明 resulCode 结果代码 String resultMsg 结果信息 String resulnfo 详细结果 MemberProduetionDetailDo MemberProductionDto 字段 数据类型 数量 说明 中文名称 hotel(GroupCode 酒店集团代码 String hoteCode 酒店代码 String 人住人姓名 String name arrDate 抵达日期 String 离开日 期 depDate String cardNo 对客卡号 String 房号 roomno String 房间单价 房价 rate decimmal produetionRmm 房费合计 decimal productionFD 餐费合计 deeimal productionOt 其他费用合计 deecimal 总费用合计 produetionTtl deeimal 6.4酒店其他管理系统接口 6.4.1门锁服务 6.4.1.1发卡CR [功能说明] 发卡操作(基于本地门锁系统应用环境). 请求参数] 数据类型 字段 中文名称 数量 说明 指令发送日期 SD String 0.l 格式:yyyyMMdd sT 指令发送时间 格式;HHmmss 0..1 String 110
GB/37976一2019 字段 中文名称 数据类型 数量 说明 CI 客户端字段 String 长度18 CN 制卡数 number 0. CT 制卡类型 Char N;新卡;D;复制卡 RN 房间号 长度1- -8 String GN 客人姓名 String 0. 长度140 GI 客人序号 number 0.l BD 人住日期 String yMMdd 0.. 格式7 人住时间 BT String 0.l 格式:HHHmmss ED 离店日期 格式:yyyMMdd 0..l String ET 离店时间 String 0.l 格式:HHmmss Vo 附加参数！ 长度1 0..l -20 String V1 附加参数2 String 0.1 长度1~20 V2 附加参数3 长度1 0..l -20 String V3 附加参数4 String 长度120 0. V4 附加参数5 长度1 0. 20 String V5 附加参数6 String 长度120 0..l [响应数据 说明 字段 中文名称 数据类型 数量 CI 客户端字段 长度1一8 String 长度2 BY;发卡器忙 DE;卡已被注销 响应结果 oK;操作成功 AS String NC;无卡 UR;未处理的请求 或请求未加载,不重试 [请求示例] CRICI002lcTNICN1lRN502lBD160415BT12300olED160416IET123000lGNZhangsan [返回示例] CAICI002|ASOK CAICo02lASBY 6.4.1.2销卡CD [功能说明] 销卡操作(基于本地门锁系统应用环境). 111
GB/T37976一2019 请求参数 字段 中文名称 数据类型 数量 说明 指令发送日期 SD String 0.l 格式;yyyyMMdd 指令发送时间 sT 0 格式.HHn Immss String C 长度1" 客户端字段 String RN 房间号 String 长度18 V0 附加参数1 String 0.1 长度120 长度120 V 附加参数2 String 0.l V2 附加参数3 String 0.l 长度120 [响应数据] 字段 中文名称 数据类型 数量 说明 CT 客户端字段 String 长度18 长度2; BY;发卡器忙 DE:卡已被注销 As 响应结果 String OK;操作成功 Nc;无卡 UR;未处理的请求,或请求未加载,不重试 [请求示例] CDCI002RN502 [返回示例门 CACI002lASOK CAlCI002|ASBY 6.4.13查卡CC [功能说明 通过其他系统进行查卡操作(基于本地门锁系统应用环境). C请求参数] 字段 中文名称 数据类型 数量 说明 SD 指令发送日期 格式;:yyMMddl 0..1 String 指令发送时间 ST String 0.1 格式:HHmmss C 客户端字段 长度1一8 String V0 附加参数1 String 0.1 长度120 V1 附加参数2 长度1 -20 String 0.l 0. 长度120 V2 附加参数3 String 112
GB/37976一2019 [响应数据 字段 中文名称 数据类型 数量 说明 客户端字段 长度1~8 CI String As 响应结果 长度2 String 长度1一8,查卡成功时必填 RN 房间号 String 0.1 查卡失败时不填 BD 人住日期 String 0..l 格式yyyMMdd BT 人住时间 String 格式;HHmmss 0.. ED 离店日期 String 0.1 格式;yyyyMMdd 离店时间 ET String 格式:HHmmss 0.. [请求示例] CDlCI002RN502 [返回示例 CACI002ASOKRN502|BD160415BT123000|ED160416ET123000 CACI002ASBY 6.4.1.4发行卡isseCard [[功能说明] 发卡操作(基于本地门锁系统应用环境) C请求参数] 说明 字段 中文名称 数据类型 数量 hotelCode 酒店代码 String 0. 操作所应用的酒店代号 roomNo 房号 操作所应用的具体房间 String issueType 发行方式 1;新制卡;2;增制卡 number 发卡类型 1;客 卡 number cardType 人 guestName 客人姓名 String 0.1 长度150 T 人住时间 格式;yyy-\MMddHH;mm startTime String endTime 离店时间 String 格式:yyyy-MM-ddHH:mm [[响应数据] 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String 明细数据 resultnfo String resultlnfo信息 中文名称 数据类型 字段 数量 说明 cardld 物理卡号 String cardNo 逻辑卡号 String 113
GB/T37976一2019 请求示例] cardType "issueType' "roomNo "201" startTime "2018-03-2312:00" "endTime" "2018-03-2512;00" [返回示例] resultCode":0. resultMsg""ok" resultlnfo" "cardNo""575218151" "cardId""385670080" 6.4.1.5注销卡eaneeCard [[功能说明 注销卡操作(基于本地门锁系统应用环境) [请求参数 字段 中文名称 数据类型 数量 说明 hoteCode 酒店代码 String 0.l 操作所应用的酒店代号 [[响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String esultMsg 结果信息 String resullnfo 明细数据 String resultlnfo信息 字段 中文名称 数据类型 数量 说明 cardld 物理卡号 String 逻辑卡号 cardNo String 0.l 请求示例] [[返回示例 114
GB/37976一2019 "esulCode",0. "esulMsg""ok" "resultlnfo" "cardId""385670080" 6.4.1.6读取卡eheekCard 功能说明] 通过其他系统进行查卡操作(基于本地门锁系统应用环境. 请求参数] 字段 数据类型 数量 说明 中文名称 酒店代码 hotelCode String 0.1 操作所应用的酒店代号 [响应数据 字段 数量 说明 中文名称 数据类型 resultCode 结果代码 String resultMsg 结果信息 String resultlnfo 明细数据 String resultlnfo信息 字段 中文名称 数据类型 数量 说明 cardld 物理卡号 String cardNo 逻辑卡号 String 0.l 房号 操作所应用的具体房间 roomNo String 发行方式 1;新制卡;2;增制卡 number 0..l issueType 1;客人卡 发卡类型 number cardType guestName 客人姓名 长度1一50 String 0..l startTimme 人住时间 String 格式;yyyy-MM-ddHH;mm endTime 离店时间 String 格式:yyyy-MMddHH;mm disabled 是否注销 bool 0.l [请求示例] [返回示例] "resulCode";0. "esultMsg""ok" "resultlnfo" 115
GB/T37976一2019 "cardld""385670080”" "cardType":1. "ssueType" "roomNo""201" startTime "2018-03-2312:00" endTime" "2018-03-2512:00" 6.4.1.7门锁远程开锁接口remoteOpenLock [功能说明] 远程打开门锁的操作(基于在线门锁系统应用环境 [请求参数] 字段 数量 中文名称 数据类型 说明 hoteCode 酒店代码 操作所应用的智慧酒店 String roomNo 房号 String 操作所应用的具体房间 aetion 操作类型 String 操作门锁动作,如开锁open) custlnfo 客户信息 String 开门凭证,用于表明操作者身份信息 [[响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String [请求示例] "hotelCode";"HTIG" "roomNo";"8101" "action";"open" "eustlnfo""13212341234" [返回示例] llCode";0, resul "esultMsg";"成功" remoteControCard 6.4.1.8门锁远程授权/取消授权卡接口 [功能说明] 远程授权/取消授权门卡的操作(基于在线门锁系统应用环境) 116
GB/37976一2019 [请求参数 字段 中文名称 数据类型 数量 说明 酒店代码 hotelCode String 操作所应用的智慧酒店 房号 操作所应用的具体房间 roomNo String 操作门锁动作,如新增卡 操作类型 action String ,删除卡( set delete 用于识别卡的类型 cardType 门卡类型 String 0.l ownerld 权限标识 String 可根据权限标识进行顶替 用于识别门卡的标识 cardNo 门卡标识 String 如卡片序列号 授权开始时间 String 格式;yyyy-MM-ddHH;mm:ss startime 0. endtime 授权结束时间 0 String 格式:yyyyMM-ddHH:mm;ss [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 结果信息 resultMsg String [请求示例 "hotelCode";"HTI.G" "roomNo":"8101" "action":"set" "ownerld";"123456" cardNo":"123456" startime";"2016-10-1012:30" "endtime":"2016-10-1212:30" 返回示例1 resultCode":0. resultMsg";"成功" remoteSetPassword 6.4.1.9远程授权开锁密码接口 [功能说明] 远程授权开锁密码的操作(基于在线门锁系统应用环境 [请求参数] 中文名称 数据类型 字段 数量 说明 hotelCode 酒店代码 String 操作所应用的智慧酒店 roomNo 房号 String 操作所应用的具体房间 117
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 用户密码 password String 用户可以用来打开智能门锁的密码 密码类型 用于标记密码类型 0..！ type String ownerld 权限标识 可根据权限标识进行顶替 String 授权开始时间 0..1 格式:yy-MMddHHmm;ss startime String endtime 授权结束时间 String 0. 格式:yyyy-MMddHH;mm;ss [响应数据 字段 说明 中文名称 数据类型 数量 resultCode 结果代码 String rresultMsg 结果信息 String [请求示例咖 "hotelCode":"HTLG" '" "roomNo":"8101 "password";"123456" "ownerld":"12" startimme";"2016-10-101230" endtime";"2016-10-1212:30" [返回示例] "resultCode":0. "resultMsg";"成功" 6.4.1.10远程取消授权开锁密码接口remoteDeletePassword [功能说明] 远程取消授权开锁密码的操作(基于在线门锁系统应用环境) [请求参数 中文名称 数量 字段 数据类型 说明 hoteCode 酒店代码 String 0. 操作所应用的智慧酒店 操作所应用的具体房间 roommNo 房号 String 权限标识 ownerld String [响应数据 字段 中文名称 数据类型 数量 说明 结果代码 result(Code String resultMsg 结果信息 String 118
GB/37976一2019 [请求示例] "hotelCode";"HTG"， "roomNo";"8101" "ownerld";"12" [返回示例] resultCode":0 sultMsg";"成功" reSL 6.4.1.11远程锁定/解锁开锁密码接口remoteSetL.ekPasswordl [功能说明门 远醒密码锁定与解除锁定功能操作(基于在线门锁系统应用环境》 请求参数 字段 说明 中文名称 数据类型 数量 hotelCode 酒店代码 操作所应用的智慧酒店 String roomNo 房号 String 操作所应用的具体房间 操作门锁动作,如锁定密码 操作类型 action String ock),解除锁定(unlock) ownerld 权限标识 String [[响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String [请求示例] "hotelCode""HTLG" "roomNo";"8101" "action""ock" "ownerld""12" [返回示例] "resulCode";0, "esulMsg""成功" 119
GB/T37976一2019 6.4.1.12门锁状态查询接口getL.0ekStatus [功能说明] 远程查看门锁状态功能操作,该操作不包含特定的传人参数(基于在线门锁系统应用环境 C请求参数] 字段 中文名称 数据类型 数量 说明 hotelCode 酒店代码 操作所应用的智慧酒店 String 0..1 roomNo 房号 String 操作所应用的具体房间 [[返回信息 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String esultMsg 结果信息 String 返回信息 resultlnfo String 0. resultlnfo 字段 中文名称 数据类型 数量 说明 用于标示当前门锁电量， number battery 门锁电量百分比 范围0 l00 用于标示当前门锁信号强度 signan 门锁信号百分比 number 范围0~ 100 lockstatus 锁状态 String 0..！ 标记锁的开/关状态 门状态 标记门的开/关状态 doorstatus String 0.. 请求示例] "hotelCode""HTLG" "roomNo";"8101" [返回示例门 "resultCode";0 esultMsg""成功" resultlnfo";[ N battery":80, "sgnal".100. "lockstatus":opened" "doorstatus":opened" 120
GB/37976一2019 R 6.4.1.13获取开门记录接口getOpenm RecOrds 功能说明] 获取开门记录的操作 [请求参数] 字段 中文名称 数据类型 数量 说明 hotelCode 酒店代码 String 操作所应用的智慧酒店 roomNo 房号 String 操作所应用的具体房间 操作类型 查询条件 0. conditions Conditions Conditions 字段 数据类型 数量 说明 中文名称 页码 number 从0开始,默认0 page pageSize 每页的数量 number 默认50,最大200 openType 开门方式 String 0.l 开始时间 格式yNMdHH,mms" startTime String 0.l endTimme 结束时间 0 格式yyy-\MMdHH;mm;s String [响应数据 字段 中文名称 数据类型 数量 说明 result(Code 结果代码 String resultMsg 结果信息 String openRecords 开门记录结果 openRecords[口 0. 页码 page number pageSize 每页的数量 number 总开门记录数 total number totalPage 总页数 number openRecords 字段 中文名称 数据类型 数量 说明 C;智能卡; KEY;机械钥匙; 开门类型 openType String PwD.开锁密码; NET:网络开锁 开门卡、开门密码对应ownerld字段 ownerld 开门ID String 网络开门对应 字段 custInfo cardld 物理卡号 String 开门卡对应卡的物理ID 0..l cardNo 逻辑卡号 String 0. canOpen 开门是否成功 Booleanm openTime 操作时间 String 格式yyyy-MM-ddHH:mm;ss 121
GB/T37976一2019 请求示例] "hotelCode""HTLG" roomNo";"8101" conditions page pageSize":50, startTime";"2016-11-0112.00:00" "endTime";"2016-1l-3012:00:00" [返回示例] "resultCode":0 resultMsg";"成功" page":1 pageSize":50. total":480, totalPage";10 openRecords": "openType";"Ic"， ownerld";"134257635" ardld";"134257635" canOpen":true, openTime";"2016-11-3008;00;00" "openType";"pwD" "ownerld";"1234567" "canOpen":true "openTime";"2016-11-3012:00:00" 6.4.1.14获取门锁报警记录接口getAarmReeords [功能说明] 获取报警记录的操作 请求参数] 122
GB/37976一2019 字段 中文名称 数据类型 数量 说明 操作所应用的智慧酒店 hotelCode 酒店代码 String 房号 操作所应用的具体房间 roomNo String Conditions 操作类型 查询条件 conditions 0.. C `onditions 字段 中文名称 数据类型 数量 说明 页码 number 从0开始,默认0 page pageSize 每页的数量 number 默认50,最大200 startTime 开始时间 String 0.l 格式yyyy-MM-ddHH:mm;ss 结束时间 endTime 0. 格式MN.mm; String [[响应数据] 说明 字段 中文名称 数据类型 数量 resulCode 结果代码 String resultMsg 结果信息 String alarmRecords 开门记录结果 aarmRecords口 页码 number page 每页的数量 pageSize number total number 总开门记录数 totalPage 总页数 number alarmRecords 字段 中文名称 数据类型 数量 说明 门锁上线online),门锁离线 开门类型 alarmType String offine),电量欠压(lowlBkattery alarmTime 操作时间 String 格式yyyy-MM-ddHH:;mm;ss [请求示例] "hoteCode";"HTLG" roomNo""8101" 'conditions "page":l "pageSize":50. "canOpen";"2016-11-0112:00:00" "endTime";"2016-1l-3012:00:00" 123
GB/T37976一2019 [[返回示例 "resultCode":0， resultMsg";"成功" page":l 50 pmgesSsiu" otal"480 "otalPage":10. "alarmRecord"[ "alarmType""offline" "alarmTime";"2016-11-3008:00;00" "alarmType":"online" "alarmTime";"2016-11-3012;00;00" 6.4.1.15远程控制取电开关接口remoteControlSwiteh [[功能说明] 远程控制取电开关的操作 [请求参数 字段 数据类型 数量 说明 中文名称 hoteCode 酒店代码 String 操作所应用的智慧酒店 roomNo 房号 String 操作所应用的具体房间 操作取电开关动作,如取电 action 操作类型 String poweron),断电(poweroff 开门凭证,用于表明操 custlnfo 客户信息 String 0 作者身份信息 [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String 请求示例们 "hotelCode";"HTIG" "roomNo";"8101" "aeion";"poweron" 124
GB/37976一2019 "custlnfo""13212341234" [返回示例] "resultCode":0， sultMsg";"成功" reSu 6.4.1.16取电开关状态查询接口tPowerswithnsstatws [功能说明] 进行远程查看取电开关状态功能操作 [请求参数 字段 说明 中文名称 数据类型 数量 hotelCode 酒店代码 String 操作所应用的智慧酒店 roomNo 房号 String 操作所应用的具体房间 [返回信息 字段 数据类型 说明 中文名称 数量 resultCode 结果代码 String resultMsg 结果信息 String resultlnfo 返回信息 String 0. resultlnfo 字段 中文名称 数据类型 数量 说明 signal 取电开关信号 整型 用于标示当前取电开关信号强度 标示取电开关其他状态信息 取电开关状态 字符串 state 0..l 如取电开关是否关闭等 [请求示例] "roomNo";"8101" [[返回示例] "resultCode":0. "resultMsg";"成功" "resultlnfo":[ "b8 ":80. battery "state" "on" 125
GB/T37976一2019 6.4.1.17开门记录推送openkeordCalbaek [功能说明] 推送开门记录信息 请求参数 数据类型 数量 字段 中文名称 说明 hotelcode 酒店代码 操作所应用的智慧酒店 String 房号 操作所应用的具体房间 roomNo String IC;智能卡; KEY;机械钥匙 openType 开门类型 String PwD:开锁密码; NET;网络开锁 开门卡、开门密码对应ownerld字段 ownerld 开门ID String 网络开门对应custlnfo字段 物理卡号 0 开门卡对应卡的物理D cardId String cardNo 逻辑卡号 0..！ String 开门是否成功 Boolean can(Open openTime 操作时间 String 格式yyyy-MM-ddHH;mm;ss 附加数据 备注信息 String 0.l remark [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String resultMsg 结果信息 String C请求示例] "hotelCode";"HTLG" "roomNo";"8101" "openType";"IC" "ownerld";"1" "eardId""12345678" "canOpen'":true "openTime""2016-11-3008:00:00" [返回示例] "esulcode";0. "resultMsg";"成功" 126
GB/37976一2019 alarmRecordCalback 6.4.1.18门锁报警记录推送; [功能说明] 推送门锁报警记录信息 [请求参数] 字段 数量 说明 中文名称 数据类型 hotelCode 酒店代码 String 操作所应用的智慧酒店 roomNo 房号 String 操作所应用的具体房间 电量欠压lowBattery),非法报警(il legalb)防撬报警(amper).斜舌报警 alarmType 报警类型 String oblique)、锁死报警(deadlock)、挟持 报警(hold),高温报警(ten temperature alarnmTime 报警时间 格式yyyMMddHH;mm;ss String 备注信息 String 附加数据 remark 0. [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 结果信息 resultMsg String 请求示例] "hotelCode":"HTLG" "roomNo":"8101" "alarmType""lowBatte 'ery" "alarmTime";"2016-12-3008:00:00" [返回示例] "resultCode":0. "resultMsg";"成功" 6.4.1.19取/断电记录推送switchRecordCallback [功能说明] 推送取电开关取/断电记录信息 [请求参数] 中文名称 数据类型 字段 数量 说明 hotelCode 酒店代码 String 操作所应用的智慧酒店 roomNo 房号 String 操作所应用的具体房间 127
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 c;智能卡; operateType 取/断电类型 String NET;网取电 开门卡对应ownerd字段 ownerld 取断电ID String 0.1 网络取电对应custlnfo字段 cardld 物理卡号 String 0 开门卡对应卡的物理D cardNo 逻辑卡号 String 0.1 取电开关状态 on;取电;of断电 switchStatus String operateTime 操作时间 String 格式yyyyMMddHH:mm;ss 备注信息 附加数据 remark String 0..1 [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 结果信息 rresultMsg String 请求示例] "hotelCode";"HTLG" "roomNo";"8101" "operateType";"NET" "ownerld";"1234" switchStatus";"on "alarmTime";"2016-12-3008;00:00" [返回示例] "resultCode":0. re esultMsg""成功", 6.4.1.20取电开关状态推送switchStatusCalbhack [功能说明] 推送取电开关状态信息 [请求参数 字段 数据类型 数量 说明 中文名称 hoteCode 酒店代码 操作所应用的智慧酒店 String roomNo 房号 String 操作所应用的具体房间 switchStatus 取电开关状态 on;取电;off;断电 String datetime 设备时间 String 格式yyyyMM-ddHH;mm;ss remark 备注信息 String 0.l 附加数据 128
GB/37976一2019 [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 结果信息 resultMsg String [请求示例] "hotelCode";"HTLG" "roomNo";"8101" "switchStatus";"on" "datetime""2016-12-3008:00;00" [返回示例] "resultCode":0. "resultMsg";"成功" 6.4.1.21订阅请求SubscribeReguest [[功能说明] 发出开门记录的订阅请求 [请求参数] 字段 中文名称 数据类型 数量 说明 操作所应用的智慧酒店 hotelCode 酒店代码 String 开始时间 格式yy-MMHH;mm;s beginTime String endTime 结束时间 String 格式yyy-MMldHHmm;ss 开门记录open) msgType 订阅的消息类型 String 报警记录(alarm) callbackurl 回调地址 回调的Url String [响应数据 字段 中文名称 数据类型 数量 说明 result(Code 结果代码 String 结果信息 resultMsg String [请求示例] "hotelCode";"HTIG"， BegTime";"2016-11-3008:00:00" EndTime""2016-12-3008:00:00" callbackurl";"XXXXXXXXXX" 129
GB/T37976一2019 [返回示例] resultCode":0， "esulMsg";"成功" 6.4.1.22推送请求回调)semdSuhserihelnfo [功能说明] 向订阅方发送开门记录 说明;发起方;信息提供方 请求地址:在订阅请求中提供(即calbackurl [请求参数 字段 中文名称 数据类型 数量 说明 开门记录(open). msgType 订阅的消息类型 String 报警记录(alarm) hotelCode 酒店代码 操作所应用的智慧酒店 String OpenReeord 开门记录/报警记录数据 data 推送消息数据内容 AlarmRecord OpenRecord信息 字段 数据类型 数量 说明 中文名称 房号 roomNo String 操作所应用的具体房间 IC:智能卡; KEY;机械钥匙; openType 开门类型 String PwD;开锁密码; NET;网络开锁 开门卡、开门密码对应ownerld字段 ownerld 开门ID String 网络开门对应eustlnfo字段 cardld 物理卡号 String 0.l 开门卡对应卡的物理lID 逻辑卡号 cardNo 0..！ String 开门是否成功 can(Open Boolean openTime 操作时间 String 格式yyyy-MMddHH;mm;ss AlarmRecord信息 字段 数据类型 数量 说明 中文名称 roomNo 房号 String 操作所应用的具体房间 门锁上线(online); 门锁离线(ofline); alarmType 开门类型 String 电量欠压(lowBattery 操作时间 String 格式yyyMMddHHmm;ss alarmTime 130
GB/37976一2019 [请求示例] "msgType","ope" "hotelCode";"HTLG" "data" "roomNo";"8101" nType";"IC" open "ownerld""134257635" "cardld";"134257635" Open" can ;true， "openTime";"2016-1l-3008:00:00" ms sgType";"alarm" "hotelCode";"HTIG" "data" "roomNo";"8101" "alarmType":"online" "alarmTime";"2016-ll-3008:00:00" [返回示例] "resultCode":0 "resultMsg""成功" 6.4.2客房控制服务 6.4.2.1获取房间设备接口 [接口描述] 获取当前用户授权的酒店房间智能设备,以便进行智能设备控制 [请求参数] 字段 中文名称 数据类型 数量 说明 hotelld 酒店lD String 房间号 roomNumber String 131
GB/T37976一2019 [响应数据 数据类型 字段 中文名称 数量 说明 结果代码 result(Code String resultMs9 结果信息 String resultlnfo 结果对象 RoomDevieeDto 房间设备列表 RoomDeviceDo 字段 中文名称 数据类型 数量 说明 devieeld number 设备ID deviceKey 设备编号 String 不同设备以两位英文字母起始 devieeName 设备命令 String 设备显示名称 6.4.2.2设备命令执行接口 接口描述] 授权用户发送设备执行命令 请求参数 字段 数据类型 中文名称 数量 说明 hotelld 酒店ID String roomNumber 房间号 String Command 命令对象集合 Commmands [Commands 字段 中文名称 数据类型 数量 说明 deviceld 设备编号 number 控制命令 command String [响应数据 字段 中文名称 数据类型 数量 说明 结果代码 result(Code String resultMsg 结果信息 String resultlnfo 返回信息 String 6.4.2.3设备命令执行规则 [C规则描述 在客控命令的编制过程中,应考虑到命令具有以下特性 命令根据规则应具有可读性 a b) 命令具有通用和抽象性,不与具体的品牌相关联 命令面对不同的新设备应具有灵活的扩展性 c 132
GB/37976一2019 命令规则描述如下: [开关命令规则 开关设备 设备类型 命令格式 Swindex}_emd index)》;设备序号,具体映身根据房间设备查询获取序号相对应的设备标签名称 释义 cmd命令;0表示关闭l表示打开 举例 打开序号为1的开关,Sw1-l [空调命令规则 设备类型 空调 Ac6 命令格式 index》_cmd AC;设备类型为空调 index);设备序号,具体映射根据房间设备查询获取序号相对应的设备标签名称 cmd: partl'part2(part3(part4{part5par6(part partl:空调温度16C30C 释义 part2:风量数据;自动;01,低;02,中;03,高;04 风向向上:01,中,02,向下:03 part3 part4:自动风向打开;01,关闭:00,ecmd5:开机:01,关机:00 art6;按键名表示当前按下的键 part7:工作模式自动:01，制冷:02,抽湿:03，送风:04，制热:05 空调制热模式温度23C,低风 举例 AC123020l010l0l05 [电视命令规则 设备类型 电视 TVi 命令格式 index》_emd index);设备序号,具体映身根据房间设备查询获取序号相对应的设备标签名称 电视cmd命令 0;关 l;开 2:菜单 3;信号源TV/AV 4;频道加 5,频道减 释义 6;音量加 7;音量减 8:静音 9输人位数切换 1019:数字0至数字9 2l:下 22:左 20: 23:右 24:OK 25:返回 举例 打开序号1的电视机TV1_" [电视机顶盒命令规则 设备类型 电视机顶盒 Bxindex)_(cmd 命令格式 133
GB/T37976一2019 设备类型 电视机顶盒 imdex)设备序号,具体映身根据房间设备查询获取序号相对应的设备标签名称 电视cmd命令 1;开 2;菜单 0关 释义 4;频道加 5;频道减 6.音量加 7;音量减 8静首 20:上 21: 22:左 23:右 24:OK 25:返回 举例 打开序号1的电视机顶盒BX1_1 [C窗帘命令规则 设备类型 窗帘设备 命令格式cT\imdex)-emd index:;设备序号,具体映身根据房间设备查询获取序号相对应的设备标签名称 释义 窗帘cmd命令;0表示关闭，1表示打开,2;暂停 举例 打开1号窗帘;CT1_1 [门显命令规则 设备类型 门显设备 命令格式 DSindex)_'emd {index}:设备序号,具体映身根据房间设备查询获取序号相对应的设备标签名称 Cmd该命令由子命令集并按序组成 parl(part2part3part4) artl;请勿打扰 01不显示 00显示 释义 part2;请即清理 00显示， 01不显示 art3;有无人 00显示、 01不显示 part4:房号(字符 举例 188号房间显示有人请即清理;DSI_000101188 6.4.3客房娱乐服务 6.4.3.1智能终端设备在线状态查询 [接口功能] 查询指定客房的智能终端设备状态,例如某客房电视是否正在开机使用中 请求信息] 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String PMs酒店品牌 一家指定的酒店品牌名称 PMS hotelBrandl String PMS酒店D PMS厂家指定酒店品牌的某个分店代号 hotel(Code String 房间号 String roomNo 134
GB/37976一2019 [请求示例] hotelGroupCode""TestCode" ”hotelBrand""TestCode" "hotelCode""TestCode" roomNo""1004" [[响应数据] [[返回成功信息 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 number 返回0为成功 resultMsg 结果消息 String 请求成功失败的信息 0.. resultO 结果对象 Objeet[ 0., [响应示例] [响应成功示例] resultCode" ":0. " esnltMsg" resultOb" "isOpen";true "openDate""2016-03-20" "is(Online":true "onlinelp""192.168.2.3" [响应失败示例 r resultCode":一1 "resultMsg";"失败信息" 6.4.3.2紧急信息 [接口功能] PMS向信息娱乐系统发送跑马灯或弹窗信息,其中团客信息分组发布 [请求参数 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String hotelBrand PMS酒店品牌 String PMS厂家指定的酒店品牌名称 P\Ms厂家指定酒店品牌的某个分店代号 hotelCode PMS酒店ID number 135
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 信息内容 Message String 消息内容 紧急程度 0一2数字越大,越紧急 State number GrouplD 团客组 如果没有组,则发送到所有客房 number 0..n 请求示例] hotelGroupCode";"TestCode" 、" ”hotelBrand" 'TestCode" "hotelCode""Test(Code" "Message";"大风天气蓝色预警" "State""2" "GroupID":"" [响应数据 字段 中文名称 数据类型 数量 说明 result(Code 返回代码 number 返回0为成功,非0即为失败 esultMsg 结果消息 成功消息 String 0." 返回数掘 根据需要适时扩展 resultObj Object口 0." [响应示例] "resultCode";"0" 111 "resultMsg" "resultOb";"" 6.4.3.3设定娱乐系统为开房状态 C接口功能] 通过PMS此为房间开房,更改房间终端的开关房状态,并传递客人的基本信息给到酒店信息娱乐 系统 [请求参数 数据类型 数量 说明 字段 中文名称 roomNumber 房间号 房间编号 String 团队标识 0;散客;1团队 group number groupName 团队名称 String 散客则没有团队名称 0.1 ehecklnlDate 人住日期 格式;yyyy-MM-ddHH:MMSs string 国籍 number 0;国内;l;国外 country isMember 是否是会员 number 0;非会员;l;会员 136
GB/37976一2019 字段 中文名称 数据类型 数量 说明 只有会员才会有积分 会员积分 integral number 0..l 非会员是没有积分的 多个客人信息 customers CustomerDto口 0." [请求参数] "roomNumber";"1001" group groupName checklnDate":"2012-09-2013:34:23" cOuntry isMember" integral":210. custOmers 'eusromerld";"1 "张三" customer 'seX "idTy "0" ype "idNo";"110108xxxxxxxxx "cusromerld";"2" "customer";"李四", "1" "sex "idType";"o" "idNo""1333108xxxxxxxxx [[返回成功信息 字段 说明 中文名称 数据类型 数量 resulCode 结果代码 0代表成功 number resultMessage 成功信息 String 请求成功的信息 [返回成功示例] "resultCode":0. r' esultMessage";"请求成功" 137
GB/T37976一2019 [返回失败信息 字段 中文名称 数据类型 数量 说明 返回代吗 返回非0即为失败 resultCode number euMeee 返回消息 失败消息 String [返回失败示例] "resultCode";:-1 "resultMe deage","失败信息" 6.4.3.4 账单推送 [接口功能] PMS主动将发生变化的客房账单推送给酒店信息娱乐系统,以便客人查询 请求参数] 字段 中文名称 数据类型 数量 说明 roomNumber 房间号 number 该账单所属的房间 消费明细 items temDo 账单截止时间 格式;yy-MMddHH,MM,ss time string 请求参数] "tin ime";"2012-09-1020.00.00" "roomNumber";"1003" "item.s" "feeTy "1" Typ" "feeName" ""10号房费” "fee""237” "feeDate";"2012-09-1010;22;20" "feeType";"2" "feeName""电话费", "fee";"38.34" "feeDate";"2012-09-109;21:30' [返回成功信息] 138
GB/37976一2019 字段 中文名称 数据类型 数量 说明 结果代码 resultCode number 0代表成功 rresulMe 成功信息 请求成功的信息 lessage String [返回成功示例 "resultCode":0, 'resulMessage";"请求成功" [返回失败信息] 字段 中文名称 数据类型 数量 说明 resultCode 返回代码 number 返回非0即为失败 resultMessage 返回消息 String 失败消息 [[返回失败示例 "resultCode";一1， "resultMessage";"失败信息" 6.4.3.5娱乐系统消费账单获取 [接口功能] PMS系统查询客房信息娱乐系统内产生的消费账单,例如最后退房前确认一次 [请求参数] 字段 数据类型 数量 中文名称 说明 账单截止时间 格式;yyMMdaHHMM,ss time string 该账单所属的房间 roomNumber 房间号 number 消费明细 ltemDto口 items [请求参数 "time""2012-09-1020:00:00" "roomNumber""1003" "items" 、 'feeType";"1o1" "eeName";"电影点播费" "fee""20" "feeDate""2012-09-1010:22:20" "feeType""102" 139
GB/T37976一2019 "feeName""点餐费", "fee";"150.00" "feeDate""2012-09-109:21:30" [返回成功信息] 字段 数据类型 说明 中文名称 数量 resulCode 结果代码 number 0代表成功 resulMessage 成功信息 String 请求成功的信息 [返回成功示例 "resultCode":0. "resultMessage";"请求成功" [返回失败信息 字段 中文名称 数据类型 数量 说明 返回代码 返回非0即为失败 resultCode number resulMe 返回消息 失败消息 Message String [返回失败示例 "resultCode";一1， r' tsultMessage";"失败信息" 6.4.3.6设定娱乐系统为关房状态 [C接口功能 更改房间状态,将房间的状态置为初始值 [请求参数 中文名称 数量 说明 字段 数据类型 roomNumber 房间编号 String 房间号 [返回成功信息 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 number 0代表成功 resultMessage 成功信息 String 请求成功的信息 [返回成功示例 "resultCode";0. 40
GB/37976一2019 "esultMessage""请求成功" [返回失败信息丁 数据类型 字段 中文名称 数量 说明 返回代码 返回非0即为失败 resultCode number esutMessage 返回消息 失败消息 String [返回失败示例 "resultCode" "resultMes ssaEe""失败信息" 6.4.3.7 获取点餐系统菜单 [接口功能] 餐饮系统提供的菜单数据查询接口 [请求参数 字段 数据类型 说明 中文名称 数量 hotelCode 酒店代码 Strng [请求参数] "hotelCode""TestCode" [返回成功信息 字段 数据类型 数量 说明 中文名称 resultCode 返回代码 返回0为成功 number resultMessage 返回消息 String 成功消息 resultnfo 返回数据 整个菜单数据 [返回成功示例 "o" "resultCode": "resultMessage" "resultlnfo" "memuTypelist" "ypeCode";8 "ypeName"早餐 menuList" uCode":1001 menu 141
GB/T37976一2019 "menuName";"混合蔬菜沙拉" "basicPrie""58.8" "elIPrice""58.8" showlmsge"["http://end.imagedDiningHotdl/00l,pg","htp://cend.imsgeiningHotel/0o. jpg" "intro";"鲜嫩生菜叶,蔬菜配橄榄油醋汁,千岛汁或法汁" "diningRoomCode";"dl003" "diningRoomName""西餐厅" "diningTelephones";"o10-88886666-555" "options": "optionCode":l "optionDesc";"橄榄油醋汁" "optionCode":l， "optionDesc""千岛汁" "optionCode"1. opionDes","法汁" [返回失败信息们] 字段 中文名称 数据类型 数量 说明 resultCode 返回代码 number 返回一1为失败 resultMessage 返回消息 String 失败消息 resultInfo 返回数据 根据需要适时扩展 [返回失败示例] "resultCode" II "resultMessage" 11n "resultlnfo" 142
GB/37976一2019 6.4.3.8向点餐系统下单 [接口功能] 餐饮系统提供的点餐下单接口 [请求参数] 数据类型 字段 中文名称 数量 说明 hotelCcode 酒店代码 Strng 房间编号 roomNumber String menulnfo 下单的菜品数据 菜单信息 [请求参数] "hotelCode""TestCode" "roomNumber":"85008" menulnfo" menuCode";"1003" cOunt "option':2 1t "desc" menuCode";"1004" "count" "option "desc" [[返回成功信息] 字段 中文名称 数据类型 数量 说明 result(Code 返回代码 number 返回0为成功 返回消息 resultMessage 成功消息 String resultlnfo 返回数据 整个菜单数据 [返回成功示例 "resultCode""o" "resultMe lessage" "resultlnfo" [返回失败信息] 143
GB/T37976一2019 字段 中文名称 数据类型 数量 说明 返回-1为失败 resultCode 返回代码 number 返回消息 失败消息 resultMessage String resultnfo 返回数掘 根据需要适时扩展 [返回失败示例 "resultCode" "esulMesage" "tesdllnfo" 6.4.3.9叫早设定 C接口功能] 向程控交换系统发送叫早信息 C请求参数] 字段 数据类型 数量 说明 中文名称 hoteCode 酒店代码 Strng roomNumber 房间号 String 可以是多个 time 叫早时间 String 格式:hh:mm expiryDate string 失效日期 格式;yyyy-MM-dd C请求参数] "hotelCode";"TestCode" "roomNumber":["1003","1004"] "time";"06:50" "expiryDate";"2016-03-29" [返国成功信息7 字段 中文名称 数据类型 数量 说明 resulCode 返回代码 number 返回0为成功 resultMessage 返回消息 成功消息 String resultInfo 返回数据 根据需要适时扩展 0..n [返回成功示例] "resultCode""o" II "esulMesage" 11n "resultlnfo" 144
GB/37976一2019 [返回失败信息 字段 中文名称 数据类型 数量 说明 resultCode 返回代码 number 返回非0即为失败 返回消息 失败消息 resultMessage String [返回失败示例 "resultCode"; "resulMessage""房间未开通" 6.4.3.10客房入住信息同步服务 [[功能说明] 用于客房智能设备同步宾客信息数据 [请求参数] 字段 说明 中文名称 数据类型 数量 PMSId PMS系统编号 String PMS品牌名称 PMS酒店品牌 PMS厂家指定的酒店品牌名称 hotelBrand String PMSHotelld PMS酒店ID String PMS厂家指定酒店的某个分店代号 房间号码 roomNo 房间号 String checklnTime 登记时间 String 时间格式yyyy-MMddhh;:mm;ss cheekOutTinme -MM-ddhh:mm:ss 退房时间 时间格式yyy String 状态 String 状态(0:退房;l:人住 statuS 时间截 当前时间转化成秒数的字符串 timeStamp String sign 参数签名 String 按照签名规则计算出结果 宾客数据 guestDto口 guests l..n guestDto 字段 中文名称 数据类型 数量 说明 name 宾客姓名 宾客姓名 String 性别 String 性别M;男;F;女 sex 手机号码 手机号码 String phone 签名规则 Sign=MD5 xxx&.hotelBrand xxx&.PMSHotelld xxx&.timeStamp xxxx&.keySecret (“PMSId XXxXX xx”).toUpperCase(); 按规则拼装字符串,然后进行MD5加密(UTF-8编码),并且转成大写 例如请求参数;PNMSId=欢旅,hotelIBrand=七天,PMSHotelld=1,timeStamp=20160718103256. keySecret=8934e7d15453e97507ef794cf7b0519d 计算得出的Sign=CEF7238790E9EF41C93F9C8DEF4AEIEA 145
GB/T37976一2019 [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 响应码 number 0表示提交成功 响应描述 响应描述 rresultMsg String C请求示例] "PMsId";"xxx "hotelBrand":"xxx "PMsHotelId" XXX "timeStamp XX SIgn XXXX roomNo";l0xxx06 checkInTime";"201zzzz33" checkOutTime":"xxxx" status guests "name";"新客人","sex";"M","phone";"") [响应示例] tultCode":0. resu "esultMsg":"OK" 6.4.4公安数据接入 6.4.4.1获取入住信息getCheekin [功能说明] 获取客人人住信息 C请求参数] 字段 说明 中文名称 数据类型 数量 hotelGroupCode 酒店集团代码 String hotelCode 酒店代码 String Name 姓名 String idType 证件类型 String idNo 证件号码 String [[响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 字段操作结果 esultMsg 结果信息 String 返回提示信息 resultOb 结果对象 CheckinDto[ 0.n 返回数据对象 46
GB/37976一2019 CheckinDto 字段 中文名称 数据类型 数量 说明 到日 String arT dep 离日 String 房号 roomNo String 订单号 orderNo String 6.4.4.2提交入住信息setCheckin 功能说明] 向公安户籍系统提交宾客人住信息 [请求参数] 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String hoteNo 酒店代码 String 客人名字 name String 性别 sex String 民族 race Stri ring birth String 生日 address 住址 String division 行政区划 String 证件类型 idType String 证件号码 idNo String iadEBe 证件开始有效期 String Begin idEnd 证件截止有效期 String orderNo 订单号 String roomNo 房间号 String 人住时间 String arT Photo 现场照片(base64 String [响应数据 字段 中文名称 数据类型 数量 说明 结果代码 字段操作结果 resultCode String eswlMg 结果信息 返回提示信息 String 6.4.4.3提交换房信息setChangeRoom [功能说明] 向公安户籍系统提交宾客换房信息 147
GB/T37976一2019 请求参数 字段 数据类型 数量 说明 中文名称 酒店集团代码 hotelGiroupCode String hoteNo 酒店代码 String 客人名字 String name idType 证件类型 String 证件号码 idNo String orderNo 订单号 String 新的房间号 roomNo String 人住时间 String changeDate 现场照片(base64 photo String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 字段操作结果 resultMsg 结果信息 String 返回提示信息 6.4.4.4提交离店信息setCheekout [功能说明] 向公安户籍系统提交宾客退房信息 [请求参数 字段 中文名称 数据类型 数量 说明 hotelGroupCode 酒店集团代码 String hotelNo 酒店代码 String roomNo 房号 String dType 证件类型 String 证件号码 idNo String 离店时间 IDep String [响应数据 字段 中文名称 数据类型 数量 说明 resultCode 结果代码 String 字段操作结果 resultMsg 结果信息 String 返回提示信息 接口安全要求 7.1结构安全 结构安全要求包括 48
GB/37976一2019 应保证关键网络设备的业务处理能力具备冗余空间,满足业务高峰期需要， a b 应保证接人网络和核心网络的带宽满足业务高峰期需要 应绘制与当前运行情况相符的网络拓扑结构图 c d)应根据各部门的工作职能,重要性和所涉及信息的重要程度等因素,划分不同的子网或网段， 并按照方便管理和控制的原则为各子网、网段分配地址段 7.2访问控制 访问控制要求包括 a 应在网络边界部署访问控制设备,启用访问控制功能 b 应能根据会话状态信息为数据流提供明确的允许/拒绝访问的能力,控制粒度为网段级 应按用户和系统之间的允许访问规则,决定允许或拒绝用户对受控系统进行资源访问,控制粒 c 度为单个用户; d 应限制具有拨号访问权限的用户数量 7.3安全审计 安全审计要求包括; 应对网络系统中的网络设备运行状况网络流量,用户行为等进行日志记录; a b审计记录应包括事件的日期和时间,用户,事件类型、事件是否成功及其他与审计相关的信息 7.4边界完整性检查 应能够对内部网络中出现的内部用户未通过准许私自联到外部网络的行为进行检查 7.5入侵防范 应在网络边界处监视以下攻击行为;端口扫描、,强力攻击,木马后门攻击、拒绝服务攻击、缓冲区滋 出攻击、,IP碎片攻击和网络蠕虫攻击等 7.6网络设备防护 网络设备防护要求包括 应对登录网络设备的用户进行身份鉴别; a 应对网络设备的管理员登录地址进行限制; b 网络设备用户的标识应唯 c 身份鉴别信息应具有不易被冒用的特点,口令应有复杂度要求并定期更换; d 应具有登录失败处理功能,可采取结束会话,限制非法登录次数和当网络登录连接超时自动退 e 出等措施 当对网络设备进行远程管理时,应采取必要措施防止鉴别信息在网络传输过程中被窃听

物联网智慧酒店应用平台接口通用技术要求GB/T37976-2019解析

随着物联网技术的不断发展和普及，智慧酒店已成为现代化城市建设中的重要组成部分。然而，不同厂商生产的智慧酒店设备之间缺乏统一的通信协议和接口标准，这给酒店的运营和管理带来了很大的困难。

为此，中国国家标准化委员会制定了《物联网智慧酒店应用平台接口通用技术要求GB/T37976-2019》标准，旨在规范智慧酒店设备之间的通信协议和接口标准，提高智慧酒店设备的互操作性和兼容性。

标准内容

该标准主要包括以下内容：

• 通用要求：包括术语和定义、规范引用、要求和条款等。
• 物联网智慧酒店应用平台接口的基本结构和要素：包括接口层次结构、接口要素、命名规则等。
• 物联网智慧酒店应用平台接口的实现技术要求：包括数据传输格式、安全性、可靠性、兼容性等。
• 物联网智慧酒店应用平台接口测试要求：包括测试方法、测试流程、测试指标等。

应用价值

《物联网智慧酒店应用平台接口通用技术要求GB/T37976-2019》标准的制定，可以有效提高智慧酒店设备的互操作性和兼容性，降低设备采购和维护成本，提高酒店的运营效率和服务质量。此外，它还为相关企业提供了一个统一的技术标准，促进了行业的健康发展。

总结

《物联网智慧酒店应用平台接口通用技术要求GB/T37976-2019》标准的出台，填补了国内智慧酒店设备通信协议和接口标准化的空白，规范了智慧酒店设备之间的通信协议和接口标准，提高了设备的互操作性和兼容性，促进了行业的快速发展。

物联网智慧酒店应用平台接口通用技术要求的相关资料

和物联网智慧酒店应用平台接口通用技术要求类似的标准