What is the endpoint for [B024] Clinical trial description?

The [B024] Clinical trial description endpoint is GET https://connect.patsnap.com/synapse/clinical-trial/description.

What data can [B024] Clinical trial description return?

[B024] Clinical trial description Obtain clinical trial description through clinical trial id or registry number. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for [B024] Clinical trial description?

The OpenAPI schema is available at /openapi.json#/paths/~1synapse~1clinical-trial~1description/get. You can also browse the full specification at /openapi.json.

[B024] Clinical trial description

get

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

Try in Sandbox

Obtain clinical trial description through clinical trial id or registry number

One of the parameters clinical_trial_id and register_number must be passed

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`clinical_trial_id`	`string`	`202425a889e52ae802432a8295220e53`	Clinical trial id, obtain this through clinical trial search interface
`register_number`	`string`	`NCT06498986`	register number

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`country`	`array`	`[ { "country_id": "5a365096-b2a6-31cb-acdf-1de1f5ab3abe", "alpha2_code": "CN", "display_name": [ { "lang": "EN", "name": "China" }, { "lang": "CN", "name": "中国" } ] } ]`	Country/Location
`country_id`	`string`	`676de5ba-893a-36bb-8683-c93306aaf769`	Country/Location ID
`alpha2_code`	`string`	`US`	Alpha Code
`display_name`	`array`	`[ { "lang": "EN", "name": "United States" }, { "lang": "CN", "name": "美国" } ]`	Country/Location Name
`lang`	`string`	`EN`	Language
`name`	`string`	`Ranibizumab (Genentech)`	Drug,Target,Organization,Disease,Country/Location,DICT,Mechanism Action Name
`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.`	Brief
`register_number`	`string`	`NCT06498986`	Trial Number
`clinical_trial_id`	`string`	`202425a889e52ae802432a8295220e53`	Clinical Trial 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.`	Detailed
`status` Required	`boolean`	`false`	Status
`error_msg`	`string`	`The request parameter format is incorrect！`	Error Message
`error_code` Required	`integer`	`0`	Error Code

Success Response Example

Example of a successful API response

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
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

Error Code	Description
`68300004`	Invalid parameter!
`68300005`	Search api failure!
`68300006`	Analytic basic access error!
`68300007`	Bad request!
`68300008`	Service error, please try again later!
`68300010`	The file does not comply with upload specifications!

Platform Errors

Error Code	Description
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	Quota exceeds the limit!
`67200003`	Access token expired or authentication error!
`67200004`	No permission or API package quota has exceeded the limit!
`67200005`	Insufficient balance, call failed!
`67200006`	This client has expired and call failed!
`67200007`	Exceeded the call limit, call failed!

HTTP Status Codes

Status Code	Description
`0`	Success
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found