NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Old Version 1

changes.mady.by.user Frost, Ruth (NIH/NCI) [C]

Saved on

compared with

New Version 2

changes.mady.by.user Frost, Ruth (NIH/NCI) [C]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: For CTRPMICRO-157: Updated URL info based on info from Vinodh in JIRA comment.

...

Three options are available:

  1. /sites/{siteID}/count?count={count}&cutOffDt={cutOffDate}
    1. {siteID}. CTRP numeric identifier of a participating site.
    2. {count}. The accrual count for the site.
    3. {cutOffDate}. The cut-off date for the accrual count, in the format MM-DD-YYYY. 
  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}. The accrual count for the site.
    5. {cutOffDate}. The cut-off date for the accrual count, in the format MM-DD-YYYY.
  3. //trials/{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.

Request Body

...

    1. {count}. The accrual count for the site.
    2. {cutOffDate}. The cut-off date for the accrual count, in the format MM-DD-YYYY.

Request Body

Non-negative numeric accrual count. MIME Type: text/plain.

Response Body

...

CodeResponse
200Success
400Validation error
401Authentication/Authorization Failure: invalid username/password or insufficient permissions to access the service
404Participating site/study subject not found
500Internal server error (includes the condition of updating/deleting a study subject that you don't have accrual access to)

URL Examples

URL: https://trials-dev.nci.nih.gov/accrual-services/trials/nci/NCI-2013-01840accrual-services/sites/po28577/12733422/count

Request:

...

languagenone
themeEclipse

...

count?count=10&cutOffDt=03-10-2015
 

https://trials-dev.nci.nih.gov/accrual-services/trials/nci/NCI-2009-00939/sites/po/24567/count?count=10&cutOffDt=03-10-2015
 

https://trials-dev.nci.nih.gov/accrual-services/trials/nci/NCI-2009-00939/sites/ctep/CA067/count?count=135&cutOffDt=03-10-2015

Delete Study Subject

Description

...

Code Response
200Success
400Validation error
404Study subject not found
500Internal server error

Examples

URL: https://trials.nci.nih.gov/accrual-services/trials/nci/NCI-2014-00233/sites/po/12733422/subjects/SU001

...

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

    Include Page
    wikicontent:Exit Disclaimer to Include
    wikicontent: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>