NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Old Version 1

changes.mady.by.user Anonymous

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: Replaced endpoints/URLs with TBD.

...

Section
Column
width40%
Panel
titleTopic Links

Table of Contents
maxLevel4
minLevel2

Column

This section provides instructions for adding and updating participating sites via the NCI CTRP Participating Site REST Service.

Introduction

Participating Site REST Service is a CTRP Web Service that provides the following operations in a REST-like fashion:

  • Add a participating site to a trial
  • Update an existing participating site on a trial
  • Obtain a list of participating sites on a trial

The service uses XML for data exchange.

Note
titleProgram Codes

The program codes feature (not to be confused with NCI Division and Program Codes) has been enhanced for the 4.4 release. The system ignores program codes unless the trial is one of the following:

  • Complete trial with a lead organization as a member of your cancer center family of organizations.
  • Abbreviated trial where such a member is a participant.

The system validates program code values against those listed on the Manage Program Codes Master List page for your affiliated cancer center. For details, refer to Managing Program Codes.

Service Endpoints

...

Inside the NIH Firewall (VPN required)

Outside of the NIH Firewall

Production endpoint: TBD

Show If
groupGP-CFW_ADMINS, GP-CFW_CTRP_DEV, GP-CFW_NCI_CTRO_DEV
Info
iconfalse
titleNote Visible to Internal Users Only

Internal endpoints: TBD

...

Access Requirements

Multiexcerpt
To use the service, you must have a valid NCI LDAP account and a CTRP account. All service endpoints require HTTP Basic authentication with your NCI LDAP username and password.

...

HTTP MethodPOST
URL

/trials/{idType}/{trialID}/sites

Parameters

{idType}. Type of identifier you want to use to identify a trial in CTRP. Possible values: pa, nci, ctep.

{trialID}. Trial identifier value itself

Request BodyXML document with
ParticipatingSite

 

MIME Type: application/xml

Response Body

CTRP identifier of the site

MIME Type: text/plain

HTTP Response Code
  • 200. Success
  • 400. Validation error
  • 401. Invalid username/password or insufficient permissions to access the service.
  • 404. Trial not found
  • 500. Internal server error (includes the condition when the caller does not own the trial)
Examples

URL: https://trials-dev.nci.nih.gov/services/trials/nci/NCI-2014-00496/sitesTBD

Request (referring to existing Organizations and Persons by ID):

Code Block
languagehtml/xml
collapsetrue
<tns:ParticipatingSite xmlns:tns="gov.nih.nci.pa.webservices.types"
    xmlns:tns1="gov.nih.nci.po.webservices.types.trimmed" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="gov.nih.nci.pa.webservices.types ../../src/resources/ws.xsd ">
    <tns:recruitmentStatus>Administratively Complete</tns:recruitmentStatus>
    <tns:recruitmentStatusDate>2001-05-06</tns:recruitmentStatusDate>
    <tns:localTrialIdentifier>tns:localTrialIdentifier</tns:localTrialIdentifier>
    <tns:programCode>tns:programCode</tns:programCode>
    <tns:openedForAccrual>2001-02-02</tns:openedForAccrual>
    <tns:closedForAccrual>2010-03-04</tns:closedForAccrual>
    <tns:targetAccrualNumber>100000</tns:targetAccrualNumber>
    <tns:investigator>
        <tns:person>
            <tns:existingPerson>
                <tns:poID>1</tns:poID>
            </tns:existingPerson>
        </tns:person>
        <tns:role>Principal Investigator</tns:role>
        <tns:primaryContact>true</tns:primaryContact>
    </tns:investigator>
    <tns:investigator>
        <tns:person>
            <tns:existingPerson>
                <tns:poID>2</tns:poID>
            </tns:existingPerson>
        </tns:person>
        <tns:role>Sub Investigator</tns:role>
        <tns:primaryContact>false</tns:primaryContact>
    </tns:investigator>
    <tns:organization>
        <tns:existingOrganization>
            <tns:poID>1</tns:poID>
        </tns:existingOrganization>
    </tns:organization>
</tns:ParticipatingSite>

...

HTTP MethodPUT
URL

/sites/{id}

Parameters

{id}. CTRP identifier of the site

/trials/{idType}/{trialID}/sites/po/{id}

Parameters

{idType}. Type of identifier used to identify a trial in CTRP. Possible values: pa, nci, ctep.

{trialID}. Trial identifier value itself

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

/trials/{idType}/{trialID}/sites/ctep/{id}

Parameters

{idType}. Type of identifier used to identify a trial in CTRP. Possible values: pa, nci, ctep.

{trialID}. Trial identifier value itself

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

Request BodyXML document with
ParticipatingSiteUpdate

 

MIME Type: application/xml

Response Body

CTRP identifier of the site.

MIME Type: text/plain.

HTTP Response Code

200. Success

400. Validation error

401. Invalid username/password or insufficient permissions to access the service.

404. Site not found

500. Internal server error (includes the condition when the caller does not own the trial)the caller does not own the trial)

