NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Old Version 1

changes.mady.by.user Freund, Jeremy (NIH/NCI) [C]

Saved on

compared with

New Version Current

changes.mady.by.user Tate, Ariana (NIH/NCI) [C]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Access Requirements

Multiexcerpt

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

HTTP Basic

Okta token authentication with your

NCI LDAP username and password.

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

API Specification

XML Schema

...

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

...

URL 

Three options are available:

  1. /sites/{id}
    1. {id}. CTRP numeric identifier of a participating site
    2. Example: https://trials-

...

    1. staging.nci.nih.gov/accrual-services/sites/121787425
  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-

...

    1. staging.nci.nih.gov/accrual-services/trials/nci/NCI-2019-00038/sites/po/7434
  2. /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-

...

    1. staging.nci.nih.gov/accrual-services/trials/nci/NCI-2019-00038/sites/ctep/WQ456 

Request Body

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

...

This operation updates accrual counts for a participating site on an Abbreviated (Industrial) study.

HTTP Method

PUT

URL

Three options are available:

  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-

...

    1. staging.nci.nih.gov/accrual-services/sites/28577/count?count=10&cutOffDt=03-10-2015 
  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-

...

    1. staging.nci.nih.gov/accrual-services/trials/nci/NCI-2018-03045/sites/po/7434/count?count=10&cutOffDt=03-10-2015 
  2. /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-

...

    1. staging.nci.nih.gov/accrual-services/trials/nci/NCI-2018-03045/sites/ctep/WQ456/count?count=20&cutOffDt=03-10-2015 

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 
  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-stagestaging.nci.nih.gov/accrual-services/trials/nci/NCI-2014-00233/sites/po/7434/subjects/SU001
  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


Request Body

NONE

Response Body

None (if successful) or an error message. MIME Type: text/plain.

...

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

HTTP Method 

Post

URL

/batch

Example: https://trials-

...

staging.nci.nih.gov/accrual-services/batch

Content-Type: application/xml

Accept: application/xml

Request Body

XML document with batchFile root element.

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

    Multiexcerpt include
    MultiExcerptNameExitDisclaimer
    nopaneltrue
    PageWithExcerptwikicontent:Exit Disclaimer to Include
    .) If you convert the above example information, the result would be as follows:

    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>

    • ...