文档中心 > API类目 > 阿里健康挂号号源直连

qimen.alibaba.alihealth.medicalbase.order.sync (挂号订单推送服务商)

挂号订单推送服务商

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
orderId String 必须 40000010170 订单ID
hosCode String 可选 YLYY0000000946 挂号医院标识
hosName String 必须 中山大学附属眼科医院 医院名
deptCode String 可选 24450 科室标识
deptName String 必须 眼科 科室名
doctorCode String 可选 YLYS0000073709 医生标识
doctorName String 必须 张涛医生 医生名
patientsName String 必须 刘海 就诊人姓名
patientsMobile String 必须 1380013800111 就诊人手机号码
patientsGender String 可选 MALE 就诊人性别(MALE、FEMALE、UNKNOWN)
patientsAge String 可选 36 就诊人年龄
cardNo String 可选 32221322122 证件号
cardType String 可选 01 证件类型01身份证,02港澳居民证,03护照,04军人证,05台湾居民来往通行证5001港澳居民来往内地通行证5002出生证明5003驾驶证
appointDate String 必须 2023-08-04 出诊日期(格式:yyyy-mm-dd)
appointStartTime String 可选 16:00 出诊开始时间(格式:mm:dd)
appointEndTime String 可选 16:30 出诊结束时间(格式:mm:dd)
timeType String 可选 pm 类别(上午:am,下午:pm,晚上:em)
orderStatus String 必须 SUCCESS 预约状态(SUCCESS:预约成功,CANCELED:预约取消,FINISH:就诊完成,EVALUATED:已评价,BESPEAK_WAITPAY:挂号成功待支付,BESPEAK_CONFIRM_TIMEOUT:挂号成功确认超时,CANCEL_WAITREFUND:取消成功待退款,FAIL:失败)
orderTime String 必须 1970-01-01 16:30:00 下单时间
orderFee Number 可选 1000.00
  • 默认值:0
  • 费用
    outOrderId String 必须 23232323 第三方订单编号
    outUserId String 必须 3412312432 第三方用户身份标识
    operateType String 必须 INSERT or UPDATE 数据操作类型

    响应参数

    名称 类型 示例值 描述
    success Boolean true 是否成功
    errorCode String INPUT_ERROR 错误码
    errorMessage String 输入错误 错误信息
    data String 现有json字符串 现有json字符串

    请求示例

    {"deptName":"眼科","appointStartTime":"16:00","orderId":"40000010170","cardType":"01","operateType":"INSERT or UPDATE","timeType":"pm","orderStatus":"SUCCESS","orderFee":0,"outUserId":"3412312432","cardNo":"32221322122","appointDate":"2023-08-04","patientsMobile":"1380013800111","patientsName":"刘海","doctorName":"张涛医生","patientsAge":"36","orderTime":"1970-01-01 16:30:00","patientsGender":"MALE","outOrderId":"23232323","doctorCode":"YLYS0000073709","hosName":"中山大学附属眼科医院","deptCode":"24450","appointEndTime":"16:30","hosCode":"YLYY0000000946"}

    响应示例

    {
        "success":true,
        "errorCode":"INPUT_ERROR",
        "errorMessage":"输入错误",
        "data":"现有json字符串"
    }

    验签示例

    {"success":"false","errorMessage":"Illegal request","errorCode":"sign-check-failure"}

    错误码解释

    错误码 错误描述 解决方案
    isp.http-read-timeout

    API工具

    FAQ

    返回
    顶部