中州养老接口文档 V1.0

YangeIT大约 11 分钟

中州养老接口文档 V1.0

一、预约模块接口

1.1 预约列表分页查询

1.1.1 基本信息

请求路径：/customer/reservation/page

请求方式：GET

接口描述：该接口用于分页查询当前用户的预约信息

1.1.2 请求参数

请求参数格式: queryString

请求参数说明:

参数名称说明类型是否必须备注
userId当前家属端用户IDnumber是
status预约状态(0--待报到，1--已完成，2--取消，3--过期)number否
pageNum当前页码number是
pageSize每页条数number是

请求参数样例:

/customer/reservation/page?userId=1&pageSize=10&pageNum=1&status=0
1.1.3 响应数据

响应数据类型: application/json

响应数据说明:

名称类型是否必须默认值备注其他信息
codenumber必须响应码, 200-成功,500-服务器错误
msgstring非必须提示信息
dataobject必须返回的业务数据
|-totalnumber是总条数
|-pageSizenumber是每页显示条数
|-pagesnumber是总页码
|-pagenumber是当前页码
|-recordsarray是当前页数据

响应数据样例:

{
    "code":200,
    "msg":"操作成功",
    "data":{
        "total":5,
        "pageSize":10,
        "pages":1,
        "page":1,
        "records":[
            {
                "id":298,
                "name":"王五",
                "mobile":"18133332222",
                "time":"2024-02-20 10:00:00",
                "visitor":"王五爸",
                "type":0,
                "status":3,
                "createTime":"2024-02-20T09:53:48",
                "updateTime":null,
                "createBy":1,
                "updateBy":null,
                "remark":null
            },
            {
                "id":297,
                "name":"李四",
                "mobile":"18855556666",
                "time":"2024-02-19 11:30:00",
                "visitor":"李四爸",
                "type":0,
                "status":3,
                "createTime":"2024-02-19T11:05:58",
                "updateTime":null,
                "createBy":1,
                "updateBy":null,
                "remark":null
            },
            {
                "id":296,
                "name":"张三",
                "mobile":"18188889999",
                "time":"2024-02-19 12:00:00",
                "visitor":"张三爸",
                "type":0,
                "status":2,
                "createTime":"2024-02-19T11:04:13",
                "updateTime":null,
                "createBy":1,
                "updateBy":null,
                "remark":null
            },
            {
                "id":295,
                "name":"sdf",
                "mobile":"13567890009",
                "time":"2024-02-03 15:00:00",
                "visitor":"1322",
                "type":0,
                "status":2,
                "createTime":"2024-02-03T14:38:07",
                "updateTime":null,
                "createBy":1,
                "updateBy":null,
                "remark":null
            },
            {
                "id":294,
                "name":"132",
                "mobile":"13212345678",
                "time":"2024-02-03 15:00:00",
                "visitor":"12334",
                "type":0,
                "status":2,
                "createTime":"2024-02-03T14:36:00",
                "updateTime":null,
                "createBy":1,
                "updateBy":null,
                "remark":null
            }
        ]
    }
}

1.2 新增预约

1.2.1 基本信息

请求路径：/customer/reservation

请求方式：POST

接口描述：该接口用于新增预约

1.2.2 请求参数

请求参数格式：application/json

请求参数说明：

参数名称说明类型是否必须备注
name预约人姓名string是
mobile预约人手机号string是
visitor家人姓名string是
time预约日期(yyyy-MM-dd hh:mm:ss)string是
userId当前家属端用户IDnumber是
type预约类型(0--参观预约, 1--探访预约)number是

请求数据样例:

{
    "name":"王五",
    "mobile":"18133332222",
    "visitor":"王五爸",
    "type":0,
    "time":"2024-02-20 10:00:00",
    "userId":1
}
1.2.3 响应数据

响应数据类型: application/json

响应数据说明:

名称类型是否必须默认值备注其他信息
codenumber必须响应码, 200-成功,500-服务器错误
msgstring非必须提示信息
datastring必须返回的业务数据

响应数据样例:

{
    "code":200,
    "msg":"操作成功",
    "data":null
}

1.3 取消预约

1.3.1 基本信息

请求路径：/customer/reservation/预约Id/cancel

请求方式：PUT

接口描述：该接口用于取消已有的预约

1.3.2 请求参数

请求参数格式：queryString+pathVariable

请求参数说明：

参数名称说明类型是否必须备注
id要取消的预约Idnumber是该参数是路径参数,请参照请求路径
userId当前家属端用户IDnumber是该参数是常规的查询在数, 携带到url后

请求数据样例:

