Bookshelf v8.1/8.2: SWILSClinicalGetEmployees

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

SWILSClinicalGetEmployees

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

If no input is provided for any tags in the LSClinicalGetEmployeesQueryByExample operation, then the Web service returns all employee records. If the returned number of records is more than the predefined maximum size, then the Web service returns an error message prompting the user to refine the search.
When using the LSClinicalGetEmployeesQueryPage operation, this Web service returns an error message if the page size field is left blank.
This Web service is used to return all employees from an organization or sub-organization to which an authenticated user is associated.

SWILSClinicalGetEmployees Operations

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

Table 1125. SWILSClinicalGetEmployees Operations
Operation Name	Description
LSClinicalGetEmployeesQueryByExample	Used to return employees in a single result set.
LSClinicalGetEmployeesQueryById	Used to return employees based on given primary row ID.
LSClinicalGetEmployeesQueryPage	Used to return employees in pages.

Request Message Description: LSClinicalGetEmployeesQueryByExample

This operation can be invoked with either the employee ID or login name. This ensures that only the corresponding employee details are returned. Other fields can also be used to refine the search criteria. If no input is provided, then all the employees are returned. For a description of this request message, see Table 1126.

Table 1126. Request Message Description: LSClinicalGetEmployeesQueryByExample
Node	Description	Type
Employee.Id	Optional. Row ID of employee.	Character data
Employee.EMailAddr	Optional. Email address.	Character data
Employee.FirstName	Optional. First name.	Character data
Employee.JobTitle	Optional. Job title.	Character data
Employee.LastName	Optional. Last name.	Character data
Employee.LoginName	Optional. User ID.	Character data
Employee.Phone	Optional. Phone number	Number
RelatedPosition.Division	Optional. Employee division.	Character data
RelatedResponsibility.Responsibility	Optional. Employee responsibility.	Character data

Request Message Description: LSClinicalGetEmployeesQueryPage

This operation can be invoked with either the employee ID or login name. This ensures that only employee details are returned. You can use other fields to refine the search criteria. If all employee details are required, then pass an asterisk (*) for all nodes. The result set will be in pages with page size.

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

Table 1127. Request Message Description: LSClinicalGetEmployeesQueryPage
Node	Description	Type
Employee.Id	Required. Row ID of the employee record. Can be either an asterisk (*), or a valid Row ID.	Character data
Employee.FirstName	Required. Employee's first name. Can be either an asterisk (*), or the employee's first name.	Character data
Employee.LastName	Required. Employee's last name. Can be either an asterisk (*), or the employee's last name.	Character data
Employee.LoginName	Required. User ID. Can be either an asterisk (*), or the employee's user ID.	Character data
RelatedPosition. Division	Required. Employee division. Can be either an asterisk (*), or the employee division.	Character data
RelatedResponsibility. Responsibility	Required. Employee responsibility. Can be either an asterisk (*), or employee responsibility.	Character data

Request Message Description: LSClinicalGetEmployeesQueryById

This operation can be invoked with the employee row ID so that only corresponding employee details are returned. For a description of this request message, see Table 1128.

Table 1128. Request Message Description: LSClinicalGetEmployeesQueryById
Node	Description	Type
PrimaryRowId	Required. The row ID of the employee.	Character data

Response Message Description: LSClinicalGetEmployeesQueryById, LSClinicalGetEmployeesQueryByExample and LSClinicalGetEmployeesQueryPage

Each of these operations uses the same response message. For a description of the response message, see Table 1129.

Table 1129. Response Message Description: LSClinicalGetEmployeesQueryById, LSClinicalGetEmployeesQueryByExample and LSClinicalGetEmployeesQueryPage
Node	Description	Type
Employee.Id	Row ID of the employee.	Character data
Employee.EMailAddr	Email address.	Character data
Employee.FirstName	First name.	Character data
Employee.JobTitle	Job title.	Character data
Employee.LastName	Last name.	Character data
Employee.LoginName	User ID.	Character data
Employee.Phone	Phone number.	Number
RelatedPosition.Division	Employee division.	Character data
RelatedResponsibility.Responsibility	Employee responsibility.	Character data

SWILSClinicalGetEmployees 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 1130.

Table 1130. SWILSClinicalGetEmployees Service Object
Name	Boundary Object Type	Class
LS Clinical Get Employees	Business Service	CSSEAIDataSyncService

Data Object (Integration Object)

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

Table 1131. SWILSClinicalGetEmployees Data Object
Siebel Repository Name	External Name
LS Clinical Employee Interface	Employee

Example Package for SWILSClinicalGetEmployees

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:

...\SWILSClinicalGetEmployees\SWILSClinicalGetEmployees-QueryByExample-request.xml

...\SWILSClinicalGetEmployees\SWILSClinicalGetEmployees-QueryPage-request.xml

...\SWILSClinicalGetEmployees\SWILSClinicalGetEmployees-QueryById-request.xml

Interface Description (WSDL) for SWILSClinicalGetEmployees

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.

...\SWILSClinicalGetEmployees\SWILSClinicalGetEmployees-QueryByExample.WSDL

...\SWILSClinicalGetEmployees\SWILSClinicalGetEmployees-QueryPage.WSDL

...\SWILSClinicalGetEmployees\SWILSClinicalGetEmployees-QueryById.WSDL

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