Access Requirements
To use the service, you must have a valid NCI CTRP account. For instructions, refer to Creating New NCI CTRP User Accounts. All service endpoints require Okta token authentication with your NCI CTRP Client ID and Client Secret. Contact CTRP_support@nih.gov to have a NCI CTRP Client ID and Client secret generated for your CTRP REST account.
See the following document for generating an Okta access token using your CTRP Client ID and Client Secret: NCI CTRP API Authentication Guide
Person Service
The following sections list operations provided by the Person web service.
Operation createPerson
Creates a person record in PO database.
Request Body | createPersonRequest having person element |
---|
Response Body | createPersonResponse having person element |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:per="http://soap.simple.service.webservices.po.nci.nih.gov/person/"
xmlns:gov="gov.nih.nci.po.webservices.types">
<soapenv:Header />
<soapenv:Body>
<per:createPersonRequest>
<person>
<gov:status>ACTIVE</gov:status>
<gov:prefix>Mr</gov:prefix>
<gov:firstName>John</gov:firstName>
<gov:middleName>M</gov:middleName>
<gov:lastName>Phillips</gov:lastName>
<gov:suffix>Sr</gov:suffix>
<gov:address>
<gov:line1>Legacy Circle</gov:line1>
<gov:line2>Apt Z</gov:line2>
<gov:city>Herndon</gov:city>
<gov:stateOrProvince>VA</gov:stateOrProvince>
<gov:country>USA</gov:country>
<gov:postalcode>20171</gov:postalcode>
</gov:address>
<gov:contact type="EMAIL">abc@cgb.com</gov:contact>
<gov:contact type="PHONE">703-123-1111</gov:contact>
<gov:contact type="TTY">703-123-2222</gov:contact>
<gov:contact type="FAX">703-123-3333</gov:contact>
<gov:contact type="URL">http://abc.com</gov:contact>
</person>
</per:createPersonRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:createPersonResponse xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<person>
<ns3:id>30472</ns3:id>
<ns3:status>ACTIVE</ns3:status>
<ns3:prefix>Mr</ns3:prefix>
<ns3:firstName>John</ns3:firstName>
<ns3:middleName>M</ns3:middleName>
<ns3:lastName>Phillips</ns3:lastName>
<ns3:suffix>Sr</ns3:suffix>
<ns3:ctepId>11111</ns3:ctepId>
<ns3:address>
<ns3:line1>Legacy Circle</ns3:line1>
<ns3:line2>Apt Z</ns3:line2>
<ns3:city>Herndon</ns3:city>
<ns3:stateOrProvince>VA</ns3:stateOrProvince>
<ns3:country>USA</ns3:country>
<ns3:postalcode>20171</ns3:postalcode>
</ns3:address>
<ns3:contact type="EMAIL">abc@cgb.com</ns3:contact>
<ns3:contact type="PHONE">703-123-1111</ns3:contact>
<ns3:contact type="FAX">703-123-3333</ns3:contact>
<ns3:contact type="TTY">703-123-2222</ns3:contact>
<ns3:contact type="URL">http://abc.com</ns3:contact>
</person>
</ns2:createPersonResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: "ID" is present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>IllegalArgumentException: id must be null on calls to create!</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Address is not present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.a: Invalid content was found starting with element 'gov:contact'. One of '{"gov.nih.nci.po.webservices.types":address}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Invalid email and phone number present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>Person couldn't be created as data is invalid. The
invalid elements are: phone[0].value email[1].value Phone number
703@35@234</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation updatePerson
Updates an existing person record in PO database.
Request Body | updatePersonRequest having person element. |
---|
Response Body | updatePersonResponse having person element. |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:per="http://soap.simple.service.webservices.po.nci.nih.gov/person/"
xmlns:gov="gov.nih.nci.po.webservices.types">
<soapenv:Header />
<soapenv:Body>
<per:updatePersonRequest>
<person>
<gov:id>30472</gov:id>
<gov:status>INACTIVE</gov:status>
<gov:firstName>Johny</gov:firstName>
<gov:lastName>Phillips</gov:lastName>
<gov:address>
<gov:line1>Legacy Cir</gov:line1>
<gov:line2>Apt#A</gov:line2>
<gov:city>Herndon</gov:city>
<gov:stateOrProvince>VA</gov:stateOrProvince>
<gov:country>USA</gov:country>
<gov:postalcode>20160</gov:postalcode>
</gov:address>
<gov:contact type="EMAIL">abc123@cgb.com</gov:contact>
</person>
</per:updatePersonRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:updatePersonResponse xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<person>
<ns3:id>30472</ns3:id>
<ns3:status>INACTIVE</ns3:status>
<ns3:firstName>Johny</ns3:firstName>
<ns3:lastName>Phillips</ns3:lastName>
<ns3:ctepId>66666666666</ns3:ctepId>
<ns3:address>
<ns3:line1>Legacy Cir</ns3:line1>
<ns3:line2>Apt#A</ns3:line2>
<ns3:city>Herndon</ns3:city>
<ns3:stateOrProvince>VA</ns3:stateOrProvince>
<ns3:country>USA</ns3:country>
<ns3:postalcode>20160</ns3:postalcode>
</ns3:address>
<ns3:contact type="EMAIL">abc123@cgb.com</ns3:contact>
</person>
</ns2:updatePersonResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: The person is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>ObjectNotFoundException: No row with the given identifier exists: [gov.nih.nci.po.data.bo.Person#34407]</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: "ID" is not present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>ServiceException: The Person couldn't be updated as
either person or personId is null.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Address is not present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.a: Invalid content was found starting with element 'gov:contact'. One of '{"gov.nih.nci.po.webservices.types":address}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Invalid email is present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>InvalidStateException: validation failed for: gov.nih.nci.po.data.bo.Email</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation changePersonStatus
Changes the status of an existing person record.
Request Body | changePersonStatusRequest having personID and status element. |
---|
Response Body | changePersonStatusResponse having person element. |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:per="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<soapenv:Header />
<soapenv:Body>
<per:changePersonStatusRequest>
<personID>30472</personID>
<status>ACTIVE</status>
</per:changePersonStatusRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:changePersonStatusResponse
xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<person>
<ns3:id>30472</ns3:id>
<ns3:status>ACTIVE</ns3:status>
<ns3:firstName>Johny</ns3:firstName>
<ns3:lastName>Phillips</ns3:lastName>
<ns3:ctepId>66666666666</ns3:ctepId>
<ns3:address>
<ns3:line1>Legacy Cir</ns3:line1>
<ns3:line2>Apt#A</ns3:line2>
<ns3:city>Herndon</ns3:city>
<ns3:stateOrProvince>VA</ns3:stateOrProvince>
<ns3:country>USA</ns3:country>
<ns3:postalcode>20160</ns3:postalcode>
</ns3:address>
<ns3:contact type="EMAIL">abc123@cgb.com</ns3:contact>
</person>
</ns2:changePersonStatusResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: Person is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>EntityNotFoundException: Couldn't update the Person Status for personID 3047211111 as it is not found in the DB.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Invalid status is present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-enumeration-valid: Value 'INACTIVE123' is not facet-valid with respect to enumeration '[PENDING, ACTIVE, NULLIFIED, INACTIVE]'. It must be a value from the enumeration.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Person ID is not present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.a: Invalid content was found starting with element 'status'. One of '{personID}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Invalid status transition. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>CallbackException: Illegal curation transition from ACTIVE to PENDING</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation getPerson
Gets the person record by its database ID.
Request Body | getPersonRequest having personID |
---|
Response Body | getPersonResponse having person element. |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:per="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<soapenv:Header />
<soapenv:Body>
<per:getPersonRequest>
<personID>30472</personID>
</per:getPersonRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:getPersonResponse xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<person>
<ns3:id>30472</ns3:id>
<ns3:status>ACTIVE</ns3:status>
<ns3:firstName>Johny</ns3:firstName>
<ns3:lastName>Phillips</ns3:lastName>
<ns3:ctepId>66666666666</ns3:ctepId>
<ns3:address>
<ns3:line1>Legacy Cir</ns3:line1>
<ns3:line2>Apt#A</ns3:line2>
<ns3:city>Herndon</ns3:city>
<ns3:stateOrProvince>VA</ns3:stateOrProvince>
<ns3:country>USA</ns3:country>
<ns3:postalcode>20160</ns3:postalcode>
</ns3:address>
<ns3:contact type="EMAIL">abc123@cgb.com</ns3:contact>
</person>
</ns2:getPersonResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: Person is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:getPersonResponse xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/person/" />
</soap:Body>
</soap:Envelope> |
Example: Person ID is not present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.b: The content of element 'per:getPersonRequest' is not complete. One of '{personID}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation getPersonsByCtepId
Gets the person records for the given CTEP ID.
Request Body | getPersonsByCtepIdRequest having ctepID |
---|
Response Body | getPersonsByCtepIdResponse having personList (which is unbounded list of person) |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:per="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<soapenv:Header />
<soapenv:Body>
<per:getPersonsByCtepIdRequest>
<ctepID>11111</ctepID>
</per:getPersonsByCtepIdRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:getPersonsByCtepIdResponse
xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<personList>
<ns3:id>30582</ns3:id>
<ns3:status>ACTIVE</ns3:status>
<ns3:prefix>Mr</ns3:prefix>
<ns3:firstName>John</ns3:firstName>
<ns3:middleName>M</ns3:middleName>
<ns3:lastName>Phillips</ns3:lastName>
<ns3:suffix>Sr</ns3:suffix>
<ns3:ctepId>11111</ns3:ctepId>
<ns3:address>
<ns3:line1>Legacy Circle</ns3:line1>
<ns3:line2>Apt Z</ns3:line2>
<ns3:city>Herndon</ns3:city>
<ns3:stateOrProvince>VA</ns3:stateOrProvince>
<ns3:country>USA</ns3:country>
<ns3:postalcode>20171</ns3:postalcode>
</ns3:address>
<ns3:contact type="EMAIL">abc@cgb.com</ns3:contact>
<ns3:contact type="PHONE">703-123-1111</ns3:contact>
<ns3:contact type="FAX">703-123-3333</ns3:contact>
<ns3:contact type="TTY">703-123-2222</ns3:contact>
<ns3:contact type="URL">http://abc.com</ns3:contact>
</personList>
<personList>
<ns3:id>30627</ns3:id>
<ns3:status>ACTIVE</ns3:status>
<ns3:prefix>Mr</ns3:prefix>
<ns3:firstName>John</ns3:firstName>
<ns3:middleName>M</ns3:middleName>
<ns3:lastName>Phillips</ns3:lastName>
<ns3:suffix>Sr</ns3:suffix>
<ns3:ctepId>11111</ns3:ctepId>
<ns3:address>
<ns3:line1>Legacy Circle</ns3:line1>
<ns3:line2>Apt Z</ns3:line2>
<ns3:city>Herndon</ns3:city>
<ns3:stateOrProvince>VA</ns3:stateOrProvince>
<ns3:country>USA</ns3:country>
<ns3:postalcode>20171</ns3:postalcode>
</ns3:address>
<ns3:contact type="EMAIL">abc@cgb.com</ns3:contact>
<ns3:contact type="PHONE">703-123-1111</ns3:contact>
<ns3:contact type="FAX">703-123-3333</ns3:contact>
<ns3:contact type="TTY">703-123-2222</ns3:contact>
<ns3:contact type="URL">http://abc.com</ns3:contact>
</personList>
</ns2:getPersonsByCtepIdResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: No person found for the given CTEP ID. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:getPersonsByCtepIdResponse
xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/person/" />
</soap:Body>
</soap:Envelope> |
Example: CTEP ID is not present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.b: The content of element 'per:getPersonsByCtepIdRequest' is not complete. One of '{ctepID}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation searchPersons
Searches person records.
Request Body | searchPersonsRequest having personSearchCriteria element. |
---|
Response Body | searchPersonsResponse having personSearchResultList (which is unbounded list of personSearchResult) |
---|
Sample Request | Example: Search for a person by the first name "Rohit." <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:per="http://soap.simple.service.webservices.po.nci.nih.gov/person/" xmlns:gov="gov.nih.nci.po.webservices.types">
<soapenv:Header/>
<soapenv:Body>
<per:searchPersonsRequest>
<personSearchCriteria>
<gov:firstName>Rohit</gov:firstName>
</personSearchCriteria>
</per:searchPersonsRequest>
</soapenv:Body>
</soapenv:Envelope> |
Example: Search for a person by Last Name, offset, and limit. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:per="http://soap.simple.service.webservices.po.nci.nih.gov/person/"
xmlns:gov="gov.nih.nci.po.webservices.types">
<soapenv:Header />
<soapenv:Body>
<per:searchPersonsRequest>
<personSearchCriteria>
<gov:offset>2</gov:offset>
<gov:limit>2</gov:limit>
<gov:lastName>Gupta</gov:lastName>
</personSearchCriteria>
</per:searchPersonsRequest>
</soapenv:Body>
</soapenv:Envelope> |
Example: Search for a person by city. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:per="http://soap.simple.service.webservices.po.nci.nih.gov/person/"
xmlns:gov="gov.nih.nci.po.webservices.types">
<soapenv:Header />
<soapenv:Body>
<per:searchPersonsRequest>
<personSearchCriteria>
<gov:city>San Antoino</gov:city>
</personSearchCriteria>
</per:searchPersonsRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | Example: Response for a person by the first name "Rohit." <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:searchPersonsResponse xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<personSearchResultList>
<ns3:id>6245</ns3:id>
<ns3:statusCode>PENDING</ns3:statusCode>
<ns3:line1>13621 Leagcy Circle</ns3:line1>
<ns3:line2>Apt G</ns3:line2>
<ns3:city>Herndon</ns3:city>
<ns3:state>VA</ns3:state>
<ns3:countryCode>USA</ns3:countryCode>
<ns3:countryName>United States</ns3:countryName>
<ns3:postalcode>20171</ns3:postalcode>
<ns3:emailAddresses>my.email@mayoclinic.org</ns3:emailAddresses>
<ns3:phones>571-456-1245</ns3:phones>
<ns3:ctepID>25879</ns3:ctepID>
<ns3:firstName>Rohit_EYE1177bZVGqLz55rgP92UTJydpkYV</ns3:firstName>
<ns3:middleName>L</ns3:middleName>
<ns3:lastName>LmuWV7o02t2beu1n72VoOT1Zgqw76sBQPmr</ns3:lastName>
<ns3:totalCrs>0</ns3:totalCrs>
<ns3:totalHcp>0</ns3:totalHcp>
<ns3:totalOc>0</ns3:totalOc>
<ns3:totalPending>1</ns3:totalPending>
<ns3:affiliation>
<ns3:orgName>Cancer Therapy Evaluation Program</ns3:orgName>
<ns3:pending>true</ns3:pending>
<ns3:group>OPI</ns3:group>
</ns3:affiliation>
</personSearchResultList>
<personSearchResultList>
<ns3:id>6335</ns3:id>
<ns3:statusCode>PENDING</ns3:statusCode>
<ns3:line1>13621 Leagcy Circle</ns3:line1>
<ns3:line2>Apt G</ns3:line2>
<ns3:city>Herndon</ns3:city>
<ns3:state>VA</ns3:state>
<ns3:countryCode>USA</ns3:countryCode>
<ns3:countryName>United States</ns3:countryName>
<ns3:postalcode>20171</ns3:postalcode>
<ns3:emailAddresses>my.email@mayoclinic.org</ns3:emailAddresses>
<ns3:phones>571-456-1245</ns3:phones>
<ns3:ctepID>25879</ns3:ctepID>
<ns3:firstName>Rohit_живлёнымΕλάδαविप्रकुर्युर्समाचारažībs學而時習之
</ns3:firstName>
<ns3:middleName>L</ns3:middleName>
<ns3:lastName>Miller</ns3:lastName>
<ns3:totalCrs>0</ns3:totalCrs>
<ns3:totalHcp>0</ns3:totalHcp>
<ns3:totalOc>0</ns3:totalOc>
<ns3:totalPending>1</ns3:totalPending>
<ns3:affiliation>
<ns3:orgName>Cancer Therapy Evaluation Program</ns3:orgName>
<ns3:pending>true</ns3:pending>
<ns3:group>OPI</ns3:group>
</ns3:affiliation>
</personSearchResultList>
</ns2:searchPersonsResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: Search criteria are not specified. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>ServiceException: Person search couldn't be performed as search crietria is empty.com.fiveamsolutions.nci.commons.search.OneCriterionRequiredException: At least one criterion must be provided</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: No matching record found. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:searchPersonsResponse xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/person/" />
</soap:Body>
</soap:Envelope> |
|
---|
Operation createPersonRole
Creates a person role.
Request Body | createPersonRoleRequest having personRole element. |
---|
Response Body | createPersonRoleResponse having personRole element. |
---|
Sample Request | Example: Create a Healthcare Provider <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:per="http://soap.simple.service.webservices.po.nci.nih.gov/person/"
xmlns:gov="gov.nih.nci.po.webservices.types">
<soapenv:Header />
<soapenv:Body>
<per:createPersonRoleRequest>
<personRole xsi:type="gov:HealthCareProvider">
<gov:status>PENDING</gov:status>
<gov:organizationId>30780</gov:organizationId>
<gov:address>
<gov:line1>Legacy Cir</gov:line1>
<gov:line2>Apt Z</gov:line2>
<gov:city>Herndon</gov:city>
<gov:stateOrProvince>VA</gov:stateOrProvince>
<gov:country>USA</gov:country>
<gov:postalcode>20171</gov:postalcode>
</gov:address>
<gov:contact type="EMAIL">abc@xyz.com</gov:contact>
<gov:personId>30717</gov:personId>
<gov:license>some text license</gov:license>
</personRole>
</per:createPersonRoleRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:createPersonRoleResponse xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<personRole xsi:type="ns3:HealthCareProvider"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns3:id>30817</ns3:id>
<ns3:status>PENDING</ns3:status>
<ns3:organizationId>30780</ns3:organizationId>
<ns3:address>
<ns3:line1>Legacy Cir</ns3:line1>
<ns3:line2>Apt Z</ns3:line2>
<ns3:city>Herndon</ns3:city>
<ns3:stateOrProvince>VA</ns3:stateOrProvince>
<ns3:country>USA</ns3:country>
<ns3:postalcode>20171</ns3:postalcode>
</ns3:address>
<ns3:contact type="EMAIL">abc@xyz.com</ns3:contact>
<ns3:personId>30717</ns3:personId>
<ns3:license>some text license</ns3:license>
</personRole>
</ns2:createPersonRoleResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: The person is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>PropertyValueException: not-null property references a null or transient value: gov.nih.nci.po.data.bo.HealthCareProvider.player</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Organization is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>PropertyValueException: not-null property references a null or transient value: gov.nih.nci.po.data.bo.ClinicalResearchStaff.scoper</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Organization ID is not present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.a: Invalid content was found starting with element 'gov:address'. One of '{"gov.nih.nci.po.webservices.types":organizationId}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation updatePersonRole
Updates an existing person role.
Request Body | updatePersonRoleRequest having personRole element. |
---|
Response Body | updatePersonRoleResponse having personRole element. |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:per="http://soap.simple.service.webservices.po.nci.nih.gov/person/"
xmlns:gov="gov.nih.nci.po.webservices.types">
<soapenv:Header />
<soapenv:Body>
<per:updatePersonRoleRequest>
<personRole xsi:type="gov:HealthCareProvider">
<gov:id>30817</gov:id>
<gov:status>PENDING</gov:status>
<gov:organizationId>30780</gov:organizationId>
<gov:address>
<gov:line1>Legacy Cir</gov:line1>
<gov:line2>Apt Z</gov:line2>
<gov:city>Herndon</gov:city>
<gov:stateOrProvince>VA</gov:stateOrProvince>
<gov:country>USA</gov:country>
<gov:postalcode>20171</gov:postalcode>
</gov:address>
<gov:contact type="EMAIL">abc111@xyz.com</gov:contact>
<gov:personId>30717</gov:personId>
<gov:license>some text license xyz</gov:license>
</personRole>
</per:updatePersonRoleRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:updatePersonRoleResponse xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<personRole xsi:type="ns3:HealthCareProvider"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns3:id>30817</ns3:id>
<ns3:status>PENDING</ns3:status>
<ns3:organizationId>30780</ns3:organizationId>
<ns3:address>
<ns3:line1>Legacy Cir</ns3:line1>
<ns3:line2>Apt Z</ns3:line2>
<ns3:city>Herndon</ns3:city>
<ns3:stateOrProvince>VA</ns3:stateOrProvince>
<ns3:country>USA</ns3:country>
<ns3:postalcode>20171</ns3:postalcode>
</ns3:address>
<ns3:contact type="EMAIL">abc111@xyz.com</ns3:contact>
<ns3:personId>30717</ns3:personId>
<ns3:license>some text license xyz</ns3:license>
</personRole>
</ns2:updatePersonRoleResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: "ID" is not present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>ServiceException: The PersonRole couldn't be updated as either personRole or personRoleId is null.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Person Role is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>ObjectNotFoundException: No row with the given identifier exists: [gov.nih.nci.po.data.bo.ClinicalResearchStaff#28211062]</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Person is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>PropertyValueException: not-null property references a null or transient value: gov.nih.nci.po.data.bo.HealthCareProvider.player</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation changePersonRoleStatus
Changes the status of an existing person role.
Request Body | changePersonRoleStatusRequest having roleType, personRoleID, and status. |
---|
Response Body | changePersonRoleStatusResponse having personRole element. |
---|
Sample Request | Example: Change the status of a Healthcare Provider role. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:per="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<soapenv:Header />
<soapenv:Body>
<per:changePersonRoleStatusRequest>
<roleType>HealthCareProvider</roleType>
<personRoleID>30817</personRoleID>
<status>INACTIVE</status>
</per:changePersonRoleStatusRequest>
</soapenv:Body>
</soapenv:Envelope> |
Example: Change the status of a Clinical Research Staff role. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:per="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<soapenv:Header />
<soapenv:Body>
<per:changePersonRoleStatusRequest>
<roleType>ClinicalResearchStaff</roleType>
<personRoleID>34666</personRoleID>
<status>PENDING</status>
</per:changePersonRoleStatusRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:changePersonRoleStatusResponse
xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<personRole xsi:type="ns3:HealthCareProvider"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns3:id>30817</ns3:id>
<ns3:status>INACTIVE</ns3:status>
<ns3:organizationId>30780</ns3:organizationId>
<ns3:address>
<ns3:line1>Legacy Cir</ns3:line1>
<ns3:line2>Apt Z</ns3:line2>
<ns3:city>Herndon</ns3:city>
<ns3:stateOrProvince>VA</ns3:stateOrProvince>
<ns3:country>USA</ns3:country>
<ns3:postalcode>20171</ns3:postalcode>
</ns3:address>
<ns3:contact type="EMAIL">abc111@xyz.com</ns3:contact>
<ns3:personId>30717</ns3:personId>
<ns3:license>some text license xyz</ns3:license>
</personRole>
</ns2:changePersonRoleStatusResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: Person Role for the given ID is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>EntityNotFoundException: Couldn't update the PersonRole Status for personRoleID 1234 as it is not found in the DB.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Invalid transition. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>CallbackException: Illegal curation transition from SUSPENDED to PENDING</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Invalid status is present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-enumeration-valid: Value 'sadf' is not facet-valid with respect to enumeration '[PENDING, ACTIVE, NULLIFIED, INACTIVE]'. It must be a value from the enumeration.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation getPersonRolesByPersonId
Gets the person roles for a given person ID.
Request Body | getPersonRolesByPersonIdRequest having personID |
---|
Response Body | getPersonRolesByPersonIdResponse having personRoleList (which is unbounded list of personRole). |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:per="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<soapenv:Header />
<soapenv:Body>
<per:getPersonRolesByPersonIdRequest>
<personID>30717</personID>
</per:getPersonRolesByPersonIdRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:getPersonRolesByPersonIdResponse
xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<personRoleList xsi:type="ns3:HealthCareProvider"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns3:id>30817</ns3:id>
<ns3:status>INACTIVE</ns3:status>
<ns3:organizationId>30780</ns3:organizationId>
<ns3:address>
<ns3:line1>Legacy Cir</ns3:line1>
<ns3:line2>Apt Z</ns3:line2>
<ns3:city>Herndon</ns3:city>
<ns3:stateOrProvince>VA</ns3:stateOrProvince>
<ns3:country>USA</ns3:country>
<ns3:postalcode>20171</ns3:postalcode>
</ns3:address>
<ns3:contact type="EMAIL">abc111@xyz.com</ns3:contact>
<ns3:personId>30717</ns3:personId>
<ns3:license>some text license xyz</ns3:license>
</personRoleList>
<personRoleList xsi:type="ns3:ClinicalResearchStaff"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns3:id>30908</ns3:id>
<ns3:status>PENDING</ns3:status>
<ns3:organizationId>30780</ns3:organizationId>
<ns3:address>
<ns3:line1>Legacy Cir</ns3:line1>
<ns3:line2>Apt Z</ns3:line2>
<ns3:city>Herndon</ns3:city>
<ns3:stateOrProvince>VA</ns3:stateOrProvince>
<ns3:country>USA</ns3:country>
<ns3:postalcode>20171</ns3:postalcode>
</ns3:address>
<ns3:contact type="EMAIL">abc@xyz.com</ns3:contact>
<ns3:personId>30717</ns3:personId>
</personRoleList>
</ns2:getPersonRolesByPersonIdResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: Person is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>EntityNotFoundException: The PersonRole couldn't be fetched as person with the given ID 11111111111 is not found.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Person ID is not present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.b: The content of element 'per:getPersonRolesByPersonIdRequest' is not complete. One of '{personID}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Person does not have a Person Role. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:getPersonRolesByPersonIdResponse
xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/person/" />
</soap:Body>
</soap:Envelope> |
|
---|
Operation getPersonRoleById
Gets the person role by ID.
Request Body | getPersonRoleByIdRequest having roleType and personRoleID. |
---|
Response Body | getPersonRoleByIdResponse having personRole element. |
---|
Sample Request | Example: Get a Healthcare Provider. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:per="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<soapenv:Header />
<soapenv:Body>
<per:getPersonRoleByIdRequest>
<roleType>HealthCareProvider</roleType>
<personRoleID>30817</personRoleID>
</per:getPersonRoleByIdRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:getPersonRoleByIdResponse
xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/person/">
<personRole xsi:type="ns3:HealthCareProvider"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns3:id>30817</ns3:id>
<ns3:status>INACTIVE</ns3:status>
<ns3:organizationId>30780</ns3:organizationId>
<ns3:address>
<ns3:line1>Legacy Cir</ns3:line1>
<ns3:line2>Apt Z</ns3:line2>
<ns3:city>Herndon</ns3:city>
<ns3:stateOrProvince>VA</ns3:stateOrProvince>
<ns3:country>USA</ns3:country>
<ns3:postalcode>20171</ns3:postalcode>
</ns3:address>
<ns3:contact type="EMAIL">abc111@xyz.com</ns3:contact>
<ns3:personId>30717</ns3:personId>
<ns3:license>some text license xyz</ns3:license>
</personRole>
</ns2:getPersonRoleByIdResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: Role for the given Type and ID is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:getPersonRoleByIdResponse
xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/person/" />
</soap:Body>
</soap:Envelope> |
Example: Invalid RoleType is specified. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-enumeration-valid: Value 'HealthCareProvider_invalid' is not facet-valid with respect to enumeration '[HealthCareProvider, OrganizationalContact, ClinicalResearchStaff]'. It must be a value from the enumeration.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Person Role ID is not specified in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.b: The content of element 'per:getPersonRoleByIdRequest' is not complete. One of '{personRoleID}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Organization Service
The following sections list operations provided by the Organization web service.
Operation createOrganization
Creates an organization record in the PO database.
Request Body | createOrganizationRequest having organization element. |
---|
Response Body | createOrganizationResponse having organization element. |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:org="http://soap.simple.service.webservices.po.nci.nih.gov/organization/" xmlns:gov="gov.nih.nci.po.webservices.types">
<soapenv:Header/>
<soapenv:Body>
<org:createOrganizationRequest>
<organization>
<gov:status>ACTIVE</gov:status>
<gov:name>Mayo Clinic Organization</gov:name>
<gov:address>
<gov:line1>200 First Street Southwest</gov:line1>
<!--Optional:-->
<gov:line2>Test</gov:line2>
<gov:city>Rochester</gov:city>
<!--Optional:-->
<gov:stateOrProvince>MN</gov:stateOrProvince>
<gov:country>USA</gov:country>
<!--Optional:-->
<gov:postalcode>55905</gov:postalcode>
</gov:address>
<!--Zero or more repetitions:-->
<gov:contact type="EMAIL">mayo.test@mail.nih.gov</gov:contact>
<gov:contact type="PHONE">111-222-3333</gov:contact>
<gov:contact type="FAX">111-222-3344</gov:contact>
<gov:contact type="TTY">111-222-3355</gov:contact>
<gov:contact type="URL">http://www.mayoclinic.org</gov:contact>
</organization>
</org:createOrganizationRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns3:createOrganizationResponse xmlns:ns3="http://soap.simple.service.webservices.po.nci.nih.gov/organization/" xmlns:ns2="gov.nih.nci.po.webservices.types">
<organization>
<ns2:id>4001</ns2:id>
<ns2:status>ACTIVE</ns2:status>
<ns2:name>Mayo Clinic Organization</ns2:name>
<ns2:ctepId>111111</ns2:ctepId>
<ns2:address>
<ns2:line1>200 First Street Southwest</ns2:line1>
<ns2:line2>Test</ns2:line2>
<ns2:city>Rochester</ns2:city>
<ns2:stateOrProvince>MN</ns2:stateOrProvince>
<ns2:country>USA</ns2:country>
<ns2:postalcode>55905</ns2:postalcode>
</ns2:address>
<ns2:contact type="EMAIL">mayo.test@mail.nih.gov</ns2:contact>
<ns2:contact type="PHONE">111-222-3333</ns2:contact>
<ns2:contact type="FAX">111-222-3344</ns2:contact>
<ns2:contact type="TTY">111-222-3355</ns2:contact>
<ns2:contact type="URL">http://www.mayoclinic.org</ns2:contact>
</organization>
</ns3:createOrganizationResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: "ID" is present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>IllegalArgumentException: id must be null on calls to create!</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Address is not present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.a: Invalid content was found starting with element 'gov:contact'. One of '{"gov.nih.nci.po.webservices.types":address}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Invalid phone number is present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>Organization couldn't be created as data is invalid. The invalid elements are: Phone number 111-222-3333-5555</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation updateOrganization
Updates an existing organization record for a given organization ID.
Request Body | updateOrganizationRequest having organization element. |
---|
Response Body | updateOrganizationResponse having organization element. |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:org="http://soap.simple.service.webservices.po.nci.nih.gov/organization/" xmlns:gov="gov.nih.nci.po.webservices.types">
<soapenv:Header/>
<soapenv:Body>
<org:updateOrganizationRequest>
<organization>
<!--Optional:-->
<gov:id>4001</gov:id>
<gov:status>ACTIVE</gov:status>
<gov:name>Mayo Clinic Organization123</gov:name>
<gov:address>
<gov:line1>2003 First Street Southwest</gov:line1>
<!--Optional:-->
<gov:line2>Test1233</gov:line2>
<gov:city>Rochester</gov:city>
<!--Optional:-->
<gov:stateOrProvince>WV</gov:stateOrProvince>
<gov:country>USA</gov:country>
<!--Optional:-->
<gov:postalcode>55905</gov:postalcode>
</gov:address>
<!--Zero or more repetitions:-->
<gov:contact type="EMAIL">mayo.up.test@mail.nih.gov</gov:contact>
<gov:contact type="PHONE">444-222-3333</gov:contact>
<gov:contact type="FAX">444-222-3344</gov:contact>
<gov:contact type="TTY">444-222-3355</gov:contact>
<gov:contact type="URL">http://www.updatedmayoclinic.org</gov:contact>
</organization>
</org:updateOrganizationRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns3:updateOrganizationResponse xmlns:ns3="http://soap.simple.service.webservices.po.nci.nih.gov/organization/" xmlns:ns2="gov.nih.nci.po.webservices.types">
<organization>
<ns2:id>4001</ns2:id>
<ns2:status>ACTIVE</ns2:status>
<ns2:name>Mayo Clinic Organization</ns2:name>
<ns2:ctepId>444444444</ns2:ctepId>
<ns2:address>
<ns2:line1>2003 First Street Southwest</ns2:line1>
<ns2:line2>Test1233</ns2:line2>
<ns2:city>Rochester</ns2:city>
<ns2:stateOrProvince>WV</ns2:stateOrProvince>
<ns2:country>USA</ns2:country>
<ns2:postalcode>55905</ns2:postalcode>
</ns2:address>
<ns2:contact type="EMAIL">mayo.up.test@mail.nih.gov</ns2:contact>
<ns2:contact type="PHONE">444-222-3333</ns2:contact>
<ns2:contact type="FAX">444-222-3344</ns2:contact>
<ns2:contact type="TTY">444-222-3355</ns2:contact>
<ns2:contact type="URL">http://www.updatedmayoclinic.org</ns2:contact>
</organization>
</ns3:updateOrganizationResponse>
</soap:Body>
</soap:Envelope> |
The updated organization name is added as an alias (not part of response - but search will return this alias). |
---|
Exception Messages | Example: Organization is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>EntityNotFoundException: Couldn't update the Organization for organizationID 2821010311111 as Organization is not found in the DB.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: "ID" is not present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>ServiceException: The Organization couldn't be updated as either organization or organizationId is null.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Address is not present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.a: Invalid content was found starting with element 'gov:contact'. One of '{"gov.nih.nci.po.webservices.types":ctepId, "gov.nih.nci.po.webservices.types":address}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Invalid email is present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>InvalidStateException: validation failed for: gov.nih.nci.po.data.bo.Email</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation changeOrganizationStatusChanges the status of the organization record for a given Organization ID. Request Body | changeOrganizationStatusRequest having organizationID and status. |
---|
Response Body | changeOrganizationStatusResponse having organization element. |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:org="http://soap.simple.service.webservices.po.nci.nih.gov/organization/">
<soapenv:Header/>
<soapenv:Body>
<org:changeOrganizationStatusRequest>
<organizationID>4001</organizationID>
<status>INACTIVE</status>
</org:changeOrganizationStatusRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns3:changeOrganizationStatusResponse xmlns:ns3="http://soap.simple.service.webservices.po.nci.nih.gov/organization/" xmlns:ns2="gov.nih.nci.po.webservices.types">
<organization>
<ns2:id>4001</ns2:id>
<ns2:status>INACTIVE</ns2:status>
<ns2:name>Mayo Clinic Organization</ns2:name>
<ns2:ctepId>444444444</ns2:ctepId>
<ns2:address>
<ns2:line1>2003 First Street Southwest</ns2:line1>
<ns2:line2>Test1233</ns2:line2>
<ns2:city>Rochester</ns2:city>
<ns2:stateOrProvince>WV</ns2:stateOrProvince>
<ns2:country>USA</ns2:country>
<ns2:postalcode>55905</ns2:postalcode>
</ns2:address>
<ns2:contact type="EMAIL">mayo.up.test@mail.nih.gov</ns2:contact>
<ns2:contact type="PHONE">444-222-3333</ns2:contact>
<ns2:contact type="FAX">444-222-3344</ns2:contact>
<ns2:contact type="TTY">444-222-3355</ns2:contact>
<ns2:contact type="URL">http://www.updatedmayoclinic.org</ns2:contact>
</organization>
</ns3:changeOrganizationStatusResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: Organization is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>EntityNotFoundException: Couldn't update the Organization Status for organizationID 121212121 as Organization is not found in the DB.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Invalid status is present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-enumeration-valid: Value 'ACTIVE123' is not facet-valid with respect to enumeration '[PENDING, ACTIVE, NULLIFIED, INACTIVE]'. It must be a value from the enumeration.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Organization ID is not present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.a: Invalid content was found starting with element 'status'. One of '{organizationID}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Invalid status transition. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>CallbackException: Illegal curation transition from ACTIVE to PENDING</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
|
Operation getOrganization
Gets the organization record by organization database ID.
Request Body | getOrganizationRequest having organizationID. |
---|
Response Body | getOrganizationResponse having organization element. |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:org="http://soap.simple.service.webservices.po.nci.nih.gov/organization/">
<soapenv:Header />
<soapenv:Body>
<org:getOrganizationRequest>
<organizationID>30927</organizationID>
</org:getOrganizationRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns3:getOrganizationResponse
xmlns:ns3="http://soap.simple.service.webservices.po.nci.nih.gov/organization/"
xmlns:ns2="gov.nih.nci.po.webservices.types">
<organization>
<ns2:id>30927</ns2:id>
<ns2:status>ACTIVE</ns2:status>
<ns2:name>Mayo Clinic Test22</ns2:name>
<ns2:address>
<ns2:line1>200 First Street Southwest</ns2:line1>
<ns2:line2>Test123</ns2:line2>
<ns2:city>Rochester</ns2:city>
<ns2:stateOrProvince>WV</ns2:stateOrProvince>
<ns2:country>USA</ns2:country>
<ns2:postalcode>55905</ns2:postalcode>
</ns2:address>
<ns2:contact type="EMAIL">mayo.test@mail.nih.gov</ns2:contact>
<ns2:contact type="PHONE">111-222-3333</ns2:contact>
<ns2:contact type="FAX">111-222-3344</ns2:contact>
<ns2:contact type="TTY">111-222-3355</ns2:contact>
<ns2:contact type="URL">http://www.mayoclinic.org</ns2:contact>
</organization>
</ns3:getOrganizationResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: Organization is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns3:getOrganizationResponse
xmlns:ns3="http://soap.simple.service.webservices.po.nci.nih.gov/organization/"
xmlns:ns2="gov.nih.nci.po.webservices.types" />
</soap:Body>
</soap:Envelope> |
Example: Organization ID is not present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.b: The content of element 'org:getOrganizationRequest' is not complete. One of '{organizationID}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation searchOrganizations
Searches organization records.
Request Body | searchOrganizationsRequest having organizationSearchCriteria element. |
---|
Response Body | searchOrganizationsResponse having organizationSearchResultList (which is unbounded list of organizationSearchResult) |
---|
Sample Request | Example: Search organizations by the name "Mayo: (with offset and limit; and searchAliases is TRUE. Also inclludes a search by alias. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:org="http://soap.simple.service.webservices.po.nci.nih.gov/organization/" xmlns:gov="gov.nih.nci.po.webservices.types">
<soapenv:Header/>
<soapenv:Body>
<org:searchOrganizationsRequest>
<organizationSearchCriteria>
<gov:offset>1</gov:offset>
<gov:limit>1</gov:limit>
<gov:organizationName>Mayo</gov:organizationName>
<gov:searchAliases>true</gov:searchAliases>
</organizationSearchCriteria>
</org:searchOrganizationsRequest>
</soapenv:Body>
</soapenv:Envelope> |
Example: Search the organizations on the basis of City and State: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:org="http://soap.simple.service.webservices.po.nci.nih.gov/organization/"
xmlns:gov="gov.nih.nci.po.webservices.types">
<soapenv:Header />
<soapenv:Body>
<org:searchOrganizationsRequest>
<organizationSearchCriteria>
<gov:city>Rockville</gov:city>
<gov:stateOrProvince>MD</gov:stateOrProvince>
</organizationSearchCriteria>
</org:searchOrganizationsRequest>
</soapenv:Body>
</soapenv:Envelope> |
- When specifying Boolean fields like hasPendingRoRoles, the value true or 1 is accepted while false or 0 is ignored during search. This is similar to the behavior is UI where false/0 is equal to not specifying/selecting that field.
- When searching the Organizations using CTEP ID, it will search for the IO CTEP Ids apart from HCF and RO CTEP ID.
- The searchResult has alias in the response. They are NOT part of create/update request/response.
|
|
---|
Sample Response | Search result for the Organizations having name like Mayo: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns3:searchOrganizationsResponse xmlns:ns3="http://soap.simple.service.webservices.po.nci.nih.gov/organization/" xmlns:ns2="gov.nih.nci.po.webservices.types">
<organizationSearchResultList>
<ns2:id>4001</ns2:id>
<ns2:statusCode>INACTIVE</ns2:statusCode>
<ns2:line1>2003 First Street Southwest</ns2:line1>
<ns2:line2>Test1233</ns2:line2>
<ns2:city>Rochester</ns2:city>
<ns2:state>WV</ns2:state>
<ns2:countryCode>USA</ns2:countryCode>
<ns2:countryName>United States</ns2:countryName>
<ns2:postalcode>55905</ns2:postalcode>
<ns2:emailAddresses>mayo.up.test@mail.nih.gov</ns2:emailAddresses>
<ns2:phones>444-222-3333</ns2:phones>
<ns2:organizationName>Mayo Clinic Organization</ns2:organizationName>
<ns2:orgCtepId>444444444</ns2:orgCtepId>
<ns2:changeRequests>0</ns2:changeRequests>
<ns2:pendingROs>0</ns2:pendingROs>
<ns2:pendingHCFs>0</ns2:pendingHCFs>
<ns2:statusDate>2014-07-28-04:00</ns2:statusDate>
<ns2:totalROs>0</ns2:totalROs>
<ns2:totalHCFs>0</ns2:totalHCFs>
<ns2:totalIdOrgs>1</ns2:totalIdOrgs>
<ns2:totalOversightCommitees>0</ns2:totalOversightCommitees>
<ns2:totalOrgContacts>0</ns2:totalOrgContacts>
<ns2:alias>Mayo Clinic Organization123</ns2:alias>
</organizationSearchResultList>
</ns3:searchOrganizationsResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: Search criteria are not specified. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>ServiceException: Organization search couldn't be performed as search crietria is empty.com.fiveamsolutions.nci.commons.search.OneCriterionRequiredException: At least one criterion must be provided</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: No matching record found. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns3:searchOrganizationsResponse
xmlns:ns3="http://soap.simple.service.webservices.po.nci.nih.gov/organization/"
xmlns:ns2="gov.nih.nci.po.webservices.types" />
</soap:Body>
</soap:Envelope> |
|
---|
Operation createOrganizationRole
Creates an organization role.
Request Body | createOrganizationRoleRequest having organizationRole element. |
---|
Response Body | createOrganizationRoleResponse having organizationRole element. |
---|
Sample Request | Example: Creating a Health CareFacility. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:org="http://soap.simple.service.webservices.po.nci.nih.gov/organization/"
xmlns:gov="gov.nih.nci.po.webservices.types">
<soapenv:Header />
<soapenv:Body>
<org:createOrganizationRoleRequest>
<organizationRole xsi:type="gov:HealthCareFacility">
<gov:status>PENDING</gov:status>
<gov:organizationId>31033</gov:organizationId>
<gov:address>
<gov:line1>170 Calle Villarroel</gov:line1>
<gov:city>Barcelona</gov:city>
<gov:country>ESP</gov:country>
<gov:postalcode>08036</gov:postalcode>
</gov:address>
<gov:contact type="EMAIL">xyzz@abccc.com</gov:contact>
<gov:name>Hospital ClinicProvincial</gov:name>
</organizationRole>
</org:createOrganizationRoleRequest>
</soapenv:Body>
</soapenv:Envelope> |
Sample request for creating a OversightCommittee: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:org="http://soap.simple.service.webservices.po.nci.nih.gov/organization/"
xmlns:gov="gov.nih.nci.po.webservices.types">
<soapenv:Header />
<soapenv:Body>
<org:createOrganizationRoleRequest>
<organizationRole xsi:type="gov:OversightCommittee">
<gov:status>PENDING</gov:status>
<gov:organizationId>31033</gov:organizationId>
<gov:address>
<gov:line1>13921 Park Centre Rd</gov:line1>
<gov:line2>Suite 420</gov:line2>
<gov:city>Herndon</gov:city>
<gov:stateOrProvince>VA</gov:stateOrProvince>
<gov:country>USA</gov:country>
<gov:postalcode>20171</gov:postalcode>
</gov:address>
<gov:contact type="EMAIL">xyzz@abccc.com</gov:contact>
<gov:type>Research Ethics Board</gov:type>
</organizationRole>
</org:createOrganizationRoleRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | Sample response for create HealthCareFacility: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns3:createOrganizationRoleResponse xmlns:ns3="http://soap.simple.service.webservices.po.nci.nih.gov/organization/" xmlns:ns2="gov.nih.nci.po.webservices.types">
<organizationRole xsi:type="ns2:HealthCareFacility" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns2:id>31070</ns2:id>
<ns2:status>PENDING</ns2:status>
<ns2:organizationId>31033</ns2:organizationId>
<ns2:address>
<ns2:line1>170 Calle Villarroel</ns2:line1>
<ns2:city>Barcelona</ns2:city>
<ns2:country>ESP</ns2:country>
<ns2:postalcode>08036</ns2:postalcode>
</ns2:address>
<ns2:contact type="EMAIL">xyzz@abccc.com</ns2:contact>
<ns2:name>Hospital ClinicProvincial</ns2:name>
<ns2:ctepId>123</ns2:ctepId>
</organizationRole>
</ns3:createOrganizationRoleResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: Organization is not found in the database (during creation of ResearchOrganization). <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>Exception occured while creating the OrganizationRole for organizationID 4001111. The invalid elements are: player</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Organization ID is not present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.a: Invalid content was found starting with element 'gov:address'. One of '{"gov.nih.nci.po.webservices.types":organizationId}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation updateOrganizationRole
Updates an existing organization role for a given type and ID.
Request Body | updateOrganizationRoleRequest having organizationRole element. |
---|
Response Body | updateOrganizationRoleResponse having organizationRole element. |
---|
Sample Request | Example: Update a Healthcare Facility. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:org="http://soap.simple.service.webservices.po.nci.nih.gov/organization/"
xmlns:gov="gov.nih.nci.po.webservices.types">
<soapenv:Header />
<soapenv:Body>
<org:updateOrganizationRoleRequest>
<organizationRole xsi:type="gov:HealthCareFacility">
<gov:id>31070</gov:id>
<gov:status>PENDING</gov:status>
<gov:organizationId>31033</gov:organizationId>
<gov:address>
<gov:line1>13921 Park Centre Rd123</gov:line1>
<gov:line2>Suite 4100</gov:line2>
<gov:city>Reston</gov:city>
<gov:stateOrProvince>WV</gov:stateOrProvince>
<gov:country>USA</gov:country>
<gov:postalcode>20171</gov:postalcode>
</gov:address>
<gov:contact type="EMAIL">xyzacbz@abccc.com</gov:contact>
<gov:name>MyHCF111</gov:name>
</organizationRole>
</org:updateOrganizationRoleRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | Sample response for update HealthCareFacility: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns3:updateOrganizationRoleResponse
xmlns:ns3="http://soap.simple.service.webservices.po.nci.nih.gov/organization/"
xmlns:ns2="gov.nih.nci.po.webservices.types">
<organizationRole xsi:type="ns2:HealthCareFacility"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns2:id>31070</ns2:id>
<ns2:status>PENDING</ns2:status>
<ns2:organizationId>31033</ns2:organizationId>
<ns2:address>
<ns2:line1>13921 Park Centre Rd123</ns2:line1>
<ns2:line2>Suite 4100</ns2:line2>
<ns2:city>Reston</ns2:city>
<ns2:stateOrProvince>WV</ns2:stateOrProvince>
<ns2:country>USA</ns2:country>
<ns2:postalcode>20171</ns2:postalcode>
</ns2:address>
<ns2:contact type="EMAIL">xyzacbz@abccc.com</ns2:contact>
<ns2:name>MyHCF111</ns2:name>
<ns2:ctepId>22222</ns2:ctepId>
</organizationRole>
</ns3:updateOrganizationRoleResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: "ID" is not present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>ServiceException: The OrganizationRole couldn't be updated as either organizationRole or organizationRoleId is null.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Organization Role is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>EntityNotFoundException: The OrganizationRole couldn't be updated for ID 28210279111 as OrganizationRole is not found in the DB.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Organization is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>PropertyValueException: not-null property references a null or transient value: gov.nih.nci.po.data.bo.HealthCareFacility.player</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation changeOrganizationRoleStatus
Changes the status of an existing organization role for a given role type and organization role ID.
Request Body | changeOrganizationRoleStatusRequest having roleType, organizationRoleID and status element. |
---|
Response Body | changeOrganizationRoleStatusResponse having organizationRole element. |
---|
Sample Request | Example: Change the status of a HealthcareFacility: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:org="http://soap.simple.service.webservices.po.nci.nih.gov/organization/">
<soapenv:Header />
<soapenv:Body>
<org:changeOrganizationRoleStatusRequest>
<roleType>HealthCareFacility</roleType>
<organizationRoleID>31070</organizationRoleID>
<status>INACTIVE</status>
</org:changeOrganizationRoleStatusRequest>
</soapenv:Body>
</soapenv:Envelope> |
Example: Cange the status of an Oversight Committee. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:org="http://soap.simple.service.webservices.po.nci.nih.gov/organization/">
<soapenv:Header />
<soapenv:Body>
<org:changeOrganizationRoleStatusRequest>
<roleType>OversightCommittee</roleType>
<organizationRoleID>28210306</organizationRoleID>
<status>PENDING</status>
</org:changeOrganizationRoleStatusRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | Sample response for status change of HealthCareFacility: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns3:changeOrganizationRoleStatusResponse
xmlns:ns3="http://soap.simple.service.webservices.po.nci.nih.gov/organization/"
xmlns:ns2="gov.nih.nci.po.webservices.types">
<organizationRole xsi:type="ns2:HealthCareFacility"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns2:id>31070</ns2:id>
<ns2:status>INACTIVE</ns2:status>
<ns2:organizationId>31033</ns2:organizationId>
<ns2:address>
<ns2:line1>13921 Park Centre Rd123</ns2:line1>
<ns2:line2>Suite 4100</ns2:line2>
<ns2:city>Reston</ns2:city>
<ns2:stateOrProvince>WV</ns2:stateOrProvince>
<ns2:country>USA</ns2:country>
<ns2:postalcode>20171</ns2:postalcode>
</ns2:address>
<ns2:contact type="EMAIL">xyzacbz@abccc.com</ns2:contact>
<ns2:name>MyHCF111</ns2:name>
<ns2:ctepId>22222</ns2:ctepId>
</organizationRole>
</ns3:changeOrganizationRoleStatusResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: Organization Role for the given ID is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>EntityNotFoundException: Couldn't update the OrganizationRole Status for orgRoleID 282103061111 as OrganizationRole is not found in the DB.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Invalid transition. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>CallbackException: Illegal curation transition from SUSPENDED to PENDING</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Invalid status is present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-enumeration-valid: Value 'ACTIVE123' is not facet-valid with respect to enumeration '[PENDING, ACTIVE, NULLIFIED, INACTIVE]'. It must be a value from the enumeration.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation getOrganizationRolesByOrgId
Gets the organization role by given organization database ID.
Request Body | getOrganizationRolesByOrgIdRequest having organizationID. |
---|
Response Body | getOrganizationRolesByOrgIdResponse having organizationRoleList (which is unbounded list of organizationRole). |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:org="http://soap.simple.service.webservices.po.nci.nih.gov/organization/">
<soapenv:Header />
<soapenv:Body>
<org:getOrganizationRolesByOrgIdRequest>
<organizationID>31033</organizationID>
</org:getOrganizationRolesByOrgIdRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns3:getOrganizationRolesByOrgIdResponse
xmlns:ns3="http://soap.simple.service.webservices.po.nci.nih.gov/organization/"
xmlns:ns2="gov.nih.nci.po.webservices.types">
<organizationRoleList xsi:type="ns2:OversightCommittee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns2:id>31088</ns2:id>
<ns2:status>PENDING</ns2:status>
<ns2:organizationId>31033</ns2:organizationId>
<ns2:address>
<ns2:line1>13921 Park Centre Rd</ns2:line1>
<ns2:line2>Suite 420</ns2:line2>
<ns2:city>Herndon</ns2:city>
<ns2:stateOrProvince>VA</ns2:stateOrProvince>
<ns2:country>USA</ns2:country>
<ns2:postalcode>20171</ns2:postalcode>
</ns2:address>
<ns2:contact type="EMAIL">xyzz@abccc.com</ns2:contact>
<ns2:type>Research Ethics Board</ns2:type>
</organizationRoleList>
<organizationRoleList xsi:type="ns2:HealthCareFacility"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns2:id>31070</ns2:id>
<ns2:status>INACTIVE</ns2:status>
<ns2:organizationId>31033</ns2:organizationId>
<ns2:address>
<ns2:line1>13921 Park Centre Rd123</ns2:line1>
<ns2:line2>Suite 4100</ns2:line2>
<ns2:city>Reston</ns2:city>
<ns2:stateOrProvince>WV</ns2:stateOrProvince>
<ns2:country>USA</ns2:country>
<ns2:postalcode>20171</ns2:postalcode>
</ns2:address>
<ns2:contact type="EMAIL">xyzacbz@abccc.com</ns2:contact>
<ns2:name>MyHCF111</ns2:name>
<ns2:ctepId>22222</ns2:ctepId>
</organizationRoleList>
</ns3:getOrganizationRolesByOrgIdResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: Organization is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>EntityNotFoundException: The OrganizationRole couldn't be fetched as organization with the given ID 28207669111 is not found.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Organization has no Organization Roles. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns3:getOrganizationRolesByOrgIdResponse
xmlns:ns3="http://soap.simple.service.webservices.po.nci.nih.gov/organization/"
xmlns:ns2="gov.nih.nci.po.webservices.types" />
</soap:Body>
</soap:Envelope> |
Example: Organization ID is not present in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.b: The content of element 'org:getOrganizationRolesByOrgIdRequest' is not complete. One of '{organizationID}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation getOrganizationRolesByCtepId
Gets the organization roles for a given CTEP ID.
Request Body | getOrganizationRolesByCtepIdRequest having ctepID. |
---|
Response Body | getOrganizationRolesByCtepIdResponse having organizationRoleList (which is unbounded list of organizationRole). |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:org="http://soap.simple.service.webservices.po.nci.nih.gov/organization/">
<soapenv:Header />
<soapenv:Body>
<org:getOrganizationRolesByCtepIdRequest>
<ctepID>22222</ctepID>
</org:getOrganizationRolesByCtepIdRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns3:getOrganizationRolesByCtepIdResponse
xmlns:ns3="http://soap.simple.service.webservices.po.nci.nih.gov/organization/"
xmlns:ns2="gov.nih.nci.po.webservices.types">
<organizationRoleList xsi:type="ns2:HealthCareFacility"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns2:id>31070</ns2:id>
<ns2:status>INACTIVE</ns2:status>
<ns2:organizationId>31033</ns2:organizationId>
<ns2:address>
<ns2:line1>13921 Park Centre Rd123</ns2:line1>
<ns2:line2>Suite 4100</ns2:line2>
<ns2:city>Reston</ns2:city>
<ns2:stateOrProvince>WV</ns2:stateOrProvince>
<ns2:country>USA</ns2:country>
<ns2:postalcode>20171</ns2:postalcode>
</ns2:address>
<ns2:contact type="EMAIL">xyzacbz@abccc.com</ns2:contact>
<ns2:name>MyHCF111</ns2:name>
<ns2:ctepId>22222</ns2:ctepId>
</organizationRoleList>
</ns3:getOrganizationRolesByCtepIdResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: No Organizational Roles found for the given CTEP ID. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns3:getOrganizationRolesByCtepIdResponse
xmlns:ns3="http://soap.simple.service.webservices.po.nci.nih.gov/organization/"
xmlns:ns2="gov.nih.nci.po.webservices.types" />
</soap:Body>
</soap:Envelope> |
Example: CTEP is not specified in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.b: The content of element 'org:getOrganizationRolesByCtepIdRequest' is not complete. One of '{ctepID}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation getOrganizationRoleById
Gets the organization role for a given organization role type and organization role ID.
Request Body | getOrganizationRoleByIdRequest having roleType and organizationRoleID. |
---|
Response Body | getOrganizationRoleByIdResponse having organizationRole element. |
---|
Sample Request | Example: Get a Healthcare Facility by its ID. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:org="http://soap.simple.service.webservices.po.nci.nih.gov/organization/">
<soapenv:Header />
<soapenv:Body>
<org:getOrganizationRoleByIdRequest>
<roleType>HealthCareFacility</roleType>
<organizationRoleID>31070</organizationRoleID>
</org:getOrganizationRoleByIdRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | Sample response for HealthCareFacility: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns3:getOrganizationRoleByIdResponse
xmlns:ns3="http://soap.simple.service.webservices.po.nci.nih.gov/organization/"
xmlns:ns2="gov.nih.nci.po.webservices.types">
<organizationRole xsi:type="ns2:HealthCareFacility"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns2:id>31070</ns2:id>
<ns2:status>INACTIVE</ns2:status>
<ns2:organizationId>31033</ns2:organizationId>
<ns2:address>
<ns2:line1>13921 Park Centre Rd123</ns2:line1>
<ns2:line2>Suite 4100</ns2:line2>
<ns2:city>Reston</ns2:city>
<ns2:stateOrProvince>WV</ns2:stateOrProvince>
<ns2:country>USA</ns2:country>
<ns2:postalcode>20171</ns2:postalcode>
</ns2:address>
<ns2:contact type="EMAIL">xyzacbz@abccc.com</ns2:contact>
<ns2:name>MyHCF111</ns2:name>
<ns2:ctepId>22222</ns2:ctepId>
</organizationRole>
</ns3:getOrganizationRoleByIdResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: Role for the given Type and ID is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns3:getOrganizationRoleByIdResponse
xmlns:ns3="http://soap.simple.service.webservices.po.nci.nih.gov/organization/"
xmlns:ns2="gov.nih.nci.po.webservices.types" />
</soap:Body>
</soap:Envelope> |
Example: Invalid Role Type is specified. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-enumeration-valid: Value 'OversightCommittee123456' is not facet-valid with respect to enumeration '[ResearchOrganization, OversightCommittee, HealthCareFacility]'. It must be a value from the enumeration.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Organization Role ID is not specified in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.b: The content of element 'org:getOrganizationRoleByIdRequest' is not complete. One of '{organizationRoleID}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Family Service
The following sections list operations provided by the Family web service.
Operation searchFamiliesByName
Searches family records by family name.
Request Body | searchFamiliesByNameRequest having name |
---|
Response Body | searchFamiliesByNameResponse having familyList ( which is unbounded list of family) |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:fam="http://soap.simple.service.webservices.po.nci.nih.gov/family/">
<soapenv:Header />
<soapenv:Body>
<fam:searchFamiliesByNameRequest>
<name>mayo clinic</name>
</fam:searchFamiliesByNameRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:searchFamiliesByNameResponse
xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/family/">
<familyList>
<ns3:id>16555954</ns3:id>
<ns3:status>ACTIVE</ns3:status>
<ns3:name>Mayo Clinic Cancer Center</ns3:name>
<ns3:startDate>2009-01-01-05:00</ns3:startDate>
<ns3:member>
<ns3:organizationId>140392</ns3:organizationId>
<ns3:type>ORGANIZATIONAL</ns3:type>
<ns3:startDate>2009-01-01-05:00</ns3:startDate>
</ns3:member>
<ns3:member>
<ns3:organizationId>145720</ns3:organizationId>
<ns3:type>AFFILIATION</ns3:type>
<ns3:startDate>2009-01-01-05:00</ns3:startDate>
</ns3:member>
<ns3:member>
<ns3:organizationId>141101</ns3:organizationId>
<ns3:type>ORGANIZATIONAL</ns3:type>
<ns3:startDate>2009-01-01-05:00</ns3:startDate>
</ns3:member>
</familyList>
</ns2:searchFamiliesByNameResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: No matching record found: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:searchFamiliesByNameResponse xmlns:ns3="gov.nih.nci.po.webservices.types" xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/family/"/>
</soap:Body>
</soap:Envelope> |
Example: Family name is not specified in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.b: The content of element 'fam:searchFamiliesByNameRequest' is not complete. One of '{name}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation searchFamiliesByOrgId
Searches family records by organization ID.
Request Body | searchFamiliesByOrgIdRequest having organizationId. |
---|
Response Body | searchFamiliesByOrgIdResponse having familyList ( which is unbounded list of family) |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:fam="http://soap.simple.service.webservices.po.nci.nih.gov/family/">
<soapenv:Header />
<soapenv:Body>
<fam:searchFamiliesByOrgIdRequest>
<organizationId>213820</organizationId>
</fam:searchFamiliesByOrgIdRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:searchFamiliesByOrgIdResponse
xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/family/">
<familyList>
<ns3:id>16493519</ns3:id>
<ns3:status>ACTIVE</ns3:status>
<ns3:name>H. Lee Moffitt Cancer Center Research Institute</ns3:name>
<ns3:startDate>2009-01-01-05:00</ns3:startDate>
<ns3:member>
<ns3:organizationId>91000</ns3:organizationId>
<ns3:type>AFFILIATION</ns3:type>
<ns3:startDate>2009-01-01-05:00</ns3:startDate>
</ns3:member>
<ns3:member>
<ns3:organizationId>71495</ns3:organizationId>
<ns3:type>ORGANIZATIONAL</ns3:type>
<ns3:startDate>2009-01-01-05:00</ns3:startDate>
</ns3:member>
</familyList>
</ns2:searchFamiliesByOrgIdResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: No matching record found. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:searchFamiliesByOrgIdResponse
xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/family/" />
</soap:Body>
</soap:Envelope> |
Example: Organization is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>EntityNotFoundException: Family search couldn't be performed as Organization for Id: 21382011111111 doesn't exist.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Organization ID is not specified in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.b: The content of element 'fam:searchFamiliesByOrgIdRequest' is not complete. One of '{organizationId}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation getFamilyMemberRelationshipsByFamilyId
Gets the family member relationships by family ID.
Request Body | getFamilyMemberRelationshipsByFamilyIdRequest having familyId. |
---|
Response Body | getFamilyMemberRelationshipsByFamilyIdResponse having familyMemberRelationshipList ( which is unbounded list of familyMemberRelationship) |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:fam="http://soap.simple.service.webservices.po.nci.nih.gov/family/">
<soapenv:Header />
<soapenv:Body>
<fam:getFamilyMemberRelationshipsByFamilyIdRequest>
<familyId>16555954</familyId>
</fam:getFamilyMemberRelationshipsByFamilyIdRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:getFamilyMemberRelationshipsByFamilyIdResponse
xmlns:ns3="gov.nih.nci.po.webservices.types"
xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/family/">
<familyMemberRelationshipList>
<ns3:id>16556076</ns3:id>
<ns3:familyId>16555954</ns3:familyId>
<ns3:organizationId>33657</ns3:organizationId>
<ns3:relatedToOrganizationId>139137</ns3:relatedToOrganizationId>
<ns3:type>PEER</ns3:type>
<ns3:startDate>2009-01-01-05:00</ns3:startDate>
</familyMemberRelationshipList>
<familyMemberRelationshipList>
<ns3:id>16556125</ns3:id>
<ns3:familyId>16555954</ns3:familyId>
<ns3:organizationId>139137</ns3:organizationId>
<ns3:relatedToOrganizationId>262251</ns3:relatedToOrganizationId>
<ns3:type>PEER</ns3:type>
<ns3:startDate>2009-01-01-05:00</ns3:startDate>
</familyMemberRelationshipList>
<familyMemberRelationshipList>
<ns3:id>16555971</ns3:id>
<ns3:familyId>16555954</ns3:familyId>
<ns3:organizationId>32332</ns3:organizationId>
<ns3:relatedToOrganizationId>33657</ns3:relatedToOrganizationId>
<ns3:type>PEER</ns3:type>
<ns3:startDate>2009-01-01-05:00</ns3:startDate>
</familyMemberRelationshipList>
<familyMemberRelationshipList>
<ns3:id>16556118</ns3:id>
<ns3:familyId>16555954</ns3:familyId>
<ns3:organizationId>262251</ns3:organizationId>
<ns3:relatedToOrganizationId>139137</ns3:relatedToOrganizationId>
<ns3:type>PEER</ns3:type>
<ns3:startDate>2009-01-01-05:00</ns3:startDate>
</familyMemberRelationshipList>
</ns2:getFamilyMemberRelationshipsByFamilyIdResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: Family is not found in the database. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>EntityNotFoundException: FamilyMemberRelationship couldn't be fetched as Family for Id: 16555954111111 doesn't exist.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
Example: Family ID is not specified in the request. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<soap:Fault>
<faultcode>soap:Client</faultcode>
<faultstring>Unmarshalling Error: cvc-complex-type.2.4.b: The content of element 'fam:getFamilyMemberRelationshipsByFamilyIdRequest' is not complete. One of '{familyId}' is expected.</faultstring>
</soap:Fault>
</soap:Body>
</soap:Envelope> |
|
---|
Operation getFamily
Gets the family record by its ID.
Request Body | GetFamilyRequest having familyId |
---|
Response Body | GetFamilyResponse having Family |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:fam="http://soap.simple.service.webservices.po.nci.nih.gov/family/">
<soapenv:Header/>
<soapenv:Body>
<fam:getFamilyRequest>
<familyId>16472006</familyId>
</fam:getFamilyRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:getFamilyResponse xmlns:ns3="gov.nih.nci.po.webservices.types" xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/family/">
<family>
<ns3:id>16472006</ns3:id>
<ns3:status>ACTIVE</ns3:status>
<ns3:name>Cancer Therapy & Research Center</ns3:name>
<ns3:startDate>2009-01-01-05:00</ns3:startDate>
<ns3:p30SerialNumber>54174</ns3:p30SerialNumber>
<ns3:member>
<ns3:familyId>16472006</ns3:familyId>
<ns3:organizationId>228946</ns3:organizationId>
<ns3:type>ORGANIZATIONAL</ns3:type>
<ns3:startDate>2009-01-01-05:00</ns3:startDate>
</ns3:member>
<ns3:member>
<ns3:familyId>16472006</ns3:familyId>
<ns3:organizationId>228042</ns3:organizationId>
<ns3:type>ORGANIZATIONAL</ns3:type>
<ns3:startDate>2009-01-01-05:00</ns3:startDate>
</ns3:member>
</family>
</ns2:getFamilyResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: No family found for the given Family ID. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:getFamilyResponse xmlns:ns3="gov.nih.nci.po.webservices.types" xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/family/"/>
</soap:Body>
</soap:Envelope> |
|
---|
Operation getFamilyMember
Gets the family record by its ID.
Request Body | GetFamilyMemberRequest having familyMemberId |
---|
Response Body | GetFamilyMemberResponse having FamilyMember |
---|
Sample Request | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:fam="http://soap.simple.service.webservices.po.nci.nih.gov/family/">
<soapenv:Header/>
<soapenv:Body>
<fam:getFamilyMemberRequest>
<familyMemberId>16368257</familyMemberId>
</fam:getFamilyMemberRequest>
</soapenv:Body>
</soapenv:Envelope> |
|
---|
Sample Response | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:getFamilyMemberResponse xmlns:ns3="gov.nih.nci.po.webservices.types" xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/family/">
<familyMember>
<ns3:familyId>16368252</ns3:familyId>
<ns3:organizationId>71815</ns3:organizationId>
<ns3:type>ORGANIZATIONAL</ns3:type>
<ns3:startDate>2009-01-01-05:00</ns3:startDate>
<ns3:endDate>2011-05-30-04:00</ns3:endDate>
</familyMember>
</ns2:getFamilyMemberResponse>
</soap:Body>
</soap:Envelope> |
|
---|
Exception Messages | Example: No Family Member found for the given ID: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:getFamilyMemberResponse xmlns:ns3="gov.nih.nci.po.webservices.types" xmlns:ns2="http://soap.simple.service.webservices.po.nci.nih.gov/family/"/>
</soap:Body>
</soap:Envelope> |
|
---|