酒店分房项目API

2017-05-11 本文已影响73人 kingsonCai

会务酒店分房工具API

新建工具(包含表单配置)
查询工具内容(包含表单配置)
更新工具内容(包含表单配置)
删除工具
获取excel模板
批量上传会员信息
读取预约或待分配会员列表
读取已分配会员列表
根据住房时间读取未分配会员列表
导出会员列表
添加待预约会员
添加待分配会员
查询会员信息
修改会员信息
会员提交预约订房信息
删除会员
给会员发送预订短信
给所有会员发送预订短信
给所有会员发送成功短信通知
查询已分配房间信息
修改已分配房间信息
清除已分配房间
设置分房规则
读取分房规则
批量分配房间
读取分房统计

通用参数

状态码code的含义

{
  0：请求成功
  1：操作失败
}

所有的API请求都要携带token参数

{
  access_token:  访问token
  access_type:  token类型
}

新建工具

API

[POST] /tool_hotel

请求参数

参数	类型	允许为空	描述
background	String	否	背景图片链接
tool_title	String	否	工具标题
tool_desc	String	否	工具描述
permission	String	是	限定的会议ID
agency_id	String	否	机构ID
open_time	int	否	开始时间
close_time	int	否	截止时间
form_config	Array	否	表单配置

form_config数组数据项格式：

参数	类型	允许为空	描述
type	String	否	表单类型
category	String	否	表单分类
name	String	否	字段名称
desc	String	否	字段描述
tips	String	否	字段提示
picked_for_allocate	String	否	是否勾选为分配规则
options	Array	否	单选和多选类型的选择项
required	String	否	是否必填,值为true 或者 false
default	String	否	是否默认,值为true 或者 false

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	int	是	工具ID

Sample

[POST] http://localhost:9999/tool_hotel?access_token=xxx&access_type=org

Body:

{
  "tool_title": "第二届中国浙商会议酒店用房预订",
  "background": "http://pic2.cxtuku.com/00/02/31/b945758fd74d.jpg”,
  "tool_desc":"",
  "permission": "",
  "agency_id": "非空",
  "open_time":"开始时间",
  "close_time":"关闭时间",
  "form_config":[
    {
      type:"xxx",
      name:"",
      desc:"",
      tips:"",
      options:[],
      required:"true",
      default:"true"
    }
  ]
}

Return:

{
  "code": 0,
  "msg": "创建成功",
  "data": “1”
}

查询工具内容

API

[GET] /tool_hotel/{id}

请求参数

参数	类型	允许为空	描述
access_token	String	否	访问凭证
access_type	String	否	凭证类型

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	Object	是	返回数据

Data:

参数	类型	允许为空	描述
id	int	否	工具ID
其它参数同创建工具时提交的参数

更新工具内容

API

[PUT] /tool_hotel/{id}

请求参数

参数	类型	允许为空	描述
id	int	否	工具ID
其它参数同创建工具时提交的参数

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	int	是	工具 ID

Return:

{
  "code": 0,
  "msg": "更新成功",
  "data": “1”
}

删除工具

API

[DELETE] /tool_hotel/{id}

请求参数

参数	类型	允许为空	描述
access_token	String	否	访问凭证
access_type	String	否	凭证类型

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	String	是	工具 ID

获取excel模板

API

[get] /tool_hotel/{id}/excel_template

返回

excel表import_members_template.xlsx

批量上传会员信息

API

[POST] /tool_hotel/{id}/batch_members

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	int	是	工具ID

读取预约或待分配会员列表

API

[get] /tool_hotel/{id}/member_list/{select}

select :

unbook:未预约
unassigned:未分配

请求参数

参数	类型	允许为空	描述
page_index	int	否	页码，默认是1，当值为0时则不分页
page_size	int	否	每页大小，默认是10
name	int	否	会员名字

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	Array	是	会员列表

data 数组数据项格式：

参数	类型	允许为空	描述
member_id	String	否	会员ID
member_real_name	String	否	会员名字
member_sex	String	否	会员性别
member_phone	String	否	会员手机号码
member_IDnum	String	否	身份证号码
room_type	String	否	选择房型
member_checkin_date	String	否	入住时间
member_checkout_date	String	否	退房时间
hotel	String	否	选择酒店
member_extra	String	否	会员提交的其它信息
member_status	String	否	会员的分房状态
pre_room_num	String	否	预分配编号
remark_room_num	String	否	备注房间号
send_msg_status	String	否	发送消息状态

读取已分配会员列表

API

[get] /tool_hotel/{id}/member_list/assigned

请求参数

参数	类型	允许为空	描述
page_index	int	否	页码，默认是1
page_size	int	否	每页大小，默认是10
name	int	否	会员名字

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	Array	是	会员列表

data 数组数据项格式：

参数	类型	允许为空	描述
pre_room_num	String	否	预订编号
room_type	String	否	房型
room_members	String	否	房间成员
room_checkin_date	String	否	入住时间
room_checkout_date	String	否	离店时间

根据住房时间读取未分配会员列表

API

[get] /tool_hotel/{id}/member_list/unallocate/from/{checkin_date}/to/{checkout_date}

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	Array	是	会员列表

data 数组数据项格式：

参数	类型	允许为空	描述
member_id	String	否	会员ID
member_real_name	String	否	会员名字
member_sex	String	否	会员性别
member_phone	String	否	会员手机号码
member_IDnum	String	否	身份证号码
room_type	String	否	选择房型
member_checkin_date	String	否	入住时间
member_checkout_date	String	否	退房时间
can_share	String	否	是否分房
hotel	String	否	选择酒店
remarks	String	否	备注
member_extra	String	否	会员提交的其它信息
member_status	String	否	会员的分房状态

导出会员列表

API

[GET] /tool_hotel/{id}/member_list_export/{select}
select :

unbook:未预约
unassigned:未分配
assigned:已分配

返回

excel表 member-list-{select}.xlsx

添加待预约会员

API

[POST] /tool_hotel/{id}/member/unbook

请求参数

参数	类型	允许为空	描述
member_real_name	String	否	会员名字
member_phone	String	否	会员手机号码

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	String	是	会员ID

添加待分配会员

API

[POST] /tool_hotel/{id}/member/unallocate

请求参数

参数	类型	允许为空	描述
member_real_name	String	否	会员名字
member_sex	String	否	会员性别
member_phone	String	否	会员手机号码
member_IDnum	String	否	身份证号码
room_type	String	否	选择房型
member_checkin_date	String	否	入住时间
member_checkout_date	String	否	退房时间
can_share	String	否	是否拼房
hotel	String	是	选择酒店，没有酒店选择，传空字符串
remarks	String	是	备注
member_extra	String	是	非默认表单数据（把对象转为json字符串)

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	String	是	会员ID

查询会员信息

API

[GET] /tool_hotel/{id}/member/{id}

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	Object	是	会员信息

data格式:

参数	类型	允许为空	描述
pre_room_num	String	否	预订编号
remark_room_num	String	否	备注房间号
其它参数同添加待分配会员接口提交的参数

修改会员信息

API

[PUT] /tool_hotel/{id}/member/{id}
请求参数和返回结果同会员提交预约订房信息

会员提交预约订房信息

API

[PUT] /tool_hotel/{id}/book_room

请求参数

参数	类型	允许为空	描述
pre_room_num	String	否	预订编号
remark_room_num	String	否	备注房间号
其它参数同添加待分配会员接口提交的参数

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	String	是	会员ID

code :

{
   0:   成功
   1：不在预约列表
   2：已在分配列表
}

删除会员

API

[DELETE] /tool_hotel/{id}/member/{id}

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	String	是	会员ID

给会员发送预订短信

API

[PUT] /tool_hotel/{id}/member/{id}/message_book

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	String	否	会员手机号

