Service Endpoints
Inside the NIH Firewall (VPN required)
- DEV: https://trials-dev.nci.nih.gov/accrual-services
- QA: https://trials-qa.nci.nih.gov/accrual-services
- QA2: https://trials-qa2.nci.nih.gov/accrual-services
Outside of the NIH Firewall
Access Requirements
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.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 schema:
The XML schema is 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.
API Specification
Add/Update Subject (Patient) Accruals
Description
This operation submits subject (patient) accrual information for a specific participating site on a trial. If the subject accrual record already exists for the specified study and participating site, this operation will update that record accordingly. If you submit multiple subject accrual records all with the same subject ID within the same request, the last record in the list will supplant the others. The submitter must have accrual access to the site.
HTTP Method
PUT
URL
Three options are available:
- /sites/{id}
- {id}. CTRP numeric identifier of a participating site
- /trials/{idType}/{trialID}/sites/po/{id}
- {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
{id}. PO identifier of the organization that is the site on the trial
- {idType}. Type of identifier you want to use to identify a trial in CTRP. Possible values: pa, nci, ctep, dcp.
- /trials/{idType}/{trialID}/sites/ctep/{id}
- {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
{id}. CTEP identifier of the organization that is the site on the trial
Request Body
XML document with studySubjects
root element (see XML Schema). MIME Type: application/xml
.
Response Body
None (if successful) or an error message. MIME Type: text/plain
.
HTTP Response Codes
Code | Response |
---|---|
200 | Success |
400 | Validation error |
404 | Participating site not found |
500 | Internal server error |
Examples
URL: https://trials-dev.nci.nih.gov/accrual-services/sites/121787425
Request XML:
The following XML request shows an example for submitting 5 study subjects to site 121787425 using ICD9 for disease codes. Note that the “siteDisease codeSystem” is not required since the disease code used is ICD9.
Request XML (Specifying Disease and Site Disease codes using ICD-O-3)
The following XML request shows an example for submitting one study subject to site 121787425 using ICD-O-3 for the disease code. Note that when the disease <codeSystem> = “ICD-O-3”, either the <disease> or the <siteDisease> is mandatory.
Request XML (Specifying Disease and Site Disease codes using Legacy Codes - CTEP)
The following XML request shows an example for submitting one study subject to site 121787425 using Legacy Codes - CTEP for the disease code.
Update Accrual Count
Description
This operation updates accrual counts for a participating site on an Abbreviated (Industrial) trial.
HTTP Method
PUT
URL
Three options are available:
- /sites/{siteID}/count
- {siteID}. CTRP numeric identifier of a participating site
- /trials/{idType}/{trialID}/sites/po/{poid}/count
- {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.
{poid}. PO identifier of the organization that is the site on the trial.
- /trials/{idType}/{trialID}/sites/ctep/{id}/count
- {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.
{id}. CTEP identifier of the organization that is the site on the trial.
Request Body
Non-negative numeric accrual count. MIME Type: text/plain
.
Response Body
None (if successful) or an error message. MIME Type: text/plain
.
HTTP Response Codes
Code | Response |
---|---|
200 | Success |
400 | Validation error |
401 | Authentication/Authorization Failure: invalid username/password or insufficient permissions to access the service |
404 | Participating site/study subject not found |
500 | Internal server error (includes the condition of updating/deleting a study subject that you don't have accrual access to) |
Examples
URL: https://trials-dev.nci.nih.gov/accrual-services/trials/nci/NCI-2013-01840/sites/po/12733422/count
Request:
Delete Study Subject
Description
Deletes specific study subject (patient) accrual information from a participating site.
HTTP Method
DELETE
URL
Three options are available:
- /sites/{siteID}/subjects/{subjectID}
- {siteID}. CTRP numeric identifier of a participating site
- {subjectID}. Study subject identifier
- /trials/{idType}/{trialID}/sites/po/{poid}/subjects/{subjectID}
- {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
{poid}. PO identifier of the organization that is the site on the trial
- {subjectID}. Study subject identifier
- /trials/{idType}/{trialID}/sites/ctep/{ctepID}/subjects/{subjectID}
- {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
{ctepID}. CTEP identifier of the organization that is the site on the trial
- {subjectID}. Study subject identifier
Request Body
NONE
Response Body
None (if successful) or an error message. MIME Type: text/plain
.
HTTP Response Codes
Code | Response |
---|---|
200 | Success |
400 | Validation error |
404 | Study subject not found |
500 | Internal server error |
Examples
Submit CDUS Batch File for Asynchronous Processing
Description
With this operation, you can upload a CDUS batch file. The system processes this file asynchronously and sends the results of processing by email to the submitting user.
HTTP Method
Post
URL
/batch
Request Body
XML document with batchFile root element.
Response Body
None (if successful) or an error message. MIME Type: text/plain
.
Example
URL: https://trials.nci.nih.gov/accrual-services/batch
Content-Type: application/xml
Accept: application/xml
Body:
In this example, consider the following CDUS Accrual information for a typical CDUS Accrual file:
How to Construct the Body:
Convert the CDUS Accrual information to Base64 encoding. You can do so using Base64 Encoding feature in the Notepad++ application. (Other tools can be found here: https://www.google.com/#q=base64+encoding+tool
Copy this one into an NCI wiki (not Collaborate) page:.) If you convert the above example information, the result would be as follows:The following is the multiexcerpt that may be the source of existing exit disclaimers. Do not copy this one because it places the image on the next line after the link.
Insert the Base64 encoded text between <batchFile xmlns="gov.nih.nci.accrual.webservices.types"> and </batchFile> tags, as follows: