文档中心 > API类目 > 体检机构API

alibaba.alihealth.examination.reserve.state (体检机构对接_体检状态查询)

体检机构对接_体检状态查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
merchant_code String 可选 aikang 商户唯一码
reserve_number String 可选 123 阿里健康预约唯一标识
uniq_reserve_code String 可选 asdf 体检机构预约唯一标识码

响应参数

名称 类型 示例值 描述
message String 取消成功 返回结果描述
cooperation_order_info CooperationOrderInfo 预约信息
  • └ check_no
  • String
  • 1
  • 机构checkNo
  • └ cert_number
  • String
  • 110110200001011234
  • 证件号
  • └ phone
  • String
  • 13912341234
  • 电话号码
  • └ married
  • String
  • 0
  • 婚否(0-未婚; 1-已婚)
  • └ cert_type
  • String
  • 1
  • 证件类型(0-身份证; 1-护照; 2-军官证)
  • └ name
  • String
  • 张三
  • 体检人姓名
  • └ gender
  • String
  • 1
  • 性别(0-男;1-女;)
  • └ check_date
  • String
  • 2016-09-01
  • 体检日期
  • └ reportstatus
  • String
  • exam_done
  • 体检状态:未到检(exam_not), 已到检(exam_done),已取消(exam_cancel)(新增); 上门服务中还需以下两种状态:预约确认中(reserve_confirming),预约拒绝(reserve_rejected);
  • └ uniq_reserve_code
  • String
  • asdf
  • 机构的预约唯一码
  • └ reserve_number
  • String
  • 123
  • 阿里健康预约唯一标识
  • └ cancel_reason
  • String
  • 用户多次联系不上
  • 预约拒绝原因,在预约拒绝后才需赋值(仅上门服务中使用)
response_code String 200 返回结果编码

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthExaminationReserveStateRequest req = new AlibabaAlihealthExaminationReserveStateRequest();
req.setMerchantCode("aikang");
req.setReserveNumber("123");
req.setUniqReserveCode("asdf");
AlibabaAlihealthExaminationReserveStateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_alihealth_examination_reserve_state_response>
    <message>取消成功</message>
    <cooperation_order_info>
        <check_no>1</check_no>
        <cert_number>110110200001011234</cert_number>
        <phone>13912341234</phone>
        <married>0</married>
        <cert_type>1</cert_type>
        <name>张三</name>
        <gender>1</gender>
        <check_date>2016-09-01</check_date>
        <reportstatus>exam_done</reportstatus>
        <uniq_reserve_code>asdf</uniq_reserve_code>
        <reserve_number>123</reserve_number>
        <cancel_reason>用户多次联系不上</cancel_reason>
    </cooperation_order_info>
    <response_code>200</response_code>
</alibaba_alihealth_examination_reserve_state_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案
isv.access_deny 权限异常 直接返回
isv.illegal_args 参数异常 附带异常参数返回
isv.error 未知错误 直接返回

API工具

如何获得此API

FAQ

返回
顶部