Siebel Innovation Pack 2017: SWILSClinicalGetSiteContacts

Siebel CRM Web Services Reference > Siebel CRM Primary Web Services >

SWILSClinicalGetSiteContacts

Use this Web service to retrieve all protocol site contacts. An external application can invoke this Web service using valid Siebel application user credentials for authentication. Additionally, consider the following:

If the page size field is empty (or blank) in the LSClinicalGetSiteContactsQueryPage operation, then the Web service returns an error message. Only provided tags can be used with this operation.
The LSClinicalGetSiteContactsQueryById operation supports only one instance of a Siebel message.
The mobile application user may want to add a new contact to the 'Attendees' list in clinical trip report.
In this case, the mobile user must have all contacts of that site in the mobile server side, so that one can add more contacts to attendees in clinical trip report. This Web service helps by returning all those site contacts to external application.

SWILSClinicalGetSiteContacts Operations

For a list of operations associated with this Web service, see Table 1194.

Table 1194. SWILSClinicalGetSiteContacts Operations
Operation Name	Description
LSClinicalGetSiteContactsQueryById	Used to send contacts of a site given the Site Row ID.
LSClinicalGetSiteContactsQueryPage	Used to send contacts of multiple sites in pages.
LSClinicalGetSiteContactsQueryByExample	Used to send contacts of multiple sites as a single result set.

Request Message Description: LSClinicalGetSiteContactsQueryById

Use this operation if the external application requires the contacts associated with a particular site. The operation passes the site row ID that corresponds to each requested contact. For a description of this request message, see Table 1195.

Table 1195. Request Message Description: LSClinicalGetSiteContactsQueryById
Node	Description	Type
PrimaryRowId	Required. Protocol site row ID.	Character data

Request Message Description: LSClinicalGetSiteContactsQueryByExample

Use this operation to query contacts from a limited number of sites. Different search criteria can be used. For a description of this request message, see Table 1196.

Table 1196. Request Message Description: LSClinicalGetSiteContactsQueryByExample
Node	Description	Type
ClinicalProtocolSite.Id	Optional. Row ID of protocol site.	Character data
ClinicalProtocolSite. Searchspec	Optional. Search specification.	Character data
ClinicalProtocolSite. SiteNumber	Optional. Site number.	Character data
ClinicalProtocolSite. SiteUId	Optional. Site ID.	Character data
ClinicalAccountInvestigatorRole.Id	Optional. Row ID of the site contact.	Character data
ClinicalAccountInvestigatorRole. ConflictId	Optional. Conflict ID.	Character data
ClinicalAccountInvestigatorRole. Searchspec	Optional. Search specification.	Character data
ClinicalAccountInvestigatorRole. City	Optional. Contact's city.	Character data
ClinicalAccountInvestigatorRole. ContactId	Optional. Row ID of contact.	Character data
ClinicalAccountInvestigatorRole. Country	Optional. Contact's country.	Character data
ClinicalAccountInvestigatorRole. EmailAddress	Optional. Contact's email address.	Character data
ClinicalAccountInvestigatorRole. FaxPhone	Optional. Contact's fax and phone number.	Character data
ClinicalAccountInvestigatorRole. FirstName	Optional. Contact's first name.	Character data
ClinicalAccountInvestigatorRole. LastName	Optional. Contact's last name.	Character data
ClinicalAccountInvestigatorRole. MiddleName	Optional. Contact's middle name.	Character data
ClinicalAccountInvestigatorRole. PostalCode	Optional. Postal code.	Character data
ClinicalAccountInvestigatorRole. PrimaryPersonalAddressId	Optional. Primary address ID.	Character data
ClinicalAccountInvestigatorRole. PrimarySpecialty	Optional. Primary medical specialty.	Character data
ClinicalAccountInvestigatorRole. Region	Optional. Region.	Character data
ClinicalAccountInvestigatorRole. Role	Optional. Role.	Character data
ClinicalAccountInvestigatorRole. State	Optional. State.	Character data
ClinicalAccountInvestigatorRole. StreetAddress	Optional. Street address.	Character data
ClinicalAccountInvestigatorRole. WorkPhone	Optional. Work phone.	Character data

Request Message Description: LSClinicalGetSiteContactsQueryPage

Use this operation to query the contacts from all, or a large number of sites. For a description of this request message, see Table 1197.

