Siebel CRM Web Services Reference > Siebel CRM Primary Web Services >
SWILSClinicalListOfValues
Use this Web service to send the LOV details for a given LOV type from a Siebel CRM application. The third-party application can invoke this Web service using any valid Siebel CRM user ID as authentication.
- An external application can invoke this Web service with either operation depending on the scenario.
- This Web service returns an error message when the LOVQueryPage operation is used with blank page size.
- If no input is provided for the tags in the LOVQueryByExample operation, then the Web service will attempt to return all the available records from the Siebel database. If this result set exceeds the predefined maximum size, then the Web service returns an error which instructs the user to refine the search criteria.
- Use only provided tags with the LOVQueryPage operation.
- Mobile users have all available LOV values on the mobile server to allow them to choose values for clinical trip reports.
SWILSClinicalListOfValues Operations
For a list of operations associated with this Web service, see Table 1227.
Table 1227. SWILSClinicalListOfValues Operations
|
|
LOVQueryPage |
Used to send LOV details for a given LOV type. |
LOVQueryByExample |
Used to send LOV details for a given LOV type. |
Request Message Description: LOVQueryPage
Use this operation when the given search specification retrieves a large number of records at the root component. To avoid returning one large Siebel message, you can specify the number of records to be returned using the PageSize argument. For a description of this request message, see Table 1228.
Table 1228. Request Message Description: LOVQueryPage
|
|
|
Language |
Required. A valid language code such as ENU. Can be either an asterisk (*), or a valid Language code. |
Character data |
LanguageName |
Required. The name of the language which can be either an asterisk (*), or a valid language name such as English-American. |
Character data |
Modifiable |
Required. Modifiable flag which can be either an asterisk (*), or a valid Boolean flag such as Y or N. |
Boolean |
Multilingual |
Required. Multilingual flag which can be either an asterisk (*), or a valid Boolean flag such as Y or N. |
Boolean |
Name |
Required. Language independent code (LIC) which can be either an asterisk (*), or a valid LIC code. |
Character data |
ReplicationLevel |
Required. Replication level which can be either an asterisk (*), or a valid replication level. |
Character data |
Translate |
Required. The Translate flag which can be either an asterisk (*), or a valid Boolean flag such as Y or N. |
Boolean |
Type |
Required. LOV Type. Can be either an asterisk (*), or a valid LOV type. |
Character data |
Value |
Required. Display value Can be either an asterisk (*), or a valid display value. |
Character data |
Request Message Description: LOVQueryByExample
Use this operation if the external application requires only a limited number of LOV type values. For example, to get all LOV type values for all LOVs whose name starts with AAG, then you can call this method with Type value set as follows: AAG*
If this operation is invoked with no input for any fields, then the Web service attempts to return all the LOV records as one Siebel message. If the number of LOV records is more than the predefined maximum page size, then the Web service returns an error message prompting the user to refine the search criteria. This operation requires the use of some criteria such as Type, Language, Order By, and so on. For a description of this request message, see Table 1229.
Table 1229. Request Message Description: LOVQueryByExample
|
|
|
Id |
Optional. Row ID of LOV type value. |
Character data |
Searchspec |
Optional. Search specification. |
Character data |
Active |
Optional. Active or inactive flag. |
Boolean |
Bitmap |
Optional. Bit map. |
Character data |
BitmapId |
Optional. Bit map ID. |
Character data |
ClassCode |
Optional. Class code. |
Character data |
Description |
Optional. Description of the LOV type value. |
Character data |
High |
Optional. High value range. |
Character data |
Language |
Optional. Language code. |
Character data |
LanguageName |
Optional. Name of the language. |
Character data |
Low |
Optional. Low value range. |
Character data |
Modifiable |
Optional. Modifiable flag. |
Boolean |
Multilingual |
Optional. Multilingual flag. |
Boolean |
Name |
Optional. Language independent code. |
Character data |
OrderBy |
Optional. Order by value. |
Number |
OrganizationId |
Optional. Organization ID. |
Character data |
Parent |
Optional. Parent LIC Code. |
Character data |
ParentId |
Optional. Parent LIC code row ID. |
Character data |
ReplicationLevel |
Optional. Replication level. |
Character data |
SubType |
Optional. Name of parent LIC. |
Character data |
TargetHigh |
Optional. Target high value in a range. |
Number |
TargetLow |
Optional. Target low value in a range. |
Number |
Translate |
Optional. Translate flag. |
Boolean |
Type |
Optional. LOV type. |
Character data |
Value |
Optional. Display value. |
Character data |
WeightingFactor |
Optional. Weighting factor. |
Number |
Response Message Description: LOVQueryByExample and LOVQueryPage
For a description of this response message, see Table 1230.
Table 1230. Response Message Description: LOVQueryByExample and LOVQueryPage
|
|
|
Id |
Row Id of LOV type value. |
Character data |
Active |
Active or Inactive Flag. |
Boolean |
Bitmap |
Bit map. |
Character data |
BitmapId |
Bit map ID. |
Character data |
ClassCode |
Class code. |
Character data |
Description |
Description of LOV type value. |
Character data |
High |
High value in a range. |
Character data |
Language |
Language code. |
Character data |
LanguageName |
Name of the language. |
Character data |
Low |
Low value in a range. |
Character data |
Modifiable |
Modifiable flag. |
Boolean |
Multilingual |
Multilingual flag. |
Boolean |
Name |
Language independent code. |
Character data |
OrderBy |
Order by value. |
Number |
OrganizationId |
Organization ID. |
Character data |
Parent |
Parent LIC code. |
Character data |
ParentId |
Parent LIC code row ID. |
Character data |
ReplicationLevel |
Replication level. |
Character data |
SubType |
Name of parent LIC. |
Character data |
TargetHigh |
Target high value in a range. |
Number |
TargetLow |
Target low value in a range. |
Number |
Translate |
Translate flag. |
Boolean |
Type |
LOV type. |
Character data |
Value |
Display value. |
Character data |
WeightingFactor |
Weighting factor. |
Number |
SWILSClinicalListOfValues 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 1231.
Table 1231. SWILSClinicalListOfValues Service Object
|
|
|
LS Clinical List Of Value Service |
Business Service |
CSSEAIDataSyncService |
Data Object (Integration Object)
For a description of the data objects for this Web service, see Table 1232.
Table 1232. SWILSClinicalListOfValues Data Objects
|
|
LS Clinical List Of Values
|
|
Example Package for SWILSClinicalListOfValues
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: ...\SWILSClinicalListOfValues\SWILSClinicalListOfValues-QueryPage-request.xml
...\SWILSClinicalListOfValues\SWILSClinicalListOfValues-QueryByExample-request.xml
Interface Description (WSDL) for SWILSClinicalListOfValues
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. ...\SWILSClinicalListOfValues\SWILSClinicalListOfValues-QueryByExample.WSDL
...\SWILSClinicalListOfValues\SWILSClinicalListOfValues-QueryPage.WSDL
|