會務(wù)酒店分房工具API
- 新建工具(包含表單配置)
- 查詢工具內(nèi)容(包含表單配置)
- 更新工具內(nèi)容(包含表單配置)
- 刪除工具
- 獲取excel模板
- 批量上傳會員信息
- 讀取預(yù)約或待分配會員列表
- 讀取已分配會員列表
- 根據(jù)住房時間讀取未分配會員列表
- 導(dǎo)出會員列表
- 添加待預(yù)約會員
- 添加待分配會員
- 查詢會員信息
- 修改會員信息
- 會員提交預(yù)約訂房信息
- 刪除會員
- 給會員發(fā)送預(yù)訂短信
- 給所有會員發(fā)送預(yù)訂短信
- 給所有會員發(fā)送成功短信通知
- 查詢已分配房間信息
- 修改已分配房間信息
- 清除已分配房間
- 設(shè)置分房規(guī)則
- 讀取分房規(guī)則
- 批量分配房間
- 讀取分房統(tǒng)計
通用參數(shù)
-
狀態(tài)碼code的含義
{
0:請求成功
1:操作失敗
}
-
所有的API請求都要攜帶token參數(shù)
{
access_token: 訪問token
access_type: token類型
}
新建工具
API
[POST] /tool_hotel
<span id="tool_content"></span>
請求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
background | String | 否 | 背景圖片鏈接 |
tool_title | String | 否 | 工具標(biāo)題 |
tool_desc | String | 否 | 工具描述 |
permission | String | 是 | 限定的會議ID |
agency_id | String | 否 | 機(jī)構(gòu)ID |
open_time | int | 否 | 開始時間 |
close_time | int | 否 | 截止時間 |
form_config | Array | 否 | 表單配置 |
form_config數(shù)組數(shù)據(jù)項格式:
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
type | String | 否 | 表單類型 |
category | String | 否 | 表單分類 |
name | String | 否 | 字段名稱 |
desc | String | 否 | 字段描述 |
tips | String | 否 | 字段提示 |
picked_for_allocate | String | 否 | 是否勾選為分配規(guī)則 |
options | Array | 否 | 單選和多選類型的選擇項 |
required | String | 否 | 是否必填,值為true 或者 false |
default | String | 否 | 是否默認(rèn),值為true 或者 false |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | int | 是 | 工具ID |
Sample
[POST] http://localhost:9999/tool_hotel?access_token=xxx&access_type=org
Body:
{
"tool_title": "第二屆中國浙商會議酒店用房預(yù)訂",
"background": "http://pic2.cxtuku.com/00/02/31/b945758fd74d.jpg”,
"tool_desc":"",
"permission": "",
"agency_id": "非空",
"open_time":"開始時間",
"close_time":"關(guān)閉時間",
"form_config":[
{
type:"xxx",
name:"",
desc:"",
tips:"",
options:[],
required:"true",
default:"true"
}
]
}
Return:
{
"code": 0,
"msg": "創(chuàng)建成功",
"data": “1”
}
查詢工具內(nèi)容
API
[GET] /tool_hotel/{id}
請求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | Object | 是 | 返回數(shù)據(jù) |
Data:
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
id | int | 否 | 工具ID |
其它參數(shù)同 創(chuàng)建工具時提交的參數(shù) |
更新工具內(nèi)容
API
[PUT] /tool_hotel/{id}
請求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
id | int | 否 | 工具ID |
其它參數(shù)同 創(chuàng)建工具時提交的參數(shù) |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | int | 是 | 工具 ID |
Return:
{
"code": 0,
"msg": "更新成功",
"data": “1”
}
刪除工具
API
[DELETE] /tool_hotel/{id}
請求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
access_token | String | 否 | 訪問憑證 |
access_type | String | 否 | 憑證類型 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
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
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | int | 是 | 工具ID |
讀取預(yù)約或待分配會員列表
API
[get] /tool_hotel/{id}/member_list/{select}
select :
unbook:未預(yù)約
unassigned:未分配
請求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
page_index | int | 否 | 頁碼笨鸡,默認(rèn)是1漓概,當(dāng)值為0時則不分頁 |
page_size | int | 否 | 每頁大小勒极,默認(rèn)是10 |
name | int | 否 | 會員名字 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | Array | 是 | 會員列表 |
data 數(shù)組數(shù)據(jù)項格式:
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
member_id | String | 否 | 會員ID |
member_real_name | String | 否 | 會員名字 |
member_sex | String | 否 | 會員性別 |
member_phone | String | 否 | 會員手機(jī)號碼 |
member_IDnum | String | 否 | 身份證號碼 |
room_type | String | 否 | 選擇房型 |
member_checkin_date | String | 否 | 入住時間 |
member_checkout_date | String | 否 | 退房時間 |
hotel | String | 否 | 選擇酒店 |
member_extra | String | 否 | 會員提交的其它信息 |
member_status | String | 否 | 會員的分房狀態(tài) |
pre_room_num | String | 否 | 預(yù)分配編號 |
remark_room_num | String | 否 | 備注房間號 |
send_msg_status | String | 否 | 發(fā)送消息狀態(tài) |
讀取已分配會員列表
API
[get] /tool_hotel/{id}/member_list/assigned
請求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
page_index | int | 否 | 頁碼敞恋,默認(rèn)是1 |
page_size | int | 否 | 每頁大小,默認(rèn)是10 |
name | int | 否 | 會員名字 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | Array | 是 | 會員列表 |
data 數(shù)組數(shù)據(jù)項格式:
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
pre_room_num | String | 否 | 預(yù)訂編號 |
room_type | String | 否 | 房型 |
room_members | String | 否 | 房間成員 |
room_checkin_date | String | 否 | 入住時間 |
room_checkout_date | String | 否 | 離店時間 |
根據(jù)住房時間讀取未分配會員列表
API
[get] /tool_hotel/{id}/member_list/unallocate/from/{checkin_date}/to/{checkout_date}
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | Array | 是 | 會員列表 |
data 數(shù)組數(shù)據(jù)項格式:
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
member_id | String | 否 | 會員ID |
member_real_name | String | 否 | 會員名字 |
member_sex | String | 否 | 會員性別 |
member_phone | String | 否 | 會員手機(jī)號碼 |
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 | 否 | 會員的分房狀態(tài) |
導(dǎo)出會員列表
API
[GET] /tool_hotel/{id}/member_list_export/{select}
select :
unbook:未預(yù)約
unassigned:未分配
assigned:已分配
返回
excel表 member-list-{select}.xlsx
添加待預(yù)約會員
API
[POST] /tool_hotel/{id}/member/unbook
請求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
member_real_name | String | 否 | 會員名字 |
member_phone | String | 否 | 會員手機(jī)號碼 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | String | 是 | 會員ID |
添加待分配會員
API
[POST] /tool_hotel/{id}/member/unallocate
請求參數(shù)
<span id="add_member"></span>
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
member_real_name | String | 否 | 會員名字 |
member_sex | String | 否 | 會員性別 |
member_phone | String | 否 | 會員手機(jī)號碼 |
member_IDnum | String | 否 | 身份證號碼 |
room_type | String | 否 | 選擇房型 |
member_checkin_date | String | 否 | 入住時間 |
member_checkout_date | String | 否 | 退房時間 |
can_share | String | 否 | 是否拼房 |
hotel | String | 是 | 選擇酒店瘤泪,沒有酒店選擇灶泵,傳空字符串 |
remarks | String | 是 | 備注 |
member_extra | String | 是 | 非默認(rèn)表單數(shù)據(jù)(把對象轉(zhuǎn)為json字符串) |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | String | 是 | 會員ID |
查詢會員信息
API
[GET] /tool_hotel/{id}/member/{id}
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | Object | 是 | 會員信息 |
data格式:
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
pre_room_num | String | 否 | 預(yù)訂編號 |
remark_room_num | String | 否 | 備注房間號 |
其它參數(shù)同 添加待分配會員接口提交的參數(shù) |
修改會員信息
API
[PUT] /tool_hotel/{id}/member/{id}
請求參數(shù)和返回結(jié)果同會員提交預(yù)約訂房信息
會員提交預(yù)約訂房信息
API
[PUT] /tool_hotel/{id}/book_room
請求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
pre_room_num | String | 否 | 預(yù)訂編號 |
remark_room_num | String | 否 | 備注房間號 |
其它參數(shù)同 添加待分配會員接口提交的參數(shù) |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | String | 是 | 會員ID |
code :
{
0: 成功
1:不在預(yù)約列表
2:已在分配列表
}
刪除會員
API
[DELETE] /tool_hotel/{id}/member/{id}
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | String | 是 | 會員ID |
給會員發(fā)送預(yù)訂短信
API
[PUT] /tool_hotel/{id}/member/{id}/message_book
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | String | 否 | 會員手機(jī)號 |
給所有會員發(fā)送預(yù)訂短信
API
[PUT] /tool_hotel/{id}/message_book/to_all
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | String | 否 | 工具ID |
給所有會員發(fā)送成功短信通知
API
[PUT] /tool_hotel/{id}/message_allocated/to_all
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | String | 否 | 工具ID |
查詢已分配房間信息
[GET] /tool_hotel/{id}/allocated_room_info/{pre_room_num}
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | Object | 否 | 會員手機(jī)號 |
data 數(shù)據(jù)格式:
<span id="allocated_room_info"></span>
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
pre_room_num | int | 否 | 預(yù)訂編號 |
room_type | String | 是 | 房間類型 |
member_checkin_date | String | 否 | 入住時間 |
member_checkout_date | String | 否 | 離店時間 |
remark_room_num | String | 否 | 標(biāo)記的房間號 |
room_members | Array | 否 | 房間成員 |
room_members數(shù)組數(shù)據(jù)格式:
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
member_id | int | 否 | 會員ID |
member_real_name | String | 否 | 會員名字 |
修改已分配房間信息
[PUT] /tool_hotel/{id}/allocated_room_info/{pre_room_num}
請求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
參數(shù)同 查詢已分配房間信息返回參數(shù) |
清除已分配房間
[DELETE] /tool_hotel/{tool_id}/clear_room_member/{pre_room_num}
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | String | 是 | 預(yù)訂房間編號 |
設(shè)置分房規(guī)則
API
[PUT] /tool_hotel/{id}/allocate_rule
請求參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
rules | Array | 否 | 分房規(guī)則 |
rules數(shù)組的數(shù)據(jù)項格式:
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
id | Int | 否 | 規(guī)則ID |
name | String | 否 | 規(guī)則名稱 |
picked_for_allocate | String | 否 | 是否被勾選了,true:是,false:否 |
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | String | 是 | 工具ID |
讀取分房規(guī)則
API
[GET] /tool_hotel/{id}/allocate_rule
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | Array | 是 | 分房規(guī)則 |
data數(shù)組的數(shù)據(jù)項格式:
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
id | Int | 否 | 規(guī)則ID |
name | String | 否 | 規(guī)則名稱 |
picked_for_allocate | String | 否 | 是否被勾選了,true:是对途,false:否 |
批量分配房間
API
[PUT] /tool_hotel/{id}/batch_allocate
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | int | 是 | 工具ID |
讀取分房統(tǒng)計
API
[GET] /tool_hotel/{id}/allocate_stat
返回參數(shù)
參數(shù) | 類型 | 允許為空 | 描述 |
---|---|---|---|
code | int | 否 | 狀態(tài)碼 |
msg | String | 是 | 描述文字 |
data | array | 是 | 分類統(tǒng)計結(jié)果 |
data數(shù)組數(shù)據(jù)項格式:
[
{
category: '預(yù)訂會員統(tǒng)計',
stat: {
"預(yù)約會員數(shù)量": book_member_num,
"待分配會員數(shù)量": unallocated_member_num,
"已分配會員數(shù)量": allocated_member_num,
"會員總數(shù)":member_num
}
},
{
category: '預(yù)訂房間統(tǒng)計',
stat: {
"預(yù)約標(biāo)準(zhǔn)單人房間數(shù)量": book_singleroom_num,
"預(yù)約標(biāo)準(zhǔn)雙人房間數(shù)量": book_doubleroom_num,
"預(yù)約房間總數(shù)量": book_room_num
}
},
{
category: '房間分配統(tǒng)計',
stat: {
"已分配標(biāo)準(zhǔn)單人房間數(shù)量": allocated_singleroom_num,
"未分配標(biāo)準(zhǔn)單人房間數(shù)量": unallocated_singleroom_num,
"已分配標(biāo)準(zhǔn)雙人房間數(shù)量": allocated_doubleroom_num,
"未分配標(biāo)準(zhǔn)雙人房間數(shù)量": unallocated_doubleroom_num,
"已分配房間數(shù)量": allocated_room_num,
"未分配房間數(shù)量": unallocated_room_num
}
}
]