Accessing services

Consuming Secure Services (PO/PA)

Purpose

To inform our clients (consumers) how to connect to and consume our secure services.

Prerequisites

1. Install caGrid v1.3 locally, http://cagrid.org/display/downloads/caGrid+1.3+Installation+Quick+Start
2. Obtain a grid credential (or Dorian User Account) for the grid trust fabric needed, e.g. Training Grid. (developers working locally should use the Training Grid) See http://cagrid.org/display/cagrid13tutorials/Create+User+Account for instructions.
3. Record your grid credential (aka Grid Identity) for later use. For example, mine is

   /O=caBIG/OU=caGrid/OU=Training/OU=Dorian/CN=matyass
   

4. Add your own Grid Identity to PO and/or PA to authenticate.

HOW-TO

1. Lauch GAARDS-UI and login using your CN (matyass) from your Grid Identity (e.g. /O=caBIG/OU=caGrid/OU=Training/OU=Dorian/CN=matyass)
   Launch GAARDS-UI (ant security)

   steve-matyass-macbook-pro-2:cagrid smatyas$ pwd
   /Users/smatyas/dev/cagrid/caGrid
   steve-matyass-macbook-pro-2:caGrid smatyas$ ant security
   ...
   

   1. Click Login button and specify the following:
      Specify Login Credentials

      Credential Provider: Training
      Organization: Training
      Username: matyass
      Password: *********
      

2. Proceed to consuming PO or PA services as normal now by invoking the APIs.

Consuming Unsecured Services (PO/PA)

If you just want to call the services, you can use a tool like SoapUI to generate XML from the WSDLs listed below (which is what QA does). To get more involved, you can use the sample java code in coppa/code/po-grid/src/gov/nih/nci/coppa/services/entities /ServiceName/client/ServiceNameClient.java. There are similar clients for PA under coppa/code/pa-grid.

The grid services are ISO 21090 compliant. To construct valid XML messages to send to the services, you should be familiar with the spec, available at https://wiki.nci.nih.gov/display/EAWiki/ISO+21090+Data+Types (ISO_21090_20080317.zip). Also read the PIMs (platform independent models) for 21090 and the PersonService available at https://gforge.nci.nih.gov/svnroot/coppa/trunk/documents/analysis_and_design/.

PO Services

The PO services are only available from within the NIH firewall.

Service Endpoints - 3.0

http://ctms-services-po-3-0-integration.nci.nih.gov/wsrf/services/cagrid/Person
http://ctms-services-po-3-0-integration.nci.nih.gov/wsrf/services/cagrid/Organization
http://ctms-services-po-3-0-integration.nci.nih.gov/wsrf/services/cagrid/ClinicalResearchStaff
http://ctms-services-po-3-0-integration.nci.nih.gov/wsrf/services/cagrid/HealthCareFacility
http://ctms-services-po-3-0-integration.nci.nih.gov/wsrf/services/cagrid/HealthCareProvider
http://ctms-services-po-3-0-integration.nci.nih.gov/wsrf/services/cagrid/IdentifiedOrganization
http://ctms-services-po-3-0-integration.nci.nih.gov/wsrf/services/cagrid/IdentifiedPerson
http://ctms-services-po-3-0-integration.nci.nih.gov/wsrf/services/cagrid/OrganizationalContact
http://ctms-services-po-3-0-integration.nci.nih.gov/wsrf/services/cagrid/OversightCommittee
http://ctms-services-po-3-0-integration.nci.nih.gov/wsrf/services/cagrid/ResearchOrganization

Service Endpoints - 3.1 (access requires grid credentials)

http://ctms-services-po-3-1-integration.nci.nih.gov/wsrf/services/cagrid/Person
http://ctms-services-po-3-1-integration.nci.nih.gov/wsrf/services/cagrid/Organization
http://ctms-services-po-3-1-integration.nci.nih.gov/wsrf/services/cagrid/ClinicalResearchStaff
http://ctms-services-po-3-1-integration.nci.nih.gov/wsrf/services/cagrid/HealthCareFacility
http://ctms-services-po-3-1-integration.nci.nih.gov/wsrf/services/cagrid/HealthCareProvider
http://ctms-services-po-3-1-integration.nci.nih.gov/wsrf/services/cagrid/IdentifiedOrganization
http://ctms-services-po-3-1-integration.nci.nih.gov/wsrf/services/cagrid/IdentifiedPerson
http://ctms-services-po-3-1-integration.nci.nih.gov/wsrf/services/cagrid/OrganizationalContact
http://ctms-services-po-3-1-integration.nci.nih.gov/wsrf/services/cagrid/OversightCommittee
http://ctms-services-po-3-1-integration.nci.nih.gov/wsrf/services/cagrid/ResearchOrganization
http://ctms-services-po-3-1-integration.nci.nih.gov/wsrf/services/cagrid/Business

WSDLS

The WSDLs can be accessed by appending ?wsdl to the service endpoints

XSDs - 3.0

http://ctms-services-po-3-0-integration.nci.nih.gov/wsrf/share/schema/CoreServices/CoppaPO.xsd
All types not defined by that XSD are from the ISO 21090 spec.

XSDs - 3.1

http://ctms-services-po-3-1-integration.nci.nih.gov/wsrf/share/schema/CoreServices/CoppaPO.xsd
All types not defined by that XSD are from the ISO 21090 spec.

Service Methods

A list of service methods on the integration tier can be seen at http://ctms-services-po-3-0-integration.nci.nih.gov/wsrf/services or http://ctms-services-po-3-1-integration.nci.nih.gov/wsrf/services, broken down by service end point; the relevant service endpoints are prefixed by "cagrid/"

PA Services

The PA services are only available from within the NIH firewall.

Service Endpoints

http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/ArmService
http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/DocumentService
http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/DocumentWorkflowStatusService
http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/PlannedActivityService
http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/StudyContactService
http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/StudyDiseaseService
http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/StudyIndldeService
http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/StudyOnholdService
http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/StudyOutcomeMeasureService
http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/StudyOverallStatusService
http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/StudyParticipationContactService
http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/StudyParticipationService
http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/StudyProtocolService
http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/StudyRecruitmentStatusService
http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/StudyRegulatoryAuthorityService
http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/StudyRelationshipService
http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/StudyResourcingService
http://ctms-services-pa-integration.nci.nih.gov/wsrf/services/cagrid/StudySiteAccrualStatusService

WSDLS

The WSDLs can be accessed by appending ?wsdl to the service endpoints

XSDs

http://ctms-services-pa-integration.nci.nih.gov/wsrf/share/schema/PAServices/CoppaCommons.xsd
http://ctms-services-pa-integration.nci.nih.gov/wsrf/share/schema/PAServices/CoppaCommonsFaults.xsd
http://ctms-services-pa-integration.nci.nih.gov/wsrf/share/schema/PAServices/CoppaPA.xsd
http://ctms-services-pa-integration.nci.nih.gov/wsrf/share/schema/PAServices/CoppaPAFaults.xsd
http://ctms-services-pa-integration.nci.nih.gov/wsrf/share/schema/PAServices/ISO_datatypes_Narrative.xsd
http://ctms-services-pa-integration.nci.nih.gov/wsrf/share/schema/PAServices/CoppaPAFaults.xsd

Service Methods

A list of service methods on the integration tier can be seen at http://ncias-s165-v.nci.nih.gov:19380/wsrf/services, broken down by service end point; the relevant service endpoints are prefixed by "cagrid/"