/customer/reservation/300/cancel?userId=1
1.3.3 响应数据

响应数据类型: application/json

响应数据说明:

名称类型是否必须默认值备注其他信息
codenumber必须响应码, 200-成功,500-服务器错误
msgstring非必须提示信息
datastring必须返回的业务数据

响应数据样例:

{
    "code":200,
    "msg":"操作成功",
    "data":null
}

二、房型相关接口

2.1 查询所有房型接口

2.1.1 基本信息

请求路径：/customer/roomTypes

请求方式：GET

接口描述：该接口用于查询所有的房型

2.2.2 请求参数

请求参数格式：queryString

请求参数说明：

参数名称说明类型是否必须备注
status房型状态(0--禁用，1--启用)number是

请求数据样例:

/customer/roomTypes?status=1
2.2.3 响应数据

响应数据类型: application/json

响应数据说明:

名称类型是否必须默认值备注其他信息
codenumber必须响应码, 200-成功,500-服务器错误
msgstring非必须提示信息
dataarray必须返回的业务数据
|-idnumber是房间ID
|-namestring是房间名称
|-bedCountnumber是床位数量
|-pricenumber是床位费用
|-introductionstring是房型介绍
|-photostring是房型照片
|-typeNamestring是类型名称
|-statusnumber是房型状态(0--禁用，1--启用)
|-createTimestring是创建时间
|-updateTimestring是更新时间
|-createBynumber是创建人ID
|-updateBynumber是修改人ID
|-remarkstring是备注

响应数据样例:

{
    "code":200,
    "msg":"操作成功",
    "data":[
        {
            "id":112,
            "name":"单人套房",
            "bedCount":0,
            "price":4000.00,
            "introduction":"宽敞舒适的套房，配备独立卫生间和基本生活设施，满足独自居住的需求，提供私密性和舒适度",
            "photo":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/96022947-eed2-4f61-9a47-cead16268a4a.png",
            "typeName":null,
            "status":1,
            "createTime":"2023-12-28T15:54:31",
            "updateTime":"2023-12-28T15:54:31",
            "createBy":1671403256519078239,
            "updateBy":null,
            "remark":null
        },
        {
            "id":113,
            "name":"双人套房",
            "bedCount":0,
            "price":6000.00,
            "introduction":"适合夫妻或朋友两人居住的套房，设有独立卫生间和基本生活设施，提供共享空间和私密性",
            "photo":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/b2b3b270-c6f5-428a-a3d3-062a464a0cdf.png",
            "typeName":null,
            "status":1,
            "createTime":"2023-12-28T15:55:30",
            "updateTime":"2023-12-28T15:55:30",
            "createBy":1671403256519078239,
            "updateBy":null,
            "remark":null
        },
        {
            "id":114,
            "name":"豪华单人间",
            "bedCount":0,
            "price":3000.00,
            "introduction":"豪华装修的单人房间，提供舒适的居住环境和高品质的服务，设计精美，配备独立卫生间和必需设施",
            "photo":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/7a99e431-88c6-415e-91ee-d4fca75a3aad.png",
            "typeName":null,
            "status":1,
            "createTime":"2023-12-28T15:56:25",
            "updateTime":"2023-12-28T15:56:25",
            "createBy":1671403256519078239,
            "updateBy":null,
            "remark":null
        },
        {
            "id":115,
            "name":"豪华双人间",
            "bedCount":0,
            "price":4500.00,
            "introduction":"精心装修的双人房间，提供舒适和豪华的居住环境，配备独立卫生间和高品质的家具",
            "photo":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/f5246b64-a458-485c-90a4-83c9e1545b1f.png",
            "typeName":null,
            "status":1,
            "createTime":"2023-12-28T15:57:10",
            "updateTime":"2023-12-28T15:57:10",
            "createBy":1671403256519078239,
            "updateBy":null,
            "remark":null
        },
        {
            "id":116,
            "name":"普通单人间",
            "bedCount":0,
            "price":2000.00,
            "introduction":"简洁实用的单人房间，提供基本的居住设施和舒适度，适合独自居住的老年人，提供相对经济实惠的居住选择",
            "photo":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/4e23e7cb-bbf2-4610-8023-cda4393eb228.png",
            "typeName":null,
            "status":1,
            "createTime":"2023-12-28T15:58:02",
            "updateTime":"2023-12-28T15:58:02",
            "createBy":1671403256519078239,
            "updateBy":null,
            "remark":null
        },
        {
            "id":117,
            "name":"普通双人间",
            "bedCount":0,
            "price":3500.00,
            "introduction":"标准的双人房间，提供基本的舒适居住环境。配备共用卫生间和必要的家具",
            "photo":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/a9c06a37-14d7-44db-8baa-b76ec51f10e4.png",
            "typeName":null,
            "status":1,
            "createTime":"2023-12-28T16:03:11",
            "updateTime":"2023-12-28T16:07:39",
            "createBy":1671403256519078239,
            "updateBy":1671403256519078239,
            "remark":null
        },
        {
            "id":118,
            "name":"特护房",
            "bedCount":0,
            "price":8000.00,
            "introduction":"专为特殊护理需求设计的房间，配备个性化护理设施和服务，提供特别关注、监测和护理",
            "photo":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/8102c6cf-3010-4994-a808-d3b79a7451df.png",
            "typeName":null,
            "status":1,
            "createTime":"2023-12-28T16:08:12",
            "updateTime":"2023-12-28T16:08:12",
            "createBy":1671403256519078239,
            "updateBy":null,
            "remark":null
        }
    ]
}

