PMS设置

1. 获取PMS信息

• 接口地址

POST /api/v1/pms/pmsInfo

• 请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID

• 返回结果

名称	类型	描述
pms_id	int	pms-storeID
name	string	pms-store名称
display_name	string	PMS对外展示名称
type	int	pms-store类型
specification	int	规格 10基础版 20专业版
city	array	城市
address	string	详细地址
contact_name	string	联系人
contact_phone	string	联系电话
introduce	string	介绍
logo_url	string	logo
butler_qr_code_url	string	服务员二维码
public_qr_code_url	string	公众号二维码
service_type	int	服务类型
service_phone	string	服务电话
authorization_end_date	int	授权截止日期
affiliated_group_id	int	所属集团ID
affiliated_group_name	string	所属集团名称
created_at	string	创建时间
setting	object	设置
setting.display_name_type	int	展示名称类型
setting.change_times	int	允许pms信息变更次数
setting.room_order_box	int	订单信息展示类型
setting.order_info_sales	int	订单信息展示类型
setting.order_info_manager	int	订单信息展示类型
setting.order_info_channel_number	int	订单信息展示类型
setting.dirty_room_not_allowed	int	脏房不可预订
setting.check_out_room_not_allowed	int	离店不可预订
setting.continuous_stay_set_dirty	int	连续入住设置脏房
setting.dirty_clean_room_note	int	脏房清洁备注
setting.default_check_in_time	string	默认入住时间
setting.default_check_out_time	string	默认离店时间
setting.point_room_night_count	string	点数房夜数
setting.full_day_late_check_out_time	int	全天晚退时间
setting.point_screen_late_check_out_time	int	点数房晚退时间
setting.pre_order_advance_room_card	int	预付房卡提前天数
setting.room_participation_indicator	int	房间参与类型
setting.self_use_room_revenue_statistic	int	自用房收入统计
setting.free_room_revenue_statistic	int	免费房收入统计
setting.channel_order_auto_arrangement	int	渠道订单自动排房
setting.cross_order_arrangement	int	交叉订单自动排房
setting.current_change_times	int	当前已变更次数
starlock_user	object	starlock用户
starlock_user.username	string	用户名
starlock_user.password	string	密码

• 返回示例

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "pms_id": 2,
        "name": "PMS-2",
        "type": 10,
        "specification": 10,
        "city": [110000],
        "address": "北京市朝阳区",
        "contact_name": "",
        "contact_phone": "",
        "introduce": "",
        "logo_url": "",
        "butler_qr_code_url": "",
        "public_qr_code_url": "",
        "service_type": 10,
        "service_phone": "",
        "authorization_end_date": 4102545599,
        "affiliated_group_id": 0,
        "affiliated_group_name": "",
        "created_at": "2025-02-13 16:30:00",
        "setting": {
            "display_name_type": 10,
            "change_times": 10,
            "room_order_box": 1,
            "order_info_sales": 2,
            "order_info_manager": 2,
            "order_info_channel_number": 2,
            "dirty_room_not_allowed": 1,
            "check_out_room_not_allowed": 2,
            "continuous_stay_set_dirty": 1,
            "dirty_clean_room_note": 1,
            "default_check_in_time": "14:00:00",
            "default_check_out_time": "12:00:00",
            "point_room_night_count": "0.8",
            "full_day_late_check_out_time": 120,
            "point_screen_late_check_out_time": 30,
            "pre_order_advance_room_card": 1440,
            "room_participation_indicator": 2,
            "self_use_room_revenue_statistic": 1,
            "free_room_revenue_statistic": 1,
            "channel_order_auto_arrangement": 1,
            "cross_order_arrangement": 1,
            "current_change_times": 0
        },
        "starlock_user": {
            "username": "hotel-1Xv1px7V@star-lock.cn",
            "password": "yx4wanbm8F"
        }
    }
}

2. 更新PMS信息

• 接口地址

POST /api/v1/pms/update

• 请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
name	string	Y	"pms-store名称"	pms-store名称
display_name	string	Y	"PMS对外展示名称"	PMS对外展示名称
city	array	N	[110000]	城市
address	string	N	"详细地址"	详细地址
contact_name	string	N	"负责人"	负责人
contact_phone	string	N	"负责人手机号"	负责人手机号
service_type	int	N	10	客服类型 10:普通座机号 20:企业座机号 30:手机号码
logo_url	string	N	"logo地址"	logo地址
introduce	string	N	"介绍"	介绍
butler_qr_code_url	string	N	"服务员二维码"	服务员二维码
public_qr_code_url	string	N	"公众号二维码"	公众号二维码
service_phone	string	N	"服务电话"	服务电话

