|
Siebel CRM Web Services Reference > Siebel CRM Primary Web Services >
SWILSClinicalGetStateModelService
Use this Web service to send the state transitions for a given state model name. An external application can invoke this Web service using any valid Siebel application user credentials for authentication. Additionally, consider the following:
- If no input is provided for any tags in the LSClinicalGetStateModelServiceQueryByExample operation, then the Web service returns all state transitions for all state models in the Clinical Trial Management System application. An error message might result if the result set is large in number, then the user is prompted to refine the search.
- An external application can invoke this Web service with either operation depending on the scenario.
- If the page size field is left blank in the LSClinicalGetStateModelServiceQueryPage operation, then the Web service returns an error message.
- The mobile application user may want to update the trip report status from one state to the next valid state. The user must know the valid To Status value from the current status. In this case, the mobile user must have all valid states for a given state model name.
- Use this Web service to return all valid state transitions for a given state model name.
SWILSClinicalGetStateModelService Operations
For a list of operations associated with this Web service, see Table 1139.
Table 1139. SWILSClinicalGetStateModelService Operations
|
|
LSClinicalGetStateModelServiceQueryPage |
Returns state model transitions in pages. |
LSClinicalGetStateModelServiceQueryByExample |
Returns state model transitions as one result set. |
Request Message Description: LSClinicalGetStateModelServiceQueryByExample
You can invoke this operation in this Web service with a state model name value so that only related state model transitions are returned. If you provide no input, then all the state model transition values are returned. For a description of this request message, see Table 1140.
Table 1140. Request Message Description: LSClinicalGetStateModelServiceQueryByExample
|
|
|
StateModel.Id |
Optional. Row ID of state model name. |
Character data |
StateModel. Searchspec |
Optional. Search specification. |
Character data |
StateModel.Name |
Optional. State model name. |
Character data |
StateModel-Transition.Id |
Optional. Row ID of the transition record. |
Character data |
StateModel-Transition. FromStateName |
Optional. From state name. |
Character data |
StateModel-Transition. PublicFlag |
Optional. Public flag. Values are Y or N. |
Boolean |
StateModel-Transition. RuleExpression |
Optional. Rule expression. |
Character data |
StateModel-Transition. RuleFieldName |
Optional. Rule field name. |
Character data |
StateModel-Transition. RuleOperator |
Optional. Rule operator. |
Character data |
StateModel-Transition. RuleValue |
Optional. Rule value. |
Character data |
StateModel-Transition. ToStateName |
Optional. To state name. A user can change the status drop down value from one state to another state. |
Character data |
Request Message Description: LSClinicalGetStateModelServiceQueryPage
You can invoke this operation with the state model name value so that only related state model transitions are returned. If all state model transition values are required, then pass an asterisk (*) for all nodes. The result set will be in pages with a page size. For a description of this request message, see Table 1141.
Table 1141. Request Message Description: LSClinicalGetStateModelServiceQueryPage
|
|
|
StateModel.Id |
Required. The row ID of the state model name. Can be either an asterisk (*), or a valid row ID. |
Character data |
StateModel.Name |
Required. State model name. Can be either an asterisk (*), or a valid state model name. |
Character data |
StateModel-Transition.Id |
Required. Row ID of transition record. Can be either an asterisk (*), or the row ID of the transition state. |
Character data |
StateModel-Transition. FromStateName |
Required. From state name. Can be either an asterisk (*), or From State name. |
Character data |
StateModel-Transition. PublicFlag |
Required. Public flag. Possible values are Y or N. Can be either an asterisk (*), or public flag. |
Boolean |
StateModel-Transition. ToStateName |
Required. To state name. Can be either an asterisk (*), or To State name. |
Character data |
Response Message Description: LSClinicalGetStateModelServiceQueryByExample and LSClinicalGetStateModelServiceQueryPage
For a description of this request message, see Table 1142.
Table 1142. Response Message Description: LSClinicalGetStateModelServiceQueryByExample and LSClinicalGetStateModelServiceQueryPage
|
|
|
StateModel.Id |
Row ID of the state model name. |
Character data |
StateModel.Name |
State model name. |
Character data |
StateModel-Transition. FromStateName |
From State name. |
Character data |
StateModel-Transition. PublicFlag |
Public flag. Possible values are Y or N. |
Boolean |
StateModel-Transition. RuleExpression |
Rule expression. |
Character data |
StateModel-Transition. RuleFieldName |
Rule field name. |
Character data |
StateModel-Transition. RuleOperator |
Rule operator. |
Character data |
StateModel-Transition. RuleValue |
Rule value. |
Character data |
StateModel-Transition. ToStateName |
To State name. |
Character data |
SWILSClinicalGetStateModelService 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 1143.
Table 1143. SWILSClinicalGetStateModelService Service Object
|
|
|
LS Clinical Get State Model Service |
Business Service |
CSSEAIDataSyncService |
Data Object (Integration Object)
For a description of the data objects for this Web service, see Table 1144.
Table 1144. SWILSClinicalGetStateModelService Data Object
|
|
LS Clinical State Model - Interface IO |
State Model |
Example Package for SWILSClinicalGetStateModelService
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: ...\SWILSClinicalGetStateModelService\SWILSClinicalGetStateModelService-QueryByExample-request.xml
...\SWILSClinicalGetStateModelService\SWILSClinicalGetStateModelService-QueryPage-request.xml
Interface Description (WSDL) for SWILSClinicalGetStateModelService
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. ...\SWILSClinicalGetStateModelService\SWILSClinicalGetStateModelService-QueryByExample.WSDL
...\SWILSClinicalGetStateModelService\SWILSClinicalGetStateModelService-QueryPage.WSDL
| 
