This section provides instructions for registering, updating, and amending Complete and Abbreviated trials via the NCI CTRP Trial Registration REST Service.
Introduction
Trial Registration REST Service is a CTRP Web Service that provides the following operations in a REST-like fashion:
- Register an Abbreviated trial in CTRP from ClinicalTrials.gov using a ClinicalTrials.gov Trial Identifier
- Update an Abbreviated trial in CTRP
- Register a Complete interventional or non-interventional trial in CTRP
- Update a Complete trial in CTRP
- Amend a Complete trial in CTRP
The service uses XML for data exchange.
Program Codes
The program codes feature (not to be confused with NCI Division and Program Values) has been enhanced. The system ignores program codes unless the trial is one of the following:
- Complete trial with a lead organization as a member of your cancer center family of organizations.
- Abbreviated trial where such a member is a participant.
The system validates program code values against those listed on the Manage Program Codes Master List page for your affiliated cancer center. For details, refer to Managing Program Codes.
Service Endpoints
Inside the NIH Firewall (VPN required)
Outside of the NIH Firewall
Access Requirements
To use the service, you must have a valid NCI CTRP account. For instructions, refer to Creating New NCI CTRP User Accounts. All service endpoints require Okta token authentication with your NCI CTRP Client ID and Client Secret. Contact CTRP_support@nih.gov to have a NCI CTRP Client ID and Client secret generated for your CTRP REST account.
See the following document for generating an Okta access token using your CTRP Client ID and Client Secret: NCI CTRP API Authentication Guide
XML Schema
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. These schemas specify which elements are required and the required order of those elements. Specific elements required for service operations are explained in the sections below.
Persons and Organizations - Requirements and Recommendations
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. 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
API Specification
Register an Abbreviated Trial
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 study with the given identifier already exists in CTRP. 500. Error: Duplicate Trial Submission: A trial exists in the system with the same Lead Organization Trial Identifier for the selected Lead Organization |
Examples |
Update an Abbreviated Trial
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 | URL: https://trials-stage.nci.nih.gov/services/trials/abbreviated/nci/NCI-2014-00496 Request: Response: |
Register a Complete Trial
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-stage.nci.nih.gov/services/trials/complete Request (referring to existing Organizations and Persons by ID): Request (non-interventional trial): Request (trial with minimum data): Request (trial where responsible party is Sponsor-Investigator): Response: |
Update a Complete Trial
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 |
Amend a Complete Trial
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 |