Page History
...
Multiexcerpt |
---|
Inside the NIH Firewall (VPN required)
Outside of the NIH Firewall |
...
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. |
...
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. For more information, refer to the NCI CTRP Person and Organization Curation Portal 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.
|
...
HTTP Method | POST | |||||||
---|---|---|---|---|---|---|---|---|
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 Body | XML document withParticipatingSite MIME Type: | |||||||
Response Body | CTRP identifier of the site MIME Type: | |||||||
HTTP Response Code |
| |||||||
Examples | URL: https://trials-dev.nci.nih.gov/services/trials/nci/NCI-2014-00496/sites Request (referring to existing Organizations and Persons by ID):
|
Update Site
Updates a participating site on a trial.
|
Update Site
Updates a participating site on a trial.
HTTP Method | PUT | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 Body | XML document withParticipatingSiteUpdate MIME Type: | |||||||||||||||||||
Response Body | CTRP identifier of the site. MIME Type: | |||||||||||||||||||
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) | |||||||||||||||||||
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):
Request (Referring to Generic Contacts for RSS Sites):
| |||||||||||||||||||
HTTP Method | PUT | |||||||||||||||||||
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 Body | XML document withParticipatingSiteUpdate
MIME Type: | |||||||||||||||||||
Response Body | CTRP identifier of the site. MIME Type: | |||||||||||||||||||
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) | |||||||||||||||||||
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 |
|
Get Sites
Retrieves a list of participating sites on a trial
...