• 返回示例

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {}
}

3. 获取展示图片分组列表

• 接口地址

POST /api/v1/pmsSetting/getPresentationGroups

• 请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
page_no	int	N	1	页码
page_size	int	N	10	每页数量

• 返回结果

名称	类型	描述
list	array	列表
list.*.id	int	分组ID
list.*.name	string	分组名称
list.*.image_count	int	图片数量
total	int	总数
page_no	int	页码
page_size	int	每页数量

• 返回示例

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "list": [
            {
                "id": 1,
                "pms_id": 2,
                "name": "外观",
                "image_count": 0
            },
            {
                "id": 2,
                "pms_id": 2,
                "name": "餐饮",
                "image_count": 0
            }
        ],
        "total": 2,
        "page_no": 1,
        "page_size": 10
    }
}

4. 获取门店展示图列表

• 接口地址

POST /api/v1/pmsSetting/getPresentationImages

• 请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
group_id	int	Y	1	分组ID
page_no	int	N	1	页码
page_size	int	N	10	每页数量

• 返回结果

名称	类型	描述
list	array	列表
list.*.image_id	int	图片ID
list.*.image_url	string	图片地址
total	int	总数
page_no	int	页码
page_size	int	每页数量

• 返回示例

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "list": [
            {
                "image_id": 1,
                "image_url": "http://xxx.jpg"
            }
        ],
        "total": 1,
        "page_no": 1,
        "page_size": 10
    }
}

5. 添加展示图

• 接口地址

POST /api/v1/pmsSetting/addPresentationImage

• 请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
group_id	int	Y	1	分组ID
url	string	Y	"图片地址"	图片地址

• 返回示例

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {}
}

6. 删除展示图

• 接口地址

POST /api/v1/pmsSetting/deletePresentationImage

• 请求参数

名称	类型	是否必需	示例	描述
image_id	int	Y	1	图片ID

• 返回示例

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {}
}

7. 更新展示图

• 接口地址

POST /api/v1/pmsSetting/updatePresentationImage

• 请求参数

名称	类型	是否必需	示例	描述
image_id	int	Y	1	图片ID
url	string	Y	"图片地址"	图片地址

• 返回示例

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {}
}

8. 获取设施列表

• 接口地址

POST /api/v1/pmsSetting/getFacility

• 请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID

• 返回结果

名称	类型	描述
selected_facilityIds	array	选中的设施ID
facility_list	array	设施列表
facility_list.*.group_id	int	设施分类
facility_list.*.group_name	string	设施分类名称
facility_list.*.facilitys	array	设施项
facility_list..facilitys..facility_id	int	设施ID
facility_list..facilitys..facility_name	string	设施名称

• 返回示例

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "selected_facilityIds": [],
        "facility_list": [
            {
                "group_id": 1,
                "group_name": "设施分类",
                "facilitys": [
                    {
                        "facility_id": 1,
                        "facility_name": "设施名称"
                    }
                ]
            }
        ]
    }
}

9. 更新设施

• 接口地址

POST /api/v1/pmsSetting/update

• 请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
facilityIds	array	Y	[1, 2]	设施ID列表

• 返回示例

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {}
}

10. 获取门店政策

• 接口地址

POST /api/v1/pmsSetting/getPolicy

• 请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID

• 返回结果

名称	类型	描述
check_in_time_range	array	入住时间范围([hh:mm, hh:mm])
check_out_end_date	string	退房时间范围(hh:mm)
check_in_remark	string	入住备注
breakfast_policy	int	早餐政策 是否提供早餐 2：不提供 1：提供
breakfast_forms	array	早餐形式[10,20,30] 10：单点 20：固定 30：自助
breakfast_types	array	早餐类型：常量：早餐类型列表
breakfast_time_range	array	早餐时间范围([hh:mm, hh:mm])
breakfast_time_type	int	早餐时间类型 10：全天 20：部分时间开放
breakfast_part_time_range	array	部分开放时间范围，常量: 早餐开放范围
check_in_age_policy	int	办理入住年龄政策 是否限制办理入住年龄 2：不限制 1：限制
check_in_age_range	array	办理入住年龄范围([1,100] []代表不限制)
child_policy	int	儿童政策 是否允许携带儿童入住 2：不允许 1：允许
child_age_min	int	儿童政策 最小年龄
child_remark	string	儿童政策 备注
child_bed_policy	int	儿童加床政策 是否允许加床 2：不允许 1：允许
pet_policy	int	宠物政策 是否允许携带宠物入住 2：不允许 1：允许

