|
Siebel CRM Web Services Reference > Siebel CRM Primary Web Services >
SWILSClinicalGetSubjectVisitDetails
Use this Web service to send all subject visit details from a particular protocol site. 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 LSClinicalGetSubjectVisitDetailsQueryByExample operation, then the Web service returns all subject visit details. An error message might result if the result set is larger than the predefined maximum size, and then the user is prompted to refine the search.
- An external application can invoke this Web service with any methods depends on the scenario.
- This Web service will return an error message if the page size is left blank on the QueryPage method.
- Only provided tags need to be used with the QueryPage method.
- The mobile application user might want to add or update a new Case Report form record to a trip report. Is so, then the user must have all the available subject visit details for a particular protocol site at the target host.
- The external user can use this Web service to get all subject visit details for a given search criteria.
SWILSClinicalGetSubjectVisitDetails Operations
For a list of operations associated with this Web service, see Table 1210.
Table 1210. SWILSClinicalGetSubjectVisitDetails Operations
|
|
LSClinicalGetSubjectVisitDetailsQueryById |
Returns subject visit details for a given protocol site ID. |
LSClinicalGetSubjectVisitDetailsQueryPage |
Returns subject visit details in pages. |
LSClinicalGetSubjectVisitDetailsQueryByExample |
Returns subject visit details in a single result set based on a given search criteria. |
Request Message Description: LSClinicalGetSubjectVisitDetailsQueryByExample
You can invoke this operation with the protocol site ID to ensure that only the corresponding site related to subject visits is returned. If no input is provided, then all the subject visits from all sites are returned. For a description of this request message, see Table 1211.
Table 1211. Request Message Description: LSClinicalGetSubjectVisitDetailsQueryByExample
|
|
|
Id |
Optional. Row ID of subject visit record. |
Character data |
Searchspec |
Optional. Search specification. |
Character data |
CRFPages |
Optional. Number of Case Report form pages. |
Integer |
ActivityUID |
Optional. Activity ID. |
Character data |
Category |
Optional. Category, such as Visit. |
Character data |
ParentActivityId |
Optional. Parent activity ID. |
Character data |
ParentTemplateVersionId |
Optional. Parent template version. |
Character data |
ProtocolSiteId |
Optional. Protocol site ID. |
Character data |
Screen |
Optional. Subject screen number. |
Character data |
SubjectDOB |
Optional. Date of birth. |
Date and time |
SubjectId |
Optional. Subject row ID. |
Character data |
SubjectInitial |
Optional. Subject initials. |
Character data |
Template |
Optional. Template. |
Character data |
TemplateFlag |
Optional. Template flag. |
Character data |
TemplateId |
Optional. Template ID. |
Character data |
TemplateVersion |
Optional. Template version. |
Character data |
Type |
Optional. Visit type. |
Character data |
Request Message Description: LSClinicalGetSubjectVisitDetailsQueryPage
Invoke this method by passing an asterisk (*) to all of the tags to return all subject visit details from all sites. The result set is returned in pages with page size. For a description of this request message, see Table 1212.
Table 1212. Request Message Description: LSClinicalGetSubjectVisitDetailsQueryPage
|
|
|
Id |
Required. Row ID of a subject visit record. Can be either an asterisk (*), or a valid row ID. |
Character data |
ActivityUID |
Required. Activity ID. Can be either an asterisk (*), or a valid activity ID. |
Character data |
Category |
Required. A category such as Visit, and so on. Can be either an asterisk (*), or a valid category value. |
Character data |
ParentTemplateVersionId |
Required. Parent template version. Can be either an asterisk (*), or a valid parent template version ID. |
Character data |
ProtocolSiteId |
Required. Protocol site ID. Can be either an asterisk (*), or a valid protocol site ID. |
Character data |
Screen |
Required. Subject screen number. Can be either an asterisk (*), or a valid screen value. |
Character data |
SubjectId |
Required. Subject row ID. Can be either an asterisk (*), or a valid subject ID. |
Character data |
SubjectInitial |
Required. Subject initial. Can be either an asterisk (*), or a valid subject initial value. |
Character data |
Template |
Required. Template. Can be either an asterisk (*), or a valid template value. |
Character data |
TemplateFlag |
Required. Template flag. Can be either an asterisk (*), or a valid template flag. Values are Y or N. |
Character data |
TemplateId |
Required. Template ID. Can be either an asterisk (*), or a valid template ID. |
Character data |
TemplateVersion |
Required. Template version. Can be either an asterisk (*), or a valid template version. |
Character data |
Type |
Required. Visit type. Can be either an asterisk (*), or a valid type value. |
Character data |
Request Message Description: LSClinicalGetSubjectVisitDetailsQueryById
One can invoke this method in this Web service by passing the exact Row Id of a particular subject visit record. For a description of this request message, see Table 1213.
Table 1213. Request Message Description: LSClinicalGetSubjectVisitDetailsQueryById
|
|
|
PrimaryRowId |
Required. The primary row ID of the subject visit record. |
Character data |
Response Message Description: LSClinicalGetSubjectVisitDetailsQueryByExample, LSClinicalGetSubjectVisitDetailsQueryPage and LSClinicalGetSubjectVisitDetailsQueryById
For a description of this request message, see Table 1214.
Table 1214. Response Message Description: LSClinicalGetSubjectVisitDetailsQueryByExample, LSClinicalGetSubjectVisitDetailsQueryPage and LSClinicalGetSubjectVisitDetailsQueryById
|
|
|
Id |
Row ID of the subject visit record. |
Character data |
CRFPages |
The number of case report form pages |
Integer |
ActivityUID |
Activity ID. |
Character data |
Category |
Category, such as visit, and so on. |
Character data |
ParentActivityId |
Parent activity ID. |
Character data |
ParentTemplateVersionId |
Parent template version. |
Character data |
ProtocolSiteId |
Protocol site ID. |
Character data |
Screen |
Subject screen number. |
Character data |
SubjectDOB |
Date of birth. |
Date Time |
SubjectId |
Subject row ID. |
Character data |
SubjectInitial |
Subject initial. |
Character data |
Template |
Template. |
Character data |
TemplateFlag |
Template flag. |
Character data |
TemplateId |
Template ID. |
Character data |
TemplateVersion |
Template version. |
Character data |
Type |
Visit type. |
Character data |
SWILSClinicalGetSubjectVisitDetails 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 1215.
Table 1215. SWILSClinicalGetSubjectVisitDetails Service Object
|
|
|
LS Clinical GetSubjectVisitDetails |
Business Service |
CSSEAIDataSyncService |
Data Object (Integration Object)
For a description of the data objects for this Web service, see Table 1216.
Table 1216. SWILSClinicalGetSubjectVisitDetails Data Object
|
|
LS Clinical Subject Visit Plan |
LS Clinical Visit Plan |
Example Package for SWILSClinicalGetSubjectVisitDetails
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: ...\SWILSClinicalGetSubjectVisitDetails\SWILSClinicalGetSubjectVisitDetails-QueryByExample-request.xml
...\SWILSClinicalGetSubjectVisitDetails\SWILSClinicalGetSubjectVisitDetails-QueryById-request.xml
...\SWILSClinicalGetSubjectVisitDetails\SWILSClinicalGetSubjectVisitDetails-QueryPage-request.xml
Interface Description (WSDL) for SWILSClinicalGetSubjectVisitDetails
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. ...\SWILSClinicalGetSubjectVisitDetails\SWILSClinicalGetSubjectVisitDetails-QueryByExample.WSDL
...\SWILSClinicalGetSubjectVisitDetails\SWILSClinicalGetSubjectVisitDetails-QueryPage.WSDL
...\SWILSClinicalGetSubjectVisitDetails\SWILSClinicalGetSubjectVisitDetails-QueryById.WSDL
| 
