|
Inside the NIH Firewall (VPN required)
Outside of the NIH Firewall |
To use the service, you must have a valid NCI LDAP account and a Creating New NCI CTRP User Accounts. All service endpoints require HTTP Basic authentication with your NCI LDAP username and password. |
The service uses XML for data exchange. All XML elements going in or out of the service are defined and validated against the following XML schemas: XML schemas are well-annotated with inline documentation that explains the purpose and meaning of various elements, types, and attributes. Specific elements required for service operations are explained in the sections below. |
Registering or amending Complete trials in the CTRP involves organizations and persons that have the following roles in clinical trials: lead organization, sponsor, principal investigator, and so on. CTRP does not manage information about persons and organizations; instead, this is delegated to the Person and Organization Curation Portal, also known as PO. See the Person and Organization Curation Portal User's Guide for more information.
Before registering a trial, ensure that organizations and persons acting on the trial exist already in PO. Use person identifiers (PO IDs) and organization identifiers (CTEP IDs) when you register a trial whenever possible. If they do not already exist, request that they be created prior to trial registration, by submitting a request to the CTRO at ncictro@mail.nih.gov.
|
Register an Abbreviated trial in CTRP by pulling trial data from ClinicalTrials.gov using a ClinicalTrials.gov Trial Identifier.
HTTP Method | POST |
---|---|
URL | /trials/abbreviated/{nct} Parameters {nct}. ClinicalTrials.gov Trial Identifier |
Request Body | Empty |
Response Body | XML document withTrialRegistrationConfirmation
MIME Type: |
HTTP Response Code | 200. Success 400. Validation error 401. Invalid username/password or insufficient permissions to access the service. 412. A trial with the given identifier already exists 500. Internal server error |
Examples |
Request to update an Abbreviated trial in CTRP.
HTTP Method | POST |
---|---|
URL | /trials/abbreviated/{idType}/{trialID} Parameters {idType}. Type of identifier you want to use to identify a trial in CTRP. Possible values: pa, nci, ctep. {trialID}. Trial identifier value itself. |
Request Body | XML document withAbbreviatedTrialUpdate MIME Type: |
Response Body | XML document withTrialRegistrationConfirmation MIME Type: |
HTTP Response Code | 200. Success 400. Validation error (including the condition when you are not allowed to update a particular trial) 401. Invalid username/password or insufficient permissions to access the service. 404. One of the Persons/Organizations acting on the trial was not found in PO 500. Internal server error |
Examples |
Request to register a Complete trial in CTRP.
HTTP Method | POST | ||||||
---|---|---|---|---|---|---|---|
URL | /trials/complete | ||||||
Request Body | XML document withCompleteTrialRegistration MIME Type: |
||||||
Response Body | XML document withTrialRegistrationConfirmation MIME Type: application/xml . |
||||||
HTTP Response Code | 200. Success 400. Validation error 401. Invalid username/password or insufficient permissions to access the service. 404. One of the Persons/Organizations acting on the trial was not found in PO 500. Internal server error |
||||||
Examples |
URL: https://trials.nci.nih.gov/services/trials/complete Request (referring to existing Organizations and Persons by ID): Request (non-interventional trial): Request (trial where submission to ClinicalTrials.gov is not required): Request (trial with minimum data): Request (trial where responsible party is Sponsor-Investigator): Response: |
Request to update a Complete trial in CTRP.
HTTP Method | POST |
---|---|
URL | /trials/complete/{idType}/{trialID} Parameters {idType}. Type of identifier you want to use to identify a trial in CTRP. Possible values: pa, nci, ctep, dcp. {trialID}. Trial identifier value itself. |
Request Body | XML document withCompleteTrialUpdate MIME Type: |
Response Body | XML document withTrialRegistrationConfirmationMIME Type: application/xml |
HTTP Response Code | 200. Success 400. Validation error (including the condition when you are not allowed to update a particular trial) 401. Invalid username/password or insufficient permissions to access the service. 500. Internal server error |
Examples |
Request to amend a Complete trial in CTRP.
HTTP Method | PUT |
---|---|
URL | /trials/complete/{idType}/{trialID} Parameters {idType}. Type of identifier you want to use to identify a trial in CTRP. Possible values: pa, nci, ctep, dcp. {trialID}. Trial identifier value itself. |
Request Body | XML document withCompleteTrialAmendmentMIME Type: application/xml |
Response Body | XML document withTrialRegistrationConfirmation MIME Type: |
HTTP Response Code | 200. Success 400. Validation error (including the condition when you are not allowed to amend a particular trial) 401. Invalid username/password or insufficient permissions to access the service. 404. One of the Persons/Organizations acting on the trial was not found in PO 500. Internal server error |
Examples |