Page History
...
Service Endpoints
Multiexcerpt |
---|
Inside the NIH Firewall (VPN required)
Outside of the NIH Firewall
|
...
This operation reports Subject & Partial Subject accrual information for a specific participating site on a study. If the subject accrual record already exists for the specified study and participating site, this operation will update that record accordingly. If you report 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
URLURL
Three options are available:
- /sites/{id}
- {id}. CTRP numeric identifier of a participating site
- Example: https://trials-stagestaging.nci.nih.gov/accrual-services/sites/121787425
- /trials/{idType}/{trialID}/sites/po/{id}
- {idType}. Type of identifier you want to use to identify a study 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 study
- Example: https://trials-intstaging.nci.nih.gov/accrual-services/trials/nci/NCI-2019-00038/sites/po/7434
- {idType}. Type of identifier you want to use to identify a study 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 study 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 study
- Example: https://trials-intstaging.nci.nih.gov/accrual-services/trials/nci/NCI-2019-00038/sites/ctep/WQ456
...
- /sites/{siteID}/count?count={count}&cutOffDt={cutOffDate}
- {siteID}. CTRP numeric identifier of a participating site.
- {count}. Mandatory parameter. The accrual count for the site.
- {cutOffDate} . The cut-off date for the accrual count, in the format MM-DD-YYYY.
- Example: https://trials-stagestaging.nci.nih.gov/accrual-services/sites/28577/count?count=10&cutOffDt=03-10-2015
- /trials/{idType}/{trialID}/sites/po/{poid}/ count?count={count}&cutOffDt={cutOffDate}
- {idType}. Type of identifier you want to use to identify a study 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 study.
- {count}. Mandatory parameter. The accrual count for the site.
- {cutOffDate} . The cut-off date for the accrual count, in the format MM-DD-YYYY.
- Example: https://trials-intstaging.nci.nih.gov/accrual-services/trials/nci/NCI-2018-03045/sites/po/7434/count?count=10&cutOffDt=03-10-2015
- /trials/{idType}/{trialID}/sites/ctep/{id}/ count?count={count}&cutOffDt={cutOffDate}
- {idType}. Type of identifier you want to use to identify a study 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 study.
- {count}. Mandatory parameter. The accrual count for the site.
- {cutOffDate} . The cut-off date for the accrual count, in the format MM-DD-YYYY.
- Example: https://trials-intstaging.nci.nih.gov/accrual-services/trials/nci/NCI-2018-03045/sites/ctep/WQ456/count?count=20&cutOffDt=03-10-2015
...
- /sites/{siteID}/subjects/{subjectID}
- {siteID}. CTRP numeric identifier of a participating site
- {subjectID}. Study subject identifier
- Example: https://trials-stagestaging.nci.nih.gov/accrual-services/sites/28577/subjects/SU001
- /trials/{idType}/{trialID}/sites/po/{poid}/subjects/{subjectID}
- {idType}. Type of identifier you want to use to identify a study 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 study
- {subjectID}. Study subject identifier
- Example: https://trials-stagestaging.nci.nih.gov/accrual-services/trials/nci/NCI-2014-00233/sites/po/7434/subjects/SU001
- /trials/{idType}/{trialID}/sites/ctep/{ctepID}/subjects/{subjectID}
- {idType}. Type of identifier you want to use to identify a study 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 study
- {subjectID}. Study subject identifier
- Example: https://trials-stagestaging.nci.nih.gov/accrual-services/trials/nci/NCI-2014-00233/sites/ctep/WQ456/subjects/SU001
Request Body
NONE
Response Body
...
Code | Response |
---|---|
200 | Success |
400 | Validation error |
404 | Study subject not found |
500 | Internal server error |
Report
...
Batch File for Asynchronous Processing
Refer to the following on batch file formats: Complete Trial Data Record Formats, Abbreviated Trial Data Record Formats
...
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 reporting userreporting user.
HTTP Method
Post
URL
/batch
Example: https://trials-stagestaging.nci.nih.gov/accrual-services/batch
Content-Type: application/xml
...
In this example, consider the following CDUS Accrual information for a typical CDUS Accrual file:
...
How to Construct the Body:
Convert the CDUS the 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
.) If you convert the above example information, the result would be as follows:Multiexcerpt include MultiExcerptName ExitDisclaimer nopanel true PageWithExcerpt wikicontent:Exit Disclaimer to Include Code Block IkNPTExFQ1RJT05TIiwiTkNJLTIwMTQtMDI1OTMiLCwsLCwsLCwsDQoiUEFUSUVOVFMiLCJOQ0ktMjAxNC0wMjU5MyIsImcyIiwiMjA4NTAiLCJVUyIsIjE5ODAwMyIsIk1hbGUiLCJOb3QgUmVwb3J0ZWQiLCJNZWRpY2FpZCBhbmQgTWVkaWNhcmUiLCIyMDE0MDkzMCIsLCIxMjA4OTQiLCwsLCwsLCwsLCIyNTAuMDIiLCwNCiJQQVRJRU5UX1JBQ0VTIiwiTkNJLTIwMTQtMDI1OTMiLCJnMiIsIldoaXRlIg==
Insert the Base64 encoded text between <batchFile xmlns="gov.nih.nci.accrual.webservices.types"> and </batchFile> tags, as follows:
Code Block <batchFile xmlns="gov.nih.nci.accrual.webservices.types">IkNPTExFQ1RJT05TIiwiTkNJLTIwMTQtMDI1OTMiLCwsLCwsLCwsDQoiUEFUSUVOVFMiLCJOQ0ktMjAxNC0wMjU5MyIsImcyIiwiMjA4NTAiLCJVUyIsIjE5ODAwMyIsIk1hbGUiLCJOb3QgUmVwb3J0ZWQiLCJNZWRpY2FpZCBhbmQgTWVkaWNhcmUiLCIyMDE0MDkzMCIsLCIxMjA4OTQiLCwsLCwsLCwsLCIyNTAuMDIiLCwNCiJQQVRJRU5UX1JBQ0VTIiwiTkNJLTIwMTQtMDI1OTMiLCJnMiIsIldoaXRlIg==</batchFile>
...