NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

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 contents with Include Page macro pointing to versioned include page with same contents.

...

Column
width 40%
Panel
title Topic Links

Table of Contents
maxLevel 4
minLevel 2

...

Include Page

Service Endpoints

Multiexcerpt

Inside the NIH Firewall (VPN required)

Outside of the NIH Firewall

Access Requirements

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

XML Schema

Multiexcerpt

The service uses XML for data exchange. All XML elements going in or out of the service are defined and validated against the following XML schemas:

XML schemas are well-annotated with inline documentation that explains the purpose and meaning of various elements, types, and attributes. Specific elements required for service operations are explained in the sections below.

Persons and Organizations - Requirements and Recommendations

Multiexcerpt

Creating or updating sites in the CTRP often involves organizations and persons that act as Healthcare Facilities and Principal Investigators on a site. CTRP does not manage information about persons and organizations; instead, this is delegated to the Person and Organization Curation Portal, also known as PO. See the Person and Organization Curation Portal User's Guide for more information.

Note
You must have a user account with appropriate LDAP membership to access the PO User's Guide.

Before creating or updating a site, ensure that organizations and persons acting on the site exist already in PO. Use person identifiers (PO IDs) and organization identifiers (CTEP IDs) when you register a trial whenever possible. If they do not already exist, request that they be created prior to managing a site, by submitting a request to the CTRO at ncictro@mail.nih.gov.

Tip
title Use PO Web Services API

We strongly recommend that you exercise the   PO Web Services API separately in order to find persons and organizations of interest prior to creating a site. Once you find a person or organization, you can use their IDs within a site creation packet as shown in API examples below. This helps to minimize duplicates in the CTRP system.

API Specification

Add Site

Adds a participating site to a trial.

...

/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

...

ParticipatingSite

 

MIME Type: application/xml

...

CTRP identifier of the site

MIME Type: text/plain

...

  • 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)

...

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

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

...

language html/xml
collapse true

Update Site

Updates a participating site on a trial.

...

/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

...

ParticipatingSiteUpdate

 

MIME Type: application/xml

...

CTRP identifier of the site.

MIME Type: text/plain.

...

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)

...

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):

...

language html/xml
collapse true

Get Sites

Retrieves a list of participating sites on a trial

...

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

...

sites

MIME Type: application/xml.

...

200. Success

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

404. Trial not found

500. Internal server error

...

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

Response

...

NCI CTRP Participating Site REST Service Guide v4.4

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
title Program 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.

NCI CTRP Participating Site REST Service Guide v4.4