接口文档 / 挂号接口

创建挂号

只有开启了预约升级的门店才能进行理疗预约

POST/api/v2/open-agency/registration在线调试

请求参数

名称	说明	类型
Body 参数
`reserveMustPay`可选	是否必须支付.默认0(0:非必需支付 1:必须支付) 示例：`0`	`integer`
`patientId`必填	患者ID	`string`
`departmentId`可选	科室ID，门诊预约时必传	`string`
`doctorId`必填	医生ID	`string`
`orderNo`可选	号数，门诊预约必填	`integer`
`reserveDate`必填	预约日期 yyyy-MM-dd	`string`
`reserveStart`必填	预约号源开始时间, HH:mm	`string`
`reserveEnd`必填	预约号源结束时间, HH:mm	`string`
`sourceId`可选	就诊来源分类ID 示例：`医生推荐分类ID, 导医推荐分类ID, 顾客推荐分类ID`	`string`
`sourceFromId`可选	就诊来源分类下某个具体来源ID。比如：当就诊来源分类为【医生推荐】时，根据api【5.2.2. 获取医生分页列表信息】获取到医生，此时字段取值为医生ID；当就诊来源分类为【导医推荐】时, 根据api【5.1.3. 获取门店成员列表】获取到成员，此时字段取值为成员ID；当就诊来源分类为【顾客推荐】时, 根据api【5.4.3. 获取患者列表】获取到患者，此时字段取值为患者ID；	`string`
`sourceRemark`可选	就诊备注	`string`
`registrationType`可选	预约类型 0:门诊预约 1:理疗预约，默认为门诊预约示例：`0`	`integer`
`registrationProductIds`可选	预约项目列表，仅在理疗预约时有效	`array<integer>`

请求示例

json

{
  "reserveMustPay": 0,
  "patientId": "string",
  "departmentId": "string",
  "doctorId": "string",
  "orderNo": 0,
  "reserveDate": "string",
  "reserveStart": "string",
  "reserveEnd": "string",
  "sourceId": "医生推荐分类ID, 导医推荐分类ID, 顾客推荐分类ID",
  "sourceFromId": "string",
  "sourceRemark": "string",
  "registrationType": 0,
  "registrationProductIds": [
    0
  ]
}

响应参数

名称	说明	类型
Body 参数
`data`可选	数据	`object`
`registrationSheetId`必填	挂号单ID	`string`
`chargeSheetId`可选	收费单ID 示例：`ffffffff00000000220e67a8116d8000`	`string`
`patientOrderId`必填	就诊单ID	`string`
`error`可选可为空	通用业务错误包装	`object`

响应示例

json

{
  "data": {
    "registrationSheetId": "string",
    "chargeSheetId": "ffffffff00000000220e67a8116d8000",
    "patientOrderId": "string"
  },
  "error": null
}

业务失败包装示意

json

{
  "data": null,
  "error": {
    "code": 11003,
    "message": "不支持的授权类型{grantType}"
  }
}

查看 HTTP 状态与业务码排查