Page History

...

Service Endpoints

...

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:

1. /sites/{id}
   
   1. {id}. CTRP numeric identifier of a participating site
   2. Example: https://trials-stagestaging.nci.nih.gov/accrual-services/sites/121787425 IS THIS THE CORRECT URL?
2. /trials/{idType}/{trialID}/sites/po/{id}
   
   1. {idType}. Type of identifier you want to use to identify a study in CTRP. Possible values: pa, nci, ctep, dcp.
      
   2. {trialID}. Trial identifier value itself

   3. {id}. PO identifier of the organization that is the site on the study

   4. Example: https://trials-int.nci.nih.gov/accrual-services/trials/nci/NCI-2019-00038/sites/po/7434 DEPRECATE THIS URL?
3. /trials/{idType}/{trialID}/sites/ctep/{id}
   
   1. {idType}. Type of identifier you want to use to identify a study in CTRP. Possible values: pa, nci, ctep, dcp.
   2. {trialID}. Trial identifier value itself

   3. {id}. CTEP identifier of the organization that is the site on the study

   4. Example: https://trials-int.nci.nih.gov/accrual-services/trials/nci/NCI-2019-00038/sites/ctep/WQ456  DEPRECATE THIS URL?

Request Body

XML document with studySubjects root element (see XML Schema). MIME Type: application/xml.

...

1. /sites/{siteID}/count?count={count}&cutOffDt={cutOffDate}
   
   1. {siteID}. CTRP numeric identifier of a participating site.
   2. {count}. Mandatory parameter. The accrual count for the site.
   3. {cutOffDate} . The cut-off date for the accrual count, in the format MM-DD-YYYY.
   4. Example: https://trials-stagestaging.nci.nih.gov/accrual-services/sites/28577/count?count=10&cutOffDt=03-10-2015 IS THIS URL CORRECT? 
2. /trials/{idType}/{trialID}/sites/po/{poid}/ count?count={count}&cutOffDt={cutOffDate}
   
   1. {idType}. Type of identifier you want to use to identify a study in CTRP. Possible values: pa, nci, ctep, dcp.
   2. {trialID}. Trial identifier value itself.

   3. {poid}. PO identifier of the organization that is the site on the study.

   4. {count}. Mandatory parameter. The accrual count for the site.
   5. {cutOffDate} . The cut-off date for the accrual count, in the format MM-DD-YYYY.
   6. Example: https://trials-int.nci.nih.gov/accrual-services/trials/nci/NCI-2018-03045/sites/po/7434/count?count=10&cutOffDt=03-10-2015 DEPRECATE THIS URL?
3. /trials/{idType}/{trialID}/sites/ctep/{id}/ count?count={count}&cutOffDt={cutOffDate}
   
   1. {idType}. Type of identifier you want to use to identify a study in CTRP. Possible values: pa, nci, ctep, dcp.
   2. {trialID}. Trial identifier value itself.

   3. {id}. CTEP identifier of the organization that is the site on the study.

   4. {count}. Mandatory parameter. The accrual count for the site.
   5. {cutOffDate} . The cut-off date for the accrual count, in the format MM-DD-YYYY.
   6. Example: https://trials-int.nci.nih.gov/accrual-services/trials/nci/NCI-2018-03045/sites/ctep/WQ456/count?count=20&cutOffDt=03-10-2015  DEPRECATE THIS URL?

Request Body

None.

Response Body

...

1. /sites/{siteID}/subjects/{subjectID}
   
   1. {siteID}. CTRP numeric identifier of a participating site
   2. {subjectID}. Study subject identifier
   3. Example: https://trials-stagestaging.nci.nih.gov/accrual-services/sites/28577/subjects/SU001 IS THIS URL CORRECT? 
2. /trials/{idType}/{trialID}/sites/po/{poid}/subjects/{subjectID}
   
   1. {idType}. Type of identifier you want to use to identify a study in CTRP. Possible values: pa, nci, ctep, dcp.
   2. {trialID}. Trial identifier value itself

   3. {poid}. PO identifier of the organization that is the site on the study

   4. {subjectID}. Study subject identifier
   5. Example: https://trials-stage.nci.nih.gov/accrual-services/trials/nci/NCI-2014-00233/sites/po/7434/subjects/SU001 IS THIS URL CORRECT? 
3. /trials/{idType}/{trialID}/sites/ctep/{ctepID}/subjects/{subjectID}
   
   1. {idType}. Type of identifier you want to use to identify a study in CTRP. Possible values: pa, nci, ctep, dcp .
   2. {trialID}. Trial identifier value itself

   3. {ctepID}. CTEP identifier of the organization that is the site on the study

   4. {subjectID}. Study subject identifier
   5. Example: https://trials-stagestaging.nci.nih.gov/accrual-services/trials/nci/NCI-2014-00233/sites/ctep/WQ456/subjects/SU001 IS THIS URL CORRECT? 

Request Body

NONE

Response Body

...

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 IS THIS URL CORRECT?

Content-Type: application/xml

...

In this example, consider the following CDUS Accrual information for a typical CDUS Accrual file:

...

How to Construct the Body:

1. 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

   Multiexcerpt include
   MultiExcerptName ExitDisclaimer nopanel true PageWithExcerpt wikicontent:Exit Disclaimer to Include

   .) If you convert the above example information, the result would be as follows:

   Code Block
   IkNPTExFQ1RJT05TIiwiTkNJLTIwMTQtMDI1OTMiLCwsLCwsLCwsDQoiUEFUSUVOVFMiLCJOQ0ktMjAxNC0wMjU5MyIsImcyIiwiMjA4NTAiLCJVUyIsIjE5ODAwMyIsIk1hbGUiLCJOb3QgUmVwb3J0ZWQiLCJNZWRpY2FpZCBhbmQgTWVkaWNhcmUiLCIyMDE0MDkzMCIsLCIxMjA4OTQiLCwsLCwsLCwsLCIyNTAuMDIiLCwNCiJQQVRJRU5UX1JBQ0VTIiwiTkNJLTIwMTQtMDI1OTMiLCJnMiIsIldoaXRlIg==

2. 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>

...