三、护理服务相关接口

3.1 分页查询护理服务列表

3.1.1 基本信息

请求路径：/customer/orders/project/page

请求方式：GET

接口描述：该接口用于分页查询护理服务

3.1.2 请求参数

请求参数格式：queryString

请求参数说明：

参数名称说明类型是否必须备注
pageNum当前页码number是
pageSize每页条数number是
userId当前家属端用户IDnumber是

请求数据样例:

/customer/orders/project/page?userId=1&pageNum=1&pageSize=10
3.1.3 响应数据

响应数据类型: application/json

响应数据说明:

名称类型是否必须默认值备注其他信息
codenumber必须响应码, 200-成功,500-服务器错误
msgstring非必须提示信息
dataobject必须返回的业务数据
|-totalnumber是总条数
|-pageSizenumber是每页显示条数
|-pagesnumber是总页码
|-pagenumber是当前页码
|-recordsarray是当前页数据

响应数据样例:

{
    "code":200,
    "msg":"操作成功",
    "data":{
        "total":12,
        "pageSize":10,
        "pages":2,
        "page":1,
        "records":[
        {
            "id":91,
            "name":"修剪指甲",
            "orderNo":1,
            "unit":"次",
            "price":10.00,
            "image":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/82a2053b-5e1d-4514-92e9-aa1383b0d601.jpg",
            "nursingRequirement":"为患者修剪手指和脚趾的指甲，以保持个人卫生和舒适感",
            "status":1,
            "createTime":"2023-12-28T17:15:12",
            "updateTime":"2023-12-28T17:15:12",
            "createBy":1671403256519078239,
            "updateBy":null,
            "remark":null
        },
        {
            "id":89,
            "name":"洗头",
            "orderNo":1,
            "unit":"次",
            "price":20.00,
            "image":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/f65a2979-4d50-4c3d-8962-c76bef061a9c.jpg",
            "nursingRequirement":"将患者带到洗发间进行洗发，并提供按摩和护理，保持头皮健康",
            "status":1,
            "createTime":"2023-12-28T17:14:32",
            "updateTime":"2023-12-28T17:14:32",
            "createBy":1671403256519078239,
            "updateBy":null,
            "remark":null
        },
        {
            "id":87,
            "name":"助浴",
            "orderNo":1,
            "unit":"次",
            "price":40.00,
            "image":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/c98f1d47-9d9c-4177-a27d-ce53bbe7382d.jpg",
            "nursingRequirement":"协助患者进行浴室洗浴，包括保证个人隐私、洗澡和擦干身体等过程",
            "status":1,
            "createTime":"2023-12-28T17:13:43",
            "updateTime":"2023-12-28T17:13:43",
            "createBy":1671403256519078239,
            "updateBy":null,
            "remark":null
        },
        {
            "id":80,
            "name":"翻身拍背",
            "orderNo":1,
            "unit":"次",
            "price":30.00,
            "image":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/0e53b016-4b6e-4b4c-b545-b81cdd185d3e.jpg",
            "nursingRequirement":"帮助患者翻身，并进行背部按摩，以促进血液循环",
            "status":1,
            "createTime":"2023-12-28T17:08:36",
            "updateTime":"2023-12-28T17:08:36",
            "createBy":1671403256519078239,
            "updateBy":null,
            "remark":null
        },
        {
            "id":81,
            "name":"复健运动",
            "orderNo":2,
            "unit":"次",
            "price":50.00,
            "image":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/0843add9-8519-4189-88f9-2dc41b3793e5.jpg",
            "nursingRequirement":"根据患者的需要，执行定制的康复运动计划，旨在改善身体机能和增强肌肉力量",
            "status":1,
            "createTime":"2023-12-28T17:10:17",
            "updateTime":"2023-12-28T17:10:17",
            "createBy":1671403256519078239,
            "updateBy":null,
            "remark":null
        },
        {
            "id":82,
            "name":"公共空间清",
            "orderNo":3,
            "unit":"小时",
            "price":20.00,
            "image":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/00f9799d-3220-4a75-8c77-fbd0504039cd.jpg",
            "nursingRequirement":"对养老院公共区域进行定期清洁和消毒，包括走廊、客厅和就餐区等",
            "status":1,
            "createTime":"2023-12-28T17:11:02",
            "updateTime":"2023-12-28T17:11:02",
            "createBy":1671403256519078239,
            "updateBy":null,
            "remark":null
        },
        {
            "id":84,
            "name":"洗脚",
            "orderNo":4,
            "unit":"次",
            "price":0.01,
            "image":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/f1a35fca-f5a4-4c93-9a5e-bbaed9080655.jpg",
            "nursingRequirement":"为患者提供舒适的足部护理，包括泡脚、按摩和修剪脚指甲等",
            "status":1,
            "createTime":"2023-12-28T17:12:21",
            "updateTime":"2023-12-28T18:09:00",
            "createBy":1671403256519078239,
            "updateBy":1671403256519078138,
            "remark":null
        },
        {
            "id":86,
            "name":"洗脸",
            "orderNo":5,
            "unit":"次",
            "price":15.00,
            "image":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/6e068eb5-2916-4c7e-bf5d-c157122d78f4.jpg",
            "nursingRequirement":"为患者提供温和而舒适的洗脸服务，以保持面部卫生和清洁",
            "status":1,
            "createTime":"2023-12-28T17:12:52",
            "updateTime":"2023-12-28T17:13:18",
            "createBy":1671403256519078239,
            "updateBy":1671403256519078239,
            "remark":null
        },
        {
            "id":83,
            "name":"心理咨询",
            "orderNo":6,
            "unit":"小时",
            "price":20.00,
            "image":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/5b411f7b-628e-4ccb-a13f-ff1ac05e4a58.jpg",
            "nursingRequirement":"提供专业的心理咨询服务，帮助患者处理情绪问题、调解矛盾和提供心理支持",
            "status":1,
            "createTime":"2023-12-28T17:11:39",
            "updateTime":"2023-12-28T17:13:23",
            "createBy":1671403256519078239,
            "updateBy":1671403256519078239,
            "remark":null
        },
        {
            "id":90,
            "name":"衣物清洁",
            "orderNo":9,
            "unit":"件",
            "price":5.00,
            "image":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/5ea53c25-b855-486f-98e3-f26febb9db68.jpg",
            "nursingRequirement":"提供患者衣物的清洗、熨烫和折叠等服务，确保他们穿着整洁干净的衣物",
            "status":1,
            "createTime":"2023-12-28T17:15:06",
            "updateTime":"2023-12-28T17:15:06",
            "createBy":1671403256519078239,
            "updateBy":null,
            "remark":null
            }
        ]
    }
}