Table 1197. Request Message Description: LSClinicalGetSiteContactsQueryPage
Node	Description	Type
ClinicalProtocolSite.Id	Required. Can be either an asterisk (*), or the row ID of the protocol site.	Character data
ClinicalProtocolSite. SiteUId	Required. Can be either an asterisk (*), or the site ID.	Character data
ClinicalAccountInvestigatorRole.Id	Required. Can be either an asterisk (*), or the row ID the site contact.	Character data
ClinicalAccountInvestigatorRole. ContactId	Required. Can be either an asterisk (*), or the row ID of the contact.	Character data
ClinicalAccountInvestigatorRole. FirstName	Required. Can be either an asterisk (*), or the contact's first name.	Character data
ClinicalAccountInvestigatorRole. LastName	Required. Can be either an asterisk (*), or the contact's last name.	Character data

Response Message Description: LSClinicalGetSiteContactsQueryPage, LSClinicalGetSiteContactsQueryById and LSClinicalGetSiteContactsQueryByExample

For a description of the response messages, see Table 1198.

Table 1198. Response Message Description: LSClinicalGetSiteContactsQueryPage, LSClinicalGetSiteContactsQueryById and LSClinicalGetSiteContactsQueryByExample
Node	Description	Type
ClinicalProtocolSite. SiteNumber	Site Number.	Character data
ClinicalProtocolSite. SiteUId	Site ID.	Character data
ClinicalAccountInvestigatorRole.Id	Row ID of the site contact.	Character data
ClinicalAccountInvestigatorRole. City	Contact's city.	Character data
ClinicalAccountInvestigatorRole. ContactId	Row ID of the contact.	Character data
ClinicalAccountInvestigatorRole. Country	Contact's country.	Character data
ClinicalAccountInvestigatorRole. EmailAddress	Contact's email.	Character data
ClinicalAccountInvestigatorRole. FaxPhone	Contact's fax, and phone number.	Character data
ClinicalAccountInvestigatorRole. FirstName	Contact's first name.	Character data
ClinicalAccountInvestigatorRole. LastName	Contact's last name.	Character data
ClinicalAccountInvestigatorRole. MiddleName	Contact's middle name	Character data
ClinicalAccountInvestigatorRole. PostalCode	Postal code.	Character data
ClinicalAccountInvestigatorRole. PrimaryPersonalAddressId	Primary address ID.	Character data
ClinicalAccountInvestigatorRole. PrimarySpecialty	Primary medical specialty.	Character data
ClinicalAccountInvestigatorRole. Region	Region.	Character data
ClinicalAccountInvestigatorRole. Role	Role.	Character data
ClinicalAccountInvestigatorRole. State	State.	Character data
ClinicalAccountInvestigatorRole. StreetAddress	Street address.	Character data
ClinicalAccountInvestigatorRole. WorkPhone	Work phone.	Character data

SWILSClinicalGetSiteContacts Application Interface

This topic describes the application objects called by this Web service. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see Table 1199.

Table 1199. SWILSClinicalGetSiteContacts Service Object
Name	Boundary Object Type	Class
LS Clinical GetSiteContacts	Business Service	CSSEAIDataSyncService

Data Object (Integration Object)

For a description of the data objects for this Web service, see Table 1200.

Table 1200. SWILSClinicalGetSiteContacts Data Object
Siebel Repository Name	External Name
LS Clinical Protocol Site_Clinical Account Investigator Role	Clinical Protocol Site

Example Package for SWILSClinicalGetSiteContacts

To view an example of messages for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

Request

See the following file to view the sample code:

...\SWILSClinicalGetSiteContacts\SWILSClinicalGetSiteContacts-QueryById-request.xml

...\SWILSClinicalGetSiteContacts\SWILSClinicalGetSiteContacts-QueryByExample-request.xml

...\SWILSClinicalGetSiteContacts\SWILSClinicalGetSiteContacts-QueryPage-request.xml

Interface Description (WSDL) for SWILSClinicalGetSiteContacts

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\SWILSClinicalGetSiteContacts\SWILSClinicalGetSiteContacts-QueryByExample.WSDL

...\SWILSClinicalGetSiteContacts\SWILSClinicalGetSiteContacts-QueryPage.WSDL

...\SWILSClinicalGetSiteContacts\SWILSClinicalGetSiteContacts-QueryById.WSDL

Siebel CRM Web Services Reference		Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.