给所有会员发送预订短信

API

[PUT] /tool_hotel/{id}/message_book/to_all

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	String	否	工具ID

给所有会员发送成功短信通知

API

[PUT] /tool_hotel/{id}/message_allocated/to_all

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	String	否	工具ID

查询已分配房间信息

[GET] /tool_hotel/{id}/allocated_room_info/{pre_room_num}

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	Object	否	会员手机号

data 数据格式：

参数	类型	允许为空	描述
pre_room_num	int	否	预订编号
room_type	String	是	房间类型
member_checkin_date	String	否	入住时间
member_checkout_date	String	否	离店时间
remark_room_num	String	否	标记的房间号
room_members	Array	否	房间成员

room_members数组数据格式：

参数	类型	允许为空	描述
member_id	int	否	会员ID
member_real_name	String	否	会员名字

修改已分配房间信息

[PUT] /tool_hotel/{id}/allocated_room_info/{pre_room_num}

请求参数

参数	类型	允许为空	描述
参数同查询已分配房间信息返回参数

清除已分配房间

[DELETE] /tool_hotel/{tool_id}/clear_room_member/{pre_room_num}

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	String	是	预订房间编号

设置分房规则

API

[PUT] /tool_hotel/{id}/allocate_rule

请求参数

参数	类型	允许为空	描述
rules	Array	否	分房规则

rules数组的数据项格式：

参数	类型	允许为空	描述
id	Int	否	规则ID
name	String	否	规则名称
picked_for_allocate	String	否	是否被勾选了,true:是，false:否

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	String	是	工具ID

读取分房规则

API

[GET] /tool_hotel/{id}/allocate_rule

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	Array	是	分房规则

data数组的数据项格式：

参数	类型	允许为空	描述
id	Int	否	规则ID
name	String	否	规则名称
picked_for_allocate	String	否	是否被勾选了,true:是，false:否

批量分配房间

API

[PUT] /tool_hotel/{id}/batch_allocate

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	int	是	工具ID

读取分房统计

API

[GET] /tool_hotel/{id}/allocate_stat

返回参数

参数	类型	允许为空	描述
code	int	否	状态码
msg	String	是	描述文字
data	array	是	分类统计结果

data数组数据项格式：

[
            {
                category: '预订会员统计',
                stat: {
                    "预约会员数量": book_member_num,
                    "待分配会员数量": unallocated_member_num,
                    "已分配会员数量": allocated_member_num,
                    "会员总数":member_num
                }
            },
            {
                category: '预订房间统计',
                stat: {
                    "预约标准单人房间数量": book_singleroom_num,
                    "预约标准双人房间数量": book_doubleroom_num,
                    "预约房间总数量": book_room_num
                }
            },
            {
                category: '房间分配统计',
                stat: {
                    "已分配标准单人房间数量": allocated_singleroom_num,
                    "未分配标准单人房间数量": unallocated_singleroom_num,
                    "已分配标准双人房间数量": allocated_doubleroom_num,
                    "未分配标准双人房间数量": unallocated_doubleroom_num,
                    "已分配房间数量": allocated_room_num,
                    "未分配房间数量": unallocated_room_num
                }
            }
 ]

酒店分房项目API

会务酒店分房工具API

通用参数

状态码code的含义

所有的API请求都要携带token参数

新建工具

查询工具内容

更新工具内容

删除工具

获取excel模板

批量上传会员信息

读取预约或待分配会员列表

读取已分配会员列表

根据住房时间读取未分配会员列表

导出会员列表

添加待预约会员

添加待分配会员

查询会员信息

修改会员信息

会员提交预约订房信息

删除会员

给会员发送预订短信

给所有会员发送预订短信

给所有会员发送成功短信通知

查询已分配房间信息

修改已分配房间信息

清除已分配房间

设置分房规则

读取分房规则

批量分配房间

读取分房统计

猜你喜欢

热点阅读