/ictrp/trials

POST /api/ictrp/trials

Price: 10 credits

One trial record from the WHO ICTRP meta-registry, normalised to the WHO Trial Registration Data Set: the source register and its own record URL, public and scientific titles, sponsors and funding sources, recruitment status, study type, design, phase and target size, countries of recruitment, health conditions, interventions, primary and secondary outcomes with their time frames, inclusion and exclusion criteria with the age and sex limits, cross-registration ids, contacts, ethics reviews, and the result availability the source register reports.

How to use it

ICTRP republishes what a member register submitted, so this is a summary of a trial rather than the trial's own record: around thirty fields, no result tables and no document list. `source_url` is the link back to the register that owns it, and `secondary_ids` is where the same trial's other registry numbers appear. An id the portal does not know answers 412 rather than an empty record, because a miss is served as a complete page with every heading and no values. Ids keep their register's own form — NCT01234567, ACTRN12620000762954, EUCTR2021-000546-17-DE — and are passed through unchanged.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• trial string required — ICTRP trial id as the portal shows it, or a portal URL containing one (examples: "NCT04481204", "EUCTR2021-000546-17-DE", "https://trialsearch.who.int/Trial2.aspx?TrialID=ACTRN12620000762954"; minLength: 1)

Response

• @type string (default: "IctrpTrial")
• id string required
• url string (default: "")
• source_register string (default: "")
• source_url string nullable
• public_title string (default: "")
• scientific_title string nullable
• acronym string nullable
• is_prospectively_registered boolean nullable
• registration_date string nullable
• enrollment_date string nullable
• last_updated string nullable
• primary_sponsor string nullable
• secondary_sponsors array (default: [])
• funding_sources array (default: [])
• recruitment_status string nullable
• study_type string nullable
• study_design string nullable
• allocation string nullable
• assignment string nullable
• phase string nullable
• target_size string nullable
• countries array (default: [])
• conditions array (default: [])
• interventions array (default: [])
• primary_outcomes array (default: [])
  • @type string (default: "IctrpOutcome")
  • name string (default: "")
  • time_frame string nullable
• secondary_outcomes array (default: [])
  • @type string (default: "IctrpOutcome")
  • name string (default: "")
  • time_frame string nullable
• inclusion_criteria string nullable
• exclusion_criteria string nullable
• age_minimum string nullable
• age_maximum string nullable
• sex string nullable
• secondary_ids array (default: [])
• contacts array (default: [])
  • @type string (default: "IctrpContact")
  • contact_type string nullable
  • first_name string nullable
  • middle_name string nullable
  • last_name string nullable
  • affiliation string nullable
  • address string nullable
  • postcode string nullable
  • city string nullable
  • country string nullable
  • phone string nullable
  • email string nullable
• ethics_reviews array (default: [])
  • @type string (default: "IctrpEthicsReview")
  • status string nullable
  • approval_date string nullable
  • contact_name string nullable
  • contact_address string nullable
  • contact_phone string nullable
  • contact_email string nullable
• has_results boolean nullable
• results_url string nullable
• results_protocol_url string nullable
• results_date_posted string nullable
• results_date_completed string nullable
• results_first_publication_date string nullable
• results_summary string nullable
• results_baseline_characteristics string nullable
• results_adverse_events string nullable
• results_outcome_measures string nullable
• ipd_sharing_plan string nullable
• ipd_sharing_description string nullable

Errors

• 422 — The input contained no trial id. Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The ICTRP portal holds no trial with that id. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.