Examples

URL: TBD 

Examples

URL: https://trials-dev.nci.nih.gov/services/trials/nci/NCI-2014-00496/sites/po/34758686

Request (referring to existing Organizations and Persons by ID):

Code Block
languagehtml/xml
collapsetrue
<tns:ParticipatingSiteUpdate xmlns:tns="gov.nih.nci.pa.webservices.types"
    xmlns:tns1="gov.nih.nci.po.webservices.types.trimmed" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="gov.nih.nci.pa.webservices.types ../../src/resources/ws.xsd ">
    <tns:recruitmentStatus>Administratively Complete</tns:recruitmentStatus>
    <tns:recruitmentStatusDate>2001-05-06</tns:recruitmentStatusDate>
    <tns:localTrialIdentifier>tns:localTrialIdentifier</tns:localTrialIdentifier>
    <tns:programCode>tns:programCode</tns:programCode>
    <tns:openedForAccrual>2001-02-02</tns:openedForAccrual>
    <tns:closedForAccrual>2010-03-04</tns:closedForAccrual>
    <tns:targetAccrualNumber>100000</tns:targetAccrualNumber>
    <tns:investigator>
        <tns:person>
            <tns:existingPerson>
                <tns:poID>1</tns:poID>
            </tns:existingPerson>
        </tns:person>
        <tns:role>Principal Investigator</tns:role>
        <tns:primaryContact>true</tns:primaryContact>
    </tns:investigator>
    <tns:investigator>
        <tns:person>
            <tns:existingPerson>
                <tns:poID>2</tns:poID>
            </tns:existingPerson>
        </tns:person>
        <tns:role>Principal Investigator</tns:role>
        <tns:primaryContact>false</tns:primaryContact>
    </tns:investigator>
	<tns:primaryContact>
		<tns:person>
            <tns:existingPerson>
                <tns:poID>1</tns:poID>
            </tns:existingPerson>
		</tns:person>
		<tns:contactDetails>
			<tns:email>sample@sample.com</tns:email>
			<tns:phone>555-555-5555ext99</tns:phone>
		</tns:contactDetails>
	</tns:primaryContact>
</tns:ParticipatingSiteUpdate>

...

HTTP MethodGET
URL

/trials/{idType}/{trialID}/sites

Parameters

{idType}. Type of identifier you want to use to identify a trial in CTRP. Possible values: pa, nci, ctep.

{trialID}. Trial identifier value itself.

Request BodyNONE
Response BodyXML document with
sites

MIME Type: application/xml.

HTTP Response Code

200. Success

401. Invalid username/password or insufficient permissions to access the service.

404. Trial not found

500. Internal server error

Examples

URL: https://trials-dev.nci.nih.gov/services/trials/nci/NCI-2014-00496/sitesTBD

Response

Code Block
languagehtml/xml
collapsetrue
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<sites xmlns="gov.nih.nci.pa.webservices.types" xmlns:ns2="gov.nih.nci.po.webservices.types.trimmed">
    <site>
        <recruitmentStatus>Active</recruitmentStatus>
        <recruitmentStatusDate>2014-07-07-04:00</recruitmentStatusDate>
        <localTrialIdentifier>1236</localTrialIdentifier>
        <programCode></programCode>
        <openedForAccrual>2014-07-07-04:00</openedForAccrual>
        <investigator>
            <person>
                <existingPerson>
                    <poID>943919</poID>
                </existingPerson>
            </person>
            <role>Principal Investigator</role>
            <primaryContact>false</primaryContact>
        </investigator>
        <organization>
            <existingOrganization>
                <poID>120807</poID>
            </existingOrganization>
        </organization>
    </site>
    <site>
        <recruitmentStatus>Enrolling by Invitation</recruitmentStatus>
        <recruitmentStatusDate>2014-05-29-04:00</recruitmentStatusDate>
        <localTrialIdentifier>ganesh</localTrialIdentifier>
        <programCode>123459</programCode>
        <openedForAccrual>2014-05-29-04:00</openedForAccrual>
        <investigator>
            <person>
                <existingPerson>
                    <poID>27658186</poID>
                </existingPerson>
            </person>
            <role>Principal Investigator</role>
            <primaryContact>false</primaryContact>
        </investigator>
        <organization>
            <existingOrganization>
                <poID>38249</poID>
            </existingOrganization>
        </organization>
    </site>
    <site>
        <recruitmentStatus>In Review</recruitmentStatus>
        <recruitmentStatusDate>2014-06-09-04:00</recruitmentStatusDate>
        <localTrialIdentifier>mm</localTrialIdentifier>
        <investigator>
            <person>
                <existingPerson>
                    <poID>3114680</poID>
                </existingPerson>
            </person>
            <role>Principal Investigator</role>
            <primaryContact>false</primaryContact>
        </investigator>
        <organization>
            <existingOrganization>
                <poID>120748</poID>
            </existingOrganization>
        </organization>
    </site>
</sites>