SWILSClinicalListOfValues Operations

For a list of operations associated with this Web service, see the following table.

Operation Name	Description
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 the following table.

Node	Description	Type
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 the following table.

Node	Description	Type
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 the following table.

Node	Description	Type
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