接口文档 / 挂号接口

获取挂号详情

GET/api/v2/open-agency/registration/{registrationsSheetId}在线调试

响应参数

名称	说明	类型
Body 参数
`data`可选	数据	`object`
`clinicName`可选	门店名称	`string`
`patientOrderId`可选	就诊单ID	`string`
`registrationSheetId`可选	挂号单ID	`string`
`visitSourceParentId`可选	就诊来源分类上级ID	`string`
`patientId`可选	患者ID	`string`
`visitSourceParentName`可选	就诊来源分类上级名称	`string`
`departmentId`可选	科室ID	`string`
`visitSourceId`可选	就诊来源分类ID	`string`
`departmentName`可选	科室名称	`string`
`visitSourceName`可选	就诊来源分类名称	`string`
`doctorId`可选	医生ID	`string`
`visitSourceFromId`可选	就诊来源分类下具体来源ID，当关联类型为所有员工、员工角色时为员工ID；当关联类型为所有患者时为患者ID；	`string`
`doctorName`可选	医生名称	`string`
`visitSourceFromName`可选	就诊来源分类下具体来源名称，当关联类型为所有员工、员工角色时为员工名称；当关联类型为所有患者时为患者名称；	`string`
`orderNoNum`可选	号数示例：`1`	`integer`
`visitSourceRelatedType`可选	就诊来源关联类型 0:不需要关联 1:所有员工 2:所有患者 3:单个员工 4:单个患者 5:员工角色	`integer`
`orderNo`可选	号数示例：`上午 01号`	`string`
`visitSourceRelatedId`可选	就诊来源关联ID，由 relatedType 确定关联的是什么ID，关联单个患者时是患者ID；关联单个医生时是医生ID；关联的是医生角色时是角色ID；	`string`
`reserveDate`可选	预约就诊日期示例：`2019-04-04`	`string`
`visitSourceRelateName`可选	就诊关联来源关联名称，和 visitSourceRelateId 有关	`string`
`reserveTime`可选	预约具体的时间示例：`10:10～10:30`	`string`
`visitSourceRemark`可选	就诊备注	`string`
`isReserved`可选	是否是预约号 1:是 0:否示例：`1`	`integer`
`registrationProducts`可选	预约项目列表	`array<object>`
`revisitStatus`可选	初复诊状态 1:初诊 2:复诊示例：`1`	`integer`
`status`可选	状态 10：待支付；12：已预约（理疗预约）；20：待签到；21：已签到（理疗预约）；30：待诊；40：已诊；90：已退号；92：已取消示例：`10`	`integer`
`signIn`可选	签到状态 0:无需签到 1:待签到 2:已签到	`integer`
`consultingRoomId`可选	诊室id	`string`
`consultingRoomName`可选	诊室名称	`string`
`type`可选	预约挂号类型 0:pc预约/挂号 2:门诊快速接诊挂号 3:微诊所预约/挂号 4:开放平台预约/挂号示例：`0`	`integer`
`payStatus`可选	支付状态 0:未支付 10:部分支付 20:已支付 30:部分退费 40:已退费	`integer`
`code`可选	取号码	`integer`
`registrationType`可选	预约类型 0:门诊预约 1:理疗预约 10:检查预约示例：`0`	`integer`
`created`可选	创建时间示例：`2022-06-23 18:45:00` 格式：date-time	`string`
`error`可选可为空	通用业务错误包装	`object`

响应示例

json

{
  "data": {
    "clinicName": "string",
    "patientOrderId": "string",
    "registrationSheetId": "string",
    "visitSourceParentId": "string",
    "patientId": "string",
    "visitSourceParentName": "string",
    "departmentId": "string",
    "visitSourceId": "string",
    "departmentName": "string",
    "visitSourceName": "string",
    "doctorId": "string",
    "visitSourceFromId": "string",
    "doctorName": "string",
    "visitSourceFromName": "string",
    "orderNoNum": 1,
    "visitSourceRelatedType": 0,
    "orderNo": "上午 01号",
    "visitSourceRelatedId": "string",
    "reserveDate": "2019-04-04",
    "visitSourceRelateName": "string",
    "reserveTime": "10:10～10:30",
    "visitSourceRemark": "string",
    "isReserved": 1,
    "registrationProducts": [
      {
        "id": "ffffffff000000000000000000000001",
        "name": "针灸"
      }
    ],
    "revisitStatus": 1,
    "status": 10,
    "signIn": 0,
    "consultingRoomId": "string",
    "consultingRoomName": "string",
    "type": 0,
    "payStatus": 0,
    "code": 0,
    "registrationType": 0,
    "created": "2022-06-23 18:45:00"
  },
  "error": null
}

业务失败包装示意

json

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

查看 HTTP 状态与业务码排查