NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Old Version 6

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

Saved on

compared with

New Version 7

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

Saved on

Key

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

...

CodeResponse
200Success
400Validation error
404Participating site not found
500Internal server error

Update

...

Accruals - Summary

...

Description

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

...

  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-stage.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 trial 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 trial.

    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
  3. /trials/{idType}/{trialID}/sites//{idType}/{trialID}/sites/ctep/{id}/ count?count={count}&cutOffDt={cutOffDate}
    1. {idType}. Type of identifier you want to use to identify a trial 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 trial.

    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 

Request Body

None.

Response 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

    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>