Bookshelf v8.1/8.2: SWILSClinicalQueryProtocolSite

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

SWILSClinicalQueryProtocolSite_
SiteVisits

Use Siebel Life Sciences as the master system for the objects in the Study hierarchy, such as the protocol, site, and site visits. In a biotechnology or pharmaceutical company, after Protocols and Sites are created in the Siebel database, the information might be required in other downstream third-party applications used to study of protocol. Siebel Life Sciences can provide information on protocols, based on input parameters that are contained in the Web service request messages provided by third-party applications.

Requests can be limited by the User ID or by the protocol number, or both. When the input parameters of the Protocol Number field and User ID (Site Visit Team Member) are provided, the Web service returns only the information from the related sites and site visits. There is no output for users, protocols, or users who are not associated with the protocol.

SWILSClinicalQueryProtocolSite_SiteVisits Operations

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

Table 1168. SWILSClinicalQueryProtocolSite_SiteVisits Operations
Name	Description
query	Queries the Clinical Trial Management System application to retrieve protocol, site, and site visit information.

Request Message Description: query

For a description of this request message, see Table 1169.

Table 1169. Request Message Description: query
Node	Description	Type
UserId	Required. Passes a valid site visit team member login ID to get the corresponding user's site visits or passes (*) to get site visit details of all users.	Character data
Protocol Number	Required. Passes a valid protocol number to get a user's site visits in the given protocol or passes (*) to get site visits of a user in all protocols.	Character data
PageSize	Required. Number of protocol sites the user wants to view in a single page. The number must be greater than zero.	Number
StartRowNum	Optional. First record you want to start with.	Number
Sort Spec	Used to sort the clinical protocol site records based on the given sort specifications. The Clinical Research Associate can query and prioritize site visits based on fields such as status, Site ID and so on. Other fields include: Account Main Phone Number Account Status Address Id Primary Investigator Id Protocol Id Protocol Number Protocol Site Id Protocol Title Region Region Id Site Id Site Number Status Investigator First Name Investigator Last Name	Comma-separated list of Clinical Protocol Site for Mobile Integration business component fields made available in the integration.

Response Message Description: query

For a description of this request message, see Table 1170

Table 1170. Response Message Description: query
Parent Node	Field	Type	Description
ClinicalProtocolSite	ProtocolNumber	Character data	Display protocol and site details.
ClinicalProtocolSite	ProtocolId	Character data
ClinicalProtocolSite	ProtocolSiteId	Character data
ClinicalProtocolSite	ProtocolTitle	Character data
ClinicalProtocolSite	Region	Character data
ClinicalProtocolSite	RegionId	Character data
ClinicalProtocolSite	SiteId	Character data
ClinicalProtocolSite	AccountMainPhone Number	Character data
ClinicalProtocolSite	Account	Character data
ClinicalProtocolSite	SiteNumber	Character data
ClinicalProtocolSite	PrimaryInvestigatorId	Character data
ClinicalProtocolSite	AddressId	Character data
ClinicalProtocolSite	Planned	Integer
ClinicalProtocolSite	AccountStatus	Character data
ClinicalProtocolSite	Status	Character data
ClinicalProtocolSite	AccountType	Character data
ClinicalProtocolSite	UserId	Character data
ClinicalProtocolSiteAddressBc	Fax	Character data	Display details of addresses associated with the site.
ClinicalProtocolSiteAddressBc	City	Character data
ClinicalProtocolSiteAddressBc	AddressLine2	Character data
ClinicalProtocolSiteAddressBc	Phone	Character data
ClinicalProtocolSiteAddressBc	State	Character data
ClinicalProtocolSiteAddressBc	Country	Character data
ClinicalProtocolSiteAddressBc	Zip	Character data
ClinicalAccountInvestigatorRole	FirstName	Character data	Display site contact details.
ClinicalAccountInvestigatorRole	FaxPhone	Character data
ClinicalAccountInvestigatorRole	EmailAddress	Character data
ClinicalAccountInvestigatorRole	WorkPhone	Character data
ClinicalAccountInvestigatorRole	State	Character data
ClinicalAccountInvestigatorRole	LastName	Character data
ClinicalTripReport	Done	Date and Time	Display site visit details.
ClinicalTripReport	Description	Character data
ClinicalTripReport	Comment	Character data
ClinicalTripReport	Id	Character data
ClinicalTripReport	InvestigatorFirst Name	Character data
ClinicalTripReport	InvestigatorLast Name	Character data
ClinicalTripReport	Planned2	Date and Time
ClinicalTripReport	Status	Character data
ClinicalTripReport	Type	Character data
ClinicalTripReport	TripReportStatus	Character data
LsClinicalSiteVisitEmployee	Login	Character data	Display site visit team member details.
LsClinicalSiteVisitEmployee	Emp Id	Character data
LsClinicalSiteVisitEmployee	IsPrimaryOwner	Character data
query	LastPage	Character data	Displays True if the page is last, otherwise it will display False.

SWILSClinicalQueryProtocolSite_SiteVisits 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 (Workflow)

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

Table 1171. SWILSClinicalQueryProtocolSite_SiteVisits Service Object
Name	Boundary Object Type	Class
SWI LS Clinical Query Protocol Site_Site Visits	Workflow	Not applicable.

Data Object (Integration Object)

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

Table 1172. SWILSClinicalQueryProtocolSite_SiteVisits Data Object
Siebel Repository Name	External Name
LS Clinical Protocol Site_Site Visits Input IO	Clinical Protocol Site for Mobile Integration
LS Clinical Protocol Site_Site Visits Output IO	Clinical Protocol Site for Mobile Integration

Example Package for SWILSClinicalQueryProtocolSite_SiteVisits

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:

...\SWILSClinicalQueryProtocolSite_SiteVisits\SWILSClinicalQueryProtocolSite_Site
Visits_request.xml

Response

See the following file to view the sample code:

...\SWILSClinicalQueryProtocolSite_SiteVisits\SWILSClinicalQueryProtocolSite_Site
Visits_response.xml

Interface Description (WSDL) for SWILSClinicalQueryProtocolSite_SiteVisits

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.

...\SWILSClinicalQueryProtocolSite_SiteVisits\SWILSClinicalQueryProtocolSite_Site
Visits.wsdl

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