3.2 护理服务详情查询

3.2.1 基本信息

请求路径：/customer/orders/project/护理服务ID

请求方式：GET

接口描述：该接口用于分页查询护理服务的详细信息

3.2.2 请求参数

请求参数格式：queryString+pathVariable

请求参数说明：

参数名称说明类型是否必须备注
id要查询的护理服务的idnumber是该参数是路径参数,请参照请求路径

请求数据样例:

/customer/orders/project/91
3.2.3 响应数据

响应数据类型: application/json

响应数据说明:

名称类型是否必须默认值备注
codenumber必须响应码, 200-成功,500-服务器错误
msgstring非必须提示信息
dataobject必须返回的业务数据
|-namenumber是护理项目名称
|-orderNonumber是护理项目排序值
|-unitnumber是单位
|-pricenumber是当前页码
|-imagearray是当前页数据
|-nursingRequirementstring是护理要求
|-statusnumber是状态: 0--禁用，1--启用
|-countnumber是护理次数

响应数据样例:

{
    "code":200,
    "msg":"操作成功",
    "data":{
        "name":"修剪指甲",
        "orderNo":1,
        "unit":"次",
        "price":10.00,
        "image":"https://yjy-slwl-oss.oss-cn-hangzhou.aliyuncs.com/82a2053b-5e1d-4514-92e9-aa1383b0d601.jpg",
        "nursingRequirement":"为患者修剪手指和脚趾的指甲，以保持个人卫生和舒适感",
        "status":1,
        "count":null
    }
}
焱哥的博客
Copyright © 2025 YangeIT