• 返回示例

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": {
        "check_in_time_range": ["12:00", "24:00"],
        "check_out_end_date": "24:00",
        "check_in_remark": "入住备注",
        "breakfast_policy": 2,
        "breakfast_forms": [10, 20, 30],
        "breakfast_types": [10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 110, 120, 130],
        "breakfast_time_range": ["07:30", "10:00"],
        "breakfast_time_type": 20,
        "breakfast_part_time_range": [7],
        "check_in_age_policy": 1,
        "check_in_age_range": [24, 90],
        "child_policy": 1,
        "child_age_min": 9,
        "child_remark": "",
        "child_bed_policy": 1,
        "pet_policy": 2
    }
}

11. 更新门店政策

• 接口地址

POST /api/v1/pmsSetting/updatePolicy

• 请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
check_in_time_range	array	N	["12:00", "24:00"]	入住时间范围([hh:mm, hh:mm])
check_out_end_date	string	N	"24:00"	退房时间范围(hh:mm)
check_in_remark	string	N	"入住备注"	入住备注
breakfast_policy	int	N	2	早餐政策 是否提供早餐 2：不提供 1：提供
breakfast_forms	array	N	[10, 20, 30]	早餐形式[10,20,30] 10：单点 20：固定 30：自助
breakfast_types	array	N	[10, 20]	早餐类型：常量：早餐类型列表
breakfast_time_range	array	N	["07:30", "10:00"]	早餐时间范围([hh:mm, hh:mm])
breakfast_time_type	int	N	20	早餐时间类型 10：全天 20：部分时间开放
breakfast_part_time_range	array	N	[7]	部分开放时间范围，常量: 早餐开放范围
check_in_age_policy	int	N	1	办理入住年龄政策 是否限制办理入住年龄 2：不限制 1：限制
check_in_age_range	array	N	[24, 90]	办理入住年龄范围([1,100] []代表不限制)
child_policy	int	N	1	儿童政策 是否允许携带儿童入住 2：不允许 1：允许
child_age_min	int	N	9	儿童政策 最小年龄
child_remark	string	N	"备注"	儿童政策 备注
child_bed_policy	int	N	1	儿童加床政策 是否允许加床 2：不允许 1：允许
pet_policy	int	N	2	宠物政策 是否允许携带宠物入住 2：不允许 1：允许

• 返回示例

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": []
}

12. 更新门店设置

• 接口地址

POST /api/v1/pmsSetting/update

• 请求参数

名称	类型	是否必需	示例	描述
pms_id	int	Y	2	pms-storeID
room_order_box	int	N	1	房间订单盒子 1：开启 2：关闭
order_info_sales	int	N	2	订单信息 - 销售，1为开启，2为关闭
order_info_manager	int	N	2	订单信息 - 管家，1为开启，2为关闭
order_info_channel_number	int	N	2	订单信息 - 渠道订单号，1为开启，2为关闭
dirty_room_not_allowed	int	N	1	脏房不允许办理入住，1为开启，2为关闭
check_out_room_not_allowed	int	N	2	预离房不允许办理入住，1为开启，2为关闭
continuous_stay_set_dirty	int	N	1	连住房自动置为脏房，1为开启，2为关闭
dirty_clean_room_note	int	N	1	脏/净房备注，1为开启，2为关闭
default_check_in_time	string	N	"14:00"	默认入住时间，例如：14:00
default_check_out_time	string	N	"12:00"	默认退房时间，例如：12:00
point_room_night_count	string	N	"0.8"	钟点房统计间夜数，范围：0-10
full_day_late_check_out_time	int	N	120	全日入住延迟退房时间，例如：120
point_screen_late_check_out_time	int	N	30	钟点房延迟退房时间，例如：30
pre_order_advance_room_card	int	N	1	预订单提前制房卡，例如：1
room_participation_indicator	int	N	2	关房参与经营指标统计，1为开启，2为关闭
self_use_room_revenue_statistic	int	N	1	自用房参与营收统计，1为开启，2为关闭
free_room_revenue_statistic	int	N	1	免费房参与营收统计，1为开启，2为关闭
channel_order_auto_arrangement	int	N	1	渠道订单自动排房，1为开启，2为关闭
cross_order_arrangement	int	N	1	多天订单交叉排房，1为开启，2为关闭

• 返回示例

{
    "error_code": 0,
    "description": "success",
    "error_msg": "success",
    "data": []
}