预约挂号相关接口
此页面包含了预约挂号相关的接口,包括科室主列表、科室子列表、科室挂号时段信息、科室挂号医生信息,确认预约挂号。
科室主列表
接口信息
- 接口名称: 挂号科室左侧主列表
- 请求方式:
POST - 请求地址:
/registration-list - 接口描述: 获取挂号科室左侧主列表
- 认证要求: 需要
请求参数
无
请求示例
json
{}返回参数
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| depId | string | 科室ID | "1" |
| depName | string | 科室名称 | "妇科门诊" |
返回示例
json
{
"errcode":0,
"msg":"",
"rcursor":[
{
"depId": "1",
"depName": "妇科门诊"
},
{
"depId": "2",
"depName": "产科门诊"
}
]
}科室子列表
接口信息
- 接口名称: 挂号科室右侧子列表
- 请求方式:
POST - 请求地址:
/registration-sublist - 接口描述: 获取挂号科室右侧子列表
- 认证要求: 需要
请求参数
| 参数名 | 类型 | 必填 | 限制 | 说明 | 示例 |
|---|---|---|---|---|---|
| depId | string | 是 | - | 科室ID | "1" |
请求示例
json
{
"depId": "1"
}返回参数
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| depId | string | 科室ID | "3" |
| depName | string | 科室名称 | "妇科普通门诊" |
返回示例
json
{
"errcode":0,
"msg":"",
"rcursor":[
{
"depId": "3",
"depName": "妇科普通门诊"
},
{
"depId": "4",
"depName": "妇科专家门诊"
}
]
}科室挂号时段信息
接口信息
- 接口名称: 挂号科室挂号时段信息
- 请求方式:
POST - 请求地址:
/registration-schedule - 接口描述: 获取挂号科室挂号时段信息
- 认证要求: 需要
请求参数
| 参数名 | 类型 | 必填 | 限制 | 说明 | 示例 |
|---|---|---|---|---|---|
| depId | string | 是 | - | 科室ID | "1" |
请求示例
json
{
"depId": "1"
}返回参数
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| title | string | 星期 | "周一" |
| date | string | 日期 | "2025-01-15" |
| state | string | 状态 | "满号 | 有号" |
返回示例
json
{
"errcode":0,
"msg":"",
"rcursor":[
{
"title": "周一",
"date": "2025-01-15",
"state": "满号"
},
{
"title": "周二",
"date": "2025-01-16",
"state": "有号"
}
]
}科室挂号医生信息
接口信息
- 接口名称: 挂号科室挂号医生信息
- 请求方式:
POST - 请求地址:
/registration-doctor - 接口描述: 根据挂号时段获取挂号科室挂号医生信息
- 认证要求: 需要
请求参数
| 参数名 | 类型 | 必填 | 限制 | 说明 | 示例 |
|---|---|---|---|---|---|
| date | string | 是 | - | 日期 | "2025-01-15" |
请求示例
json
{
"date": "2025-01-15"
}返回参数
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| name | string | 医生名称 | "张三" |
| doctorId | string | 医生ID | "1" |
| desc | string | 医生描述 | "主任医师" |
| source | Array | 医生号源 | "具体参数参见下表" |
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| time | string | 挂号时段 | "上午 | 下午" |
| type | string | 挂号类型 | "普通号" |
| price | number | 挂号价格 | 100 |
| num | number | 号源剩余数量 | 10 |
返回示例
json
{
"errcode":0,
"msg":"",
"rcursor":[
{
"name": "张三",
"doctorId": "1",
"desc": "主任医师",
"source": [
{
"time": "上午",
"source": "1",
"type": "普通号",
"price": 100,
"num": 10
},
{
"time": "下午",
"type": "专家号",
"price": 200,
"num": 5
}
]
},
]
}医生挂号详细时段信息
接口信息
- 接口名称: 挂号科室挂号医生挂号详细时段信息
- 请求方式:
POST - 请求地址:
/registration-doctor-schedule - 接口描述: 根据挂号医生分区时区获取挂号详细时段信息
- 认证要求: 需要
请求参数
| 参数名 | 类型 | 必填 | 限制 | 说明 | 示例 |
|---|---|---|---|---|---|
| depId | string | 是 | - | 科室ID | "1" |
| date | string | 是 | - | 日期 | "2025-01-15" |
| doctorId | string | 是 | - | 医生ID | "1" |
| query | string | 是 | - | 挂号时段 | "上午 | 下午" |
请求示例
json
{
"query": "上午"
}返回参数
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| time | string | 挂号时段 | "具体时段:13:00 - 13:30" |
| state | string | 状态 | "满号 | 有号" |
返回示例
json
{
"errcode":0,
"msg":"",
"rcursor":[
{
"time": "13:00 - 13:30",
"state": "有号",
},
]
}确认预约挂号
接口信息
- 接口名称: 确认预约挂号
- 请求方式:
POST - 请求地址:
/registration-confirm - 接口描述: 确认预约挂号
- 认证要求: 需要
请求参数
| 参数名 | 类型 | 必填 | 限制 | 说明 | 示例 |
|---|---|---|---|---|---|
| depId | string | 是 | - | 科室ID | "1" |
| doctorId | string | 是 | - | 医生ID | "1" |
| patientId | string | 是 | - | 就诊人ID | "1" |
| date | string | 是 | - | 挂号日期 | "2025-01-15" |
| time | string | 是 | - | 挂号时段 | "13:00 - 13:30" |
| price | number | 是 | - | 挂号费用 | 100 |
请求示例
json
{
"depId": "1",
"doctorId": "1",
"patientId": "1",
"date": "2025-01-15",
"time": "13:00 - 13:30",
"price": 100
}返回参数
| 参数名 | 类型 | 说明 | 示例 |
|---|---|---|---|
| time | string | 挂号时段 | "13:00 - 13:30" |
| status | string | 状态 | "挂号成功 | 挂号失败" |
返回示例
json
{
"errcode":0,
"msg":"",
"rcursor":[
{
"time": "13:00 - 13:30",
"status": "挂号成功"
},
]
}