文档中心 > API类目 > 阿里健康-疫苗API

alibaba.health.vaccin.appointment.query (预约记录查询)

isv定时拉取其对接的疫苗预约信息

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
param_query_pov_appointment_record_by_date_req QueryPovAppointmentRecordByDateReq 可选 请求参数
  • └ day
  • String
  • 必须
  • 2020-01-18
  • 预约接种日期
  • └ out_pov_id
  • String
  • 必须
  • 00001
  • 外部povId
  • └ page_num
  • Number
  • 可选
  • 1
  • 分页获取数据;第几页,从1开始
  • └ page_size
  • Number
  • 可选
  • 200
  • 分页获取数据;每页返回数据,最大200条

响应参数

名称 类型 示例值 描述
result MtopResult 返回结果对象
  • model
  • QueryPovAppointmentRecordByDateRes
  • 拓展参数
  • └ page_num
  • Number
  • 拓展参数
  • └ page_size
  • Number
  • 拓展参数
  • └ total
  • Number
  • 拓展参数
  • data_list
  • PovAppointmentRecordDto []
  • 预约记录对象
  • └ pick_code
  • String
  • 取号码;单个pov当日预约不重复
  • └ out_pov_id
  • String
  • 外部povId
  • └ pick_status
  • Number
  • 0
  • 取号状态:取号状态,0-是,1-否
  • └ appointment_period
  • String
  • 08:00-08:30
  • 预约时间段: 08:00-08:30
  • └ appointment_time
  • String
  • 2021-01-18
  • 预约天,2021-01-18
  • └ appointment_id
  • String
  • P0001
  • 接种预约Id,全局唯一
  • └ name
  • String
  • 测试
  • 接种人姓名
  • └ msg_code
  • String
  • FAIL_BIZ_500
  • 错误码
  • └ msg_info
  • String
  • 系统繁忙,请稍后重试
  • 错误描述
  • └ success
  • Boolean
  • true
  • 服务接口是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaHealthVaccinAppointmentQueryRequest req = new AlibabaHealthVaccinAppointmentQueryRequest();
AlibabaHealthVaccinAppointmentQueryRequest.QueryPovAppointmentRecordByDateReq obj1 = new AlibabaHealthVaccinAppointmentQueryRequest.QueryPovAppointmentRecordByDateReq();
obj1.setDay("2020-01-18");
obj1.setOutPovId("00001");
obj1.setPageNum(1L);
obj1.setPageSize(200L);
req.setParamQueryPovAppointmentRecordByDateReq(obj1);
AlibabaHealthVaccinAppointmentQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_health_vaccin_appointment_query_response>
    <result>
        <model>
            <page_num></page_num>
            <page_size></page_size>
            <total></total>
            <data_list>
                <pov_appointment_record_dto>
                    <pick_code></pick_code>
                    <out_pov_id></out_pov_id>
                    <pick_status>0</pick_status>
                    <appointment_period>08:00-08:30</appointment_period>
                    <appointment_time>2021-01-18</appointment_time>
                    <appointment_id>P0001</appointment_id>
                    <name>测试</name>
                </pov_appointment_record_dto>
            </data_list>
        </model>
        <msg_code>FAIL_BIZ_500</msg_code>
        <msg_info>系统繁忙,请稍后重试</msg_info>
        <success>true</success>
    </result>
</alibaba_health_vaccin_appointment_query_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>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部