[B024] 临床研究描述可以返回哪些数据？

[B024] 临床研究描述：通过临床试验id或者登记号获取临床研究描述。完整响应结构请参见本页的响应结构与成功响应示例。

在哪里可以找到 [B024] 临床研究描述的 OpenAPI schema？

OpenAPI schema 位于 /openapi.json#/paths/~1synapse~1clinical-trial~1description/get，也可在 /openapi.json 浏览完整规范。

[B024] 临床研究描述

Q: [B024] 临床研究描述 的接口地址是什么？

[B024] 临床研究描述 的接口为 GET https://connect.zhihuiya.com/synapse/clinical-trial/description。

get

https://connect.zhihuiya.com/synapse/clinical-trial/description

在体验中心中试用

通过临床试验id或者登记号获取临床研究描述

clinical_trial_id 和 register_number 两个参数必须传一个

请求参数

此 API 接口支持的参数列表

名称	类型	示例	描述
`clinical_trial_id`	`string`	`202425a889e52ae802432a8295220e53`	临床试验id，通过临床试验检索接口获取
`register_number`	`string`	`NCT06498986`	登记号

响应结构

API 响应数据的结构说明

字段名	类型	示例	描述
`data`	`object`	-	响应数据
`country`	`array`	`[ { "country_id": "5a365096-b2a6-31cb-acdf-1de1f5ab3abe", "alpha2_code": "CN", "display_name": [ { "lang": "EN", "name": "China" }, { "lang": "CN", "name": "中国" } ] } ]`	国家/地区
`country_id`	`string`	`676de5ba-893a-36bb-8683-c93306aaf769`	国家地区ID
`alpha2_code`	`string`	`US`	国家编码
`display_name`	`array`	`[ { "lang": "EN", "name": "United States" }, { "lang": "CN", "name": "美国" } ]`	国家地区名称
`lang`	`string`	`EN`	语言
`name`	`string`	`Ranibizumab (Genentech)`	药物、靶点、机构、适应症、国家/地区、字典、作用机制名称
`brief_summary`	`string`	`This phase II clinical study is a study to explore the efficacy and safety of BL-B01D1 in combination with Osimertinib Mesylate Tablets in patients with histologically and/or cytologically confirmed locally advanced or metastatic non-small cell lung cancer.`	简述
`register_number`	`string`	`NCT06498986`	登记号
`clinical_trial_id`	`string`	`202425a889e52ae802432a8295220e53`	临床试验ID
`detailed_description`	`string`	`This phase II clinical study is a study to explore the efficacy and safety of BL-B01D1 in combination with Osimertinib Mesylate Tablets in patients with histologically and/or cytologically confirmed locally advanced or metastatic non-small cell lung cancer.`	详情
`status` 必填	`boolean`	`false`	状态
`error_msg`	`string`	`The request parameter format is incorrect！`	错误信息
`error_code` 必填	`integer`	`0`	错误代码

成功响应示例

成功调用 API 的响应示例

JSON

{
  "data": {
    "country": [
      {
        "country_id": "676de5ba-893a-36bb-8683-c93306aaf769",
        "alpha2_code": "US",
        "display_name": [
          {
            "lang": "EN",
            "name": "Ranibizumab (Genentech)"
          }
        ]
      }
    ],
    "brief_summary": "This phase II clinical study is a study to explore the efficacy and safety of BL-B01D1 in combination with Osimertinib Mesylate Tablets in patients with histologically and/or cytologically confirmed locally advanced or metastatic non-small cell lung cancer.",
    "register_number": "NCT06498986",
    "clinical_trial_id": "202425a889e52ae802432a8295220e53",
    "detailed_description": "This phase II clinical study is a study to explore the efficacy and safety of BL-B01D1 in combination with Osimertinib Mesylate Tablets in patients with histologically and/or cytologically confirmed locally advanced or metastatic non-small cell lung cancer."
  },
  "status": true,
  "error_code": 0
}

错误码

此接口可能返回的错误码列表

业务错误码

错误码	描述
`68300004`	请求参数异常!
`68300005`	查询Api失败!
`68300006`	解析基本存取错误!
`68300007`	存在错误的请求!
`68300008`	服务中断异常，请稍后再试!
`68300010`	文件不符合上传规范!

平台错误码

错误码	描述
`67200001`	API整体限流错误!
`67200002`	用户调用请求限流限制错误!
`67200003`	申请token的key和secret不正确或者状态错误!
`67200004`	无权限或该接口的套餐已超过系统设置的上限!
`67200005`	账户余额不足，调用失败!
`67200006`	客户端已过期，调用失败!
`67200007`	超过调用额度，调用失败!

HTTP 状态码

状态码	描述
`0`	请求成功
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found

性能指标

此接口的预期性能特征

正常响应时间

5000 ms

最大响应时间

10000 ms