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

SWILSClinicalTripReportInterface
Service


Use this Web service to send trip report details to external applications and also to update the trip report details into your clinical trial management system. The user who invokes this Web service must be present in the site visit team. Also, consider the following:

  • If no input is provided for any tags in the TripReportQueryByExample operation, shown in Table 1250, then the Web service will return all those site visit details where the user is part of site visit teams. If the number of records are larger than the predefined maximum size, then the Web service returns an error prompting the user to refine the search and limit the result set.
  • An external application can invoke this Web service with any of the listed operations depending on the scenario.
  • This Web service returns an error message if the Page Size field is empty (or blank) in the TripReportQueryPage operation.
  • Only provided tags can be used with TripReportQueryPage operation.
  • Mobile application users might need to update trip information offline. In this case, trip reports can be accessed from the clinical trial management system using query operations. The information can then be updated on the mobile device and then sent back to the clinical trial management system to complete the update.

SWILSClinicalTripReportInterfaceService Operations

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

Table 1250. SWILSClinicalTripReportInterfaceService Operations
Operation Name
Description

TripReportQueryById

Used to query the trip report details based on give trip report Id or Site Visit Row Id.

TripReportQueryPage

Used to query the trip report details in pages based on given filter criteria.

TripReportQueryByExample

Used to query the trip report details based on given filter criteria.

TripReportSynchronize

Used to synchronize the trip report and its child records.

TripReportUpdate

Used to update the trip report header details.

TripReportInsertOrUpdate

Used either to update the trip report and its child components or to insert new child items of trip report.

Request Message Description: TripReportQueryById

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

Table 1251. Request Message Description: TripReportQueryById
Node
Description
Type

PrimaryRowId

Required. The site visit row ID.

Character data

Request Message Description: TripReportQueryPage

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

Table 1252. Request Message Description: TripReportQueryPage
Node
Description
Type

ClinicalTripReport.Id

Required. The site visit row ID. Can be either an asterisk (*), or a valid row ID.

Character data

ClinicalTripReport. ActivityUID

Required. Site visit activity ID. Can be either an asterisk (*), or a valid activity ID.

Character data

ClinicalTripReport. Description

Required. The trip report description. Can be either an asterisk (*), or a valid description.

Character data

ClinicalTripReport. DisplayInvestigatorFirstName

Required. Can be either an asterisk (*), or valid First Name.

Character data

ClinicalTripReport. DisplayInvestigatorLastName

Required. The last name of the principal investigator. Can be either an asterisk (*), or a valid last name.

Character data

ClinicalTripReport. ProtocolNumber

Required. The protocol number. Can be either an asterisk (*), or a valid protocol number.

Character data

ClinicalTripReport. ProtocolSiteId

Required. The site row ID. Can be either an asterisk (*), or a valid protocol site ID.

Character data

ClinicalTripReport. ProtocolTitle

Required. The protocol title. Can be either an asterisk (*), or a valid protocol title.

Character data

ClinicalTripReport. SiteName

Required. The trip report account. Can be either an asterisk (*), or a valid site name.

Character data

ClinicalTripReport. SiteNumber

Required. The site number. Can be either an asterisk (*), or a valid site number.

Character data

ClinicalTripReport. Status

Required. The trip report status. Can be either an asterisk (*), or a valid status value.

Character data

ClinicalTripReport. TripReportStatus

Required. The trip report status. Can be either an asterisk (*), or a valid trip report status.

Character data

ClinicalTripReport.Type

Required. The visit type. Can be either an asterisk (*), or a valid visit type value.

Character data

LsClinicalSiteVisitAssignee.Id

Required. The row ID of the employee in the site visit team. Can be either an asterisk (*), or valid row ID.

Character data

LsClinicalSiteVisitAssignee. ActivityId

Required. The activity ID of the employee in the site visit team.Can be either an asterisk (*), or a valid activity ID.

Character data

LsClinicalSiteVisitAssignee. EmpId

Required. The employee ID. Can be either an asterisk (*), or a valid employee ID.

Character data

LsClinicalSiteVisitAssignee. FirstName

Required. The employee's first name. Can be either an asterisk (*), or a valid first name.

Character data

LsClinicalSiteVisitAssignee. LastName

Required. The employee's last name. Can be either an asterisk (*), or a valid last name.

Character data

LsClinicalSiteVisitAssignee. UserId

Required. The user ID. Can be either an asterisk (*), or a valid user ID.

Character data

ClinicalAttendee.Id

Required. The attendee row ID. Can be either an asterisk (*), or a valid attendee row ID.

Character data

ClinicalAttendee. EmployeeFlag

Required. The employee flag. Can be either an asterisk (*), or the employee flag.

Boolean

ClinicalAttendee. FirstName

Required. The attendee's first name. Can be either an asterisk (*), or a valid first name.

Character data

ClinicalAttendee. LastName

Required. The attendee's last name. Can be either an asterisk (*), or a valid last name.

Character data

ClinicalAttendeeStatic.Id

Required. The attendee row ID. Can be either an asterisk (*), or a valid row ID.

Character data

ClinicalAttendeeStatic. ActivityId

Required. The attendee's activity ID. Can be either an asterisk (*), or a valid activity ID.

Character data

ClinicalAttendeeStatic. ContactId

Required. The contact ID. Can be either an asterisk (*), or a valid contact ID.

Character data

ClinicalChecklist.Id

Required. The checklist row ID. Can be either an asterisk (*), or valid checklist row ID.

Character data

ClinicalChecklist.ActivityUID

Required. The checklist activity ID. Can be either an asterisk (*), or a valid activity ID.

Character data

ClinicalChecklist. CreatedByName

Required. The created user name. Can be either an asterisk (*), or a valid created user name.

Character data

ClinicalChecklist. ParentActivityId

Required. The parent activity ID. Can be either an asterisk (*), or a valid parent activity ID.

Character data

ClinicalFollowUp.Id

Required. The clinical followup row ID. Can be either an asterisk (*), or a valid followup row ID.

Character data

ClinicalFollowUp. ActivityUID

Required. The activity ID. Can be either an asterisk (*), or a valid activity ID.

Character data

ClinicalFollowUp. CreatedByName

Required. The created user name. Can be either an asterisk (*), or a valid created user name.

Character data

ClinicalFollowUp. ParentActivityId

Required. The parent activity ID. Can be either an asterisk (*), or a valid parent activity ID.

Character data

ClinicalFollowUpSiteLevel.Id

Required. The followup site level row ID. Can be either an asterisk (*), or a valid followup site level row ID.

Character data

ClinicalFollowUpSiteLevel. ActivityUID

Required. The activity ID. Can be either an asterisk (*), or a valid activity ID.

Character data

ClinicalFollowUpSiteLevel. CreatedByName

Required. The created user name. Can be either an asterisk (*), or a valid created user name.

Character data

ClinicalFollowUpSiteLevel. ParentActivityId

Required. The parent activity ID. Can be either an asterisk (*), or a valid parent activity ID.

Character data

LsCaseReportFormsTracking.Id

Required. The case report form row ID. Can be either an asterisk (*), or a valid case report form row ID.

Character data

LsCaseReportFormsTracking.ActivityUID

Required. The activity ID. Can be either an asterisk (*), or a valid activity ID.

Character data

LsCaseReportFormsTracking.ParentActivityId

Required. Can be either an asterisk (*), or valid Parent Activity Id.Parent Activity Id

Character data

LsCaseReportFormsTracking.ParentTemplate
Version

Required. The template version. Can be either an asterisk (*), or a valid parent template version.

Character data

LsCaseReportFormsTracking.SubjectInitial

Required. The subject initial. Can be either an asterisk (*), or a valid subject initial.

Character data

LsCaseReportFormsTracking.SubjectNumber

Required. The subject number. Can be either an asterisk (*), or a valid subject number.

Character data

LsCaseReportFormsTracking.Visit

Required. The visit name. Can be either an asterisk (*), or a valid visit name.

Character data

LsCaseReportFormsTracking.VisitType

Required. The visit type. Can be either an asterisk (*), or a valid visit type.

Character data

Request Message Description: TripReportQueryByExample

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

Table 1253. Request Message Description: TripReportQueryByExample
Node
Description
Type

ClinicalTripReport.Id

Optional. The site visit row ID.

Character data

ClinicalTripReport. Searchspec

Optional. The search specification.

Character data

ClinicalTripReport. ActivityUID

Optional. The site visit activity ID.

Character data

ClinicalTripReport. ApproverLogin

Optional. The approver login.

Character data

ClinicalTripReport. Comment

Optional. Comments.

Character data

ClinicalTripReport. Completed

Optional. The completed flag.

Boolean

ClinicalTripReport. Description

Optional. The trip report description.

Character data

ClinicalTripReport. DisplayInvestigatorFirstName

Optional. The PI first name.

Character data

ClinicalTripReport. DisplayInvestigatorLastName

Optional. The PI last name.

Character data

ClinicalTripReport. Done

Optional. The completed date.

UTC Date Time

ClinicalTripReport. Planned

Optional. The planned date.

UTC Date Time

ClinicalTripReport. ProtocolNumber

Optional. The protocol number.

Character data

ClinicalTripReport. ProtocolSiteId

Optional. The site row ID.

Character data

ClinicalTripReport. ProtocolTitle

Optional. The protocol title.

Character data

ClinicalTripReport. ReviewerComments

Optional. Reviewer comments.

Character data

ClinicalTripReport. ReviewerLogin

Optional. The reviewer login ID.

Character data

ClinicalTripReport. ApproverComments

Optional. Approver comments.

Character data

ClinicalTripReport. SiteName

Optional. Trip report account.

Character data

ClinicalTripReport. SiteNumber

Optional. Site number.

Character data

ClinicalTripReport. Status

Optional. Status.

Character data

ClinicalTripReport. TemplateName

Optional. Template name.

Character data

ClinicalTripReport. TripReportCompleted

Optional. Trip report completed date.

Date

ClinicalTripReport. TripReportStatus

Optional. Trip report status.

Character data

ClinicalTripReport.Type

Optional. Visit type.

Character data

LsClinicalSiteVisitAssignee.Id

Optional. Row ID of the employee in the site visit team.

Character data

LsClinicalSiteVisitAssignee.Searchspec

Optional. The search specification.

Character data

LsClinicalSiteVisitAssignee. ActivityId

Optional. The activity ID of the employee in the site visit team.

Character data

LsClinicalSiteVisitAssignee. ConfigurationName

Optional. The configuration name.

Character data

LsClinicalSiteVisitAssignee. EMailAddr

Optional. Email address.

Character data

LsClinicalSiteVisitAssignee. EmpId

Optional. Employee ID.

Character data

LsClinicalSiteVisitAssignee. FirstName

Optional. The employee's first name.

Character data

LsClinicalSiteVisitAssignee. IsPrimaryOwner

Optional. Is Primary Owner flag.

Character data

LsClinicalSiteVisitAssignee. JobTitle

Optional. Job title.

Character data

LsClinicalSiteVisitAssignee. LastName

Optional. The employee's last name.

Character data

LsClinicalSiteVisitAssignee. Phone

Optional. Phone number.

Character data

LsClinicalSiteVisitAssignee. ShiftName

Optional. The shift name.

Character data

LsClinicalSiteVisitAssignee. UserId

Optional. The User ID.

Character data

ClinicalAttendee.Id

Optional. The Attendee's Row ID.

Character data

ClinicalAttendee. Searchspec

Optional. The search specification.

Character data

ClinicalAttendee. DisplayRole

Optional. The display role.

Character data

ClinicalAttendee. EmployeeFlag

Optional. The employee flag.

Boolean

ClinicalAttendee. FirstName

Optional. First name.

Character data

ClinicalAttendee. LastName

Optional. Last name.

Character data

ClinicalAttendee. Position

Optional. Position

Character data

ClinicalAttendeeStatic.Id

Optional. Attendee's row ID.

Character data

ClinicalAttendeeStatic. ActivityId

Optional. Attendee's activity ID.

Character data

ClinicalAttendeeStatic. ContactId

Optional. Contact ID.

Character data

ClinicalChecklist.Id

Optional. Checklist row ID.

Character data

ClinicalChecklist. Searchspec

Optional. Search specification.

Character data

ClinicalChecklist.ActivityUID

Optional. Checklist activity ID.

Character data

ClinicalChecklist. Category

Optional. Category

Character data

ClinicalChecklist. CreatedByName

Optional. Created user name.

Character data

ClinicalChecklist. Description

Optional. Description.

Character data

ClinicalChecklist. Display

Optional. Display for calendar activities.

Character data

ClinicalChecklist. ParentActivityId

Optional. Parent activity ID.

Character data

ClinicalChecklist. ShortComment

Optional. Comments.

Character data

ClinicalChecklist. Status

Optional. Status.

Character data

ClinicalChecklist. Type

Optional. Type.

Character data

ClinicalFollowUp.Id

Optional. Row ID of the clinical followup record.

Character data

ClinicalFollowUp. ActivityUID

Optional. Activity ID.

Character data

ClinicalFollowUp. CreatedByName

Optional. Created user name.

Character data

ClinicalFollowUp. Description

Optional. Description.

Character data

ClinicalFollowUp. Display

Optional. Display.

Character data

ClinicalFollowUp. Done

Optional. Completed date.

UTC Date Time

ClinicalFollowUp. Due

Optional. Due date.

UTC Date Time

ClinicalFollowUp. ParentActivityId

Optional. Parent activity ID.

Character data

ClinicalFollowUp. ShortComment

Optional. Comments.

Character data

ClinicalFollowUp. Status

Optional. Status.

Character data

ClinicalFollowUp. Type

Optional. Activity type.

Character data

ClinicalFollowUpSiteLevel.Id

Optional. Row ID of the followup site level record.

Character data

ClinicalFollowUpSiteLevel. ActivityUID

Optional. Activity ID.

Character data

ClinicalFollowUpSiteLevel. Category

Optional. Category.

Character data

ClinicalFollowUpSiteLevel. CreatedByName

Optional. Created user name.

Character data

ClinicalFollowUpSiteLevel. Description

Optional. Description.

Character data

ClinicalFollowUpSiteLevel. Display

Optional. Display.

Character data

ClinicalFollowUpSiteLevel. Done

Optional. Completed date.

UTC Date Time

ClinicalFollowUpSiteLevel. Due

Optional. Due date.

UTC Date Time

ClinicalFollowUpSiteLevel. ParentActivityId

Optional. Parent activity ID.

Character data

ClinicalFollowUpSiteLevel. ShortComment

Optional. Comments.

Character data

ClinicalFollowUpSiteLevel. Status

Optional. Status.

Character data

ClinicalFollowUpSiteLevel. Type

Optional. Type.

Character data

LsCaseReportFormsTracking.Id

Optional. Row ID of the case report form.

Character data

LsCaseReportFormsTracking. CRFPages

Optional. Number of case report form pages.

Integer

LsCaseReportFormsTracking. ActivityType

Optional. Activity type.

Character data

LsCaseReportFormsTracking. ActivityUID

Optional. Activity Id

Character data

LsCaseReportFormsTracking. Category

Optional. Category.

Character data

LsCaseReportFormsTracking. Comments

Optional. Comments.

Character data

LsCaseReportFormsTracking. OwnedById

Optional. Owner user ID.

Character data

LsCaseReportFormsTracking. ParentActivityId

Optional. Parent activity ID.

Character data

LsCaseReportFormsTracking. ParentTemplateVersion

Optional. Template version.

Character data

LsCaseReportFormsTracking. PrivateFlag

Optional. Private flag.

Boolean

LsCaseReportFormsTracking. Retrieved

Optional. Retrieved flag.

Boolean

LsCaseReportFormsTracking. RetrievedDate

Optional. Retrieved date.

UTC Date Time

LsCaseReportFormsTracking. SourceDocumentVerfied

Optional. Source Document Verified flag.

Boolean

LsCaseReportFormsTracking. SourceDocumentVerifiedDate

Optional. Source Document Verified date.

UTC Date Time

LsCaseReportFormsTracking. SubjectInitial

Optional. Subject initial.

Character data

LsCaseReportFormsTracking. SubjectNumber

Optional. Subject number.

Character data

LsCaseReportFormsTracking. Visit

Optional. Visit name.

Character data

LsCaseReportFormsTracking. VisitType

Optional. Visit type.

Character data

Request Message Description: TripReportInsertOrUpdate

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

Table 1254. Request Message Description: TripReportInsertOrUpdate
Node
Description
Type

ClinicalTripReport.Id

Required. Site visit row ID.

Character data

ClinicalTripReport. ActivityUID

Optional. Site visit activity ID.

Character data

ClinicalTripReport. ApproverLogin

Optional. Approver login.

Character data

ClinicalTripReport. Comment

Optional. Comments.

Character data

ClinicalTripReport. Completed

Optional. Completed flag.

Boolean

ClinicalTripReport. Description

Required. Trip Report Description

Character data

ClinicalTripReport. DisplayInvestigatorFirstName

Optional. The first name of the principal investigator.

Character data

ClinicalTripReport. DisplayInvestigatorLastName

Optional. PI last name.

Character data

ClinicalTripReport. Done

Optional. Completed date.

UTC Date Time

ClinicalTripReport. Planned

Optional. Planned date.

UTC Date Time

ClinicalTripReport. ProtocolSiteId

Required. Site row ID.

Character data

ClinicalTripReport. ReviewerComments

Optional. Reviewer comments.

Character data

ClinicalTripReport. ReviewerLogin

Optional. Reviewer login ID.

Character data

ClinicalTripReport. ApproverComments

Optional. Approver comments.

Character data

ClinicalTripReport. SiteNumber

Optional. Site number.

Character data

ClinicalTripReport. Status

Required. Status.

Character data

ClinicalTripReport. TemplateName

Optional. Template name.

Character data

ClinicalTripReport. TripReportCompleted

Optional. Trip report completed date.

Date

ClinicalTripReport. TripReportStatus

Optional. Trip report status.

Character data

ClinicalTripReport. Type

Required. Visit type.

Character data

LsClinicalSiteVisitAssignee. Id

Optional. Row ID of the employee in the site visit team.

Character data

LsClinicalSiteVisitAssignee. ActivityId

Required. Activity ID of the employee in the site visit team.

Character data

LsClinicalSiteVisitAssignee. ConfigurationName

Optional. Configuration name.

Character data

LsClinicalSiteVisitAssignee. EMailAddr

Optional. Email address.

Character data

LsClinicalSiteVisitAssignee. EmpId

Required. Employee ID.

Character data

LsClinicalSiteVisitAssignee. FirstName

Optional. Employee first name.

Character data

LsClinicalSiteVisitAssignee. IsPrimaryOwner

Optional. The Is Primary Owner flag.

Character data

LsClinicalSiteVisitAssignee. JobTitle

Optional. Job title.

Character data

LsClinicalSiteVisitAssignee. LastName

Optional. Employee last name.

Character data

LsClinicalSiteVisitAssignee. Phone

Optional. Phone number.

Character data

LsClinicalSiteVisitAssignee. ShiftName

Optional. Shift name.

Character data

LsClinicalSiteVisitAssignee. UserId

Optional. User ID.

Character data

ClinicalAttendeeStatic. Id

Optional. Row ID of the attendee.

Character data

ClinicalAttendeeStatic. ActivityId

Required. Activity ID of the attendee.

Character data

ClinicalAttendeeStatic. ContactId

Required. Contact ID.

Character data

ClinicalChecklist. Id

Required. Checklist row ID.

Character data

ClinicalChecklist. ActivityUID

Required. Checklist activity ID.

Character data

ClinicalChecklist. Category

Required. Category.

Character data

ClinicalChecklist. CreatedByName

Optional. Created user name

Character data

ClinicalChecklist. Description

Optional. Description.

Character data

ClinicalChecklist. Display

Optional. Display.

Character data

ClinicalChecklist. ParentActivityId

Required. Parent activity ID.

Character data

ClinicalChecklist. ShortComment

Optional. Comments.

Character data

ClinicalChecklist. Status

Optional. Status.

Character data

ClinicalChecklist. Type

Optional. Type.

Character data

LsClinicalChecklistAssignee. Id

Optional. Checklist assignee Row ID.

Character data

LsClinicalChecklistAssignee. ActivityId

Required. Activity ID.

Character data

LsClinicalChecklistAssignee. ConfigurationName

Optional. Configuration name.

Character data

LsClinicalChecklistAssignee. EMailAddr

Optional. Email address.

Character data

LsClinicalChecklistAssignee. FirstName

Optional. First name.

Character data

LsClinicalChecklistAssignee. IsPrimaryOwner

Optional. Primary Owner flag.

Character data

LsClinicalChecklistAssignee. JobTitle

Optional. Job title.

Character data

LsClinicalChecklistAssignee. LastName

Optional. Last name.

Character data

LsClinicalChecklistAssignee. Phone

Optional. Phone.

Character data

LsClinicalChecklistAssignee. UserId

Optional. User ID.

Character data

LsClinicalChecklistAssignee. ShiftName

Optional. Shift name.

Character data

LsClinicalChecklistAssignee. EmpId

Required. Employee ID.

Character data

ClinicalFollowUp. Id

Required. Clinical followup Row ID.

Character data

ClinicalFollowUp. ActivityUID

Required. Activity ID.

Character data

ClinicalFollowUp.Category

Required.

Character data

ClinicalFollowUp. CreatedByName

Optional. Created user name.

Character data

ClinicalFollowUp. Description

Optional. Description.

Character data

ClinicalFollowUp. Display

Optional. Display.

Character data

ClinicalFollowUp. Done

Optional. Completed date.

UTC Date Time

ClinicalFollowUp. Due

Optional. Due Date

UTC Date Time

ClinicalFollowUp. ParentActivityId

Required. Parent activity ID.

Character data

ClinicalFollowUp. ShortComment

Optional. Comments.

Character data

ClinicalFollowUp. Status

Optional. Status.

Character data

ClinicalFollowUp. Type

Optional. Activity type.

Character data

LsClinicalFollowUpAssignee. Id

Optional. Followup item assignee row ID.

Character data

LsClinicalFollowUpAssignee. ActivityId

Required. Activity ID.

Character data

LsClinicalFollowUpAssignee. ConfigurationName

Optional. Configuration name.

Character data

LsClinicalFollowUpAssignee. EMailAddr

Optional. Email address.

Character data

LsClinicalFollowUpAssignee. EmpId

Required. Employee ID.

Character data

LsClinicalFollowUpAssignee. FirstName

Optional. First name.

Character data

LsClinicalFollowUpAssignee. IsPrimaryOwner

Optional. Primary Owner flag.

Character data

LsClinicalFollowUpAssignee. JobTitle

Optional. Job title.

Character data

LsClinicalFollowUpAssignee. LastName

Optional. Last name.

Character data

LsClinicalFollowUpAssignee. Phone

Optional. Phone.

Character data

LsClinicalFollowUpAssignee. ShiftName

Optional. Shift name.

Character data

LsClinicalFollowUpAssignee. UserId

Optional. User ID.

Character data

LsCaseReportFormsTracking. Id

Required. Case report form row ID.

Character data

LsCaseReportFormsTracking. CRFPages

Optional. The number of case report form pages.

Integer

LsCaseReportFormsTracking. ActivityType

Optional. Activity type.

Character data

LsCaseReportFormsTracking. ActivityUID

Required. Activity ID.

Character data

LsCaseReportFormsTracking. Category

Required. Category.

Character data

LsCaseReportFormsTracking. Comments

Optional. Comments.

Character data

LsCaseReportFormsTracking. OwnedById

Optional. Owner User ID.

Character data

LsCaseReportFormsTracking. ParentActivityId

Required. Parent activity ID.

Character data

LsCaseReportFormsTracking. ParentTemplateVersion

Required. Template version.

Character data

LsCaseReportFormsTracking. PrivateFlag

Optional. The Private flag.

Boolean

LsCaseReportFormsTracking. Retrieved

Optional. Retrieved flag.

Boolean

LsCaseReportFormsTracking. RetrievedDate

Optional. Retrieved date.

UTC Date Time

LsCaseReportFormsTracking. SourceDocumentVerfied

Optional. The Source Document Verified flag.

Boolean

LsCaseReportFormsTracking. SourceDocumentVerifiedDate

Optional. Source document verified date.

UTC Date Time

LsCaseReportFormsTracking. SubjectInitial

Required. Subject initial.

Character data

LsCaseReportFormsTracking. SubjectNumber

Required. Subject number.

Character data

LsCaseReportFormsTracking. Visit

Required. Visit name.

Character data

LsCaseReportFormsTracking. VisitType

Required. Visit type.

Character data

LsClinicalGeoLocation. Id

Required. Geo location row ID.

Character data

LsClinicalGeoLocation. Comments

Optional. Comments.

Character data

LsClinicalGeoLocation. EmpId

Required. Employee ID.

Character data

LsClinicalGeoLocation. Latitude

Optional. Latitude.

Number

LsClinicalGeoLocation. LoginId

Optional. Login ID.

Character data

LsClinicalGeoLocation. Longitude

Optional. Longitude.

Number

LsClinicalGeoLocation. SiteVisitId

Required. Site visit row ID.

Character data

LsClinicalGeoLocation VisitDate

Required. Visit date.

Date Time

Request Message Description: TripReportUpdate

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

Table 1255. Request Message Description: TripReportUpdate
Node
Description
Type

ClinicalTripReport.Id

Required. Site visit row ID.

Character data

ClinicalTripReport. ActivityUID

Optional. Site visit activity ID.

Character data

ClinicalTripReport. ApproverLogin

Optional. Approver login.

Character data

ClinicalTripReport. Comment

Optional. Comments.

Character data

ClinicalTripReport. Completed

Optional. The Completed flag.

Boolean

ClinicalTripReport. Description

Required. Trip report description.

Character data

ClinicalTripReport. DisplayInvestigatorFirstName

Optional. PI first name.

Character data

ClinicalTripReport. DisplayInvestigatorLastName

Optional. PI last name.

Character data

ClinicalTripReport. Done

Optional. Completed date.

UTC Date Time

ClinicalTripReport. Planned

Optional. Planned date.

UTC Date Time

ClinicalTripReport. ProtocolSiteId

Required. Site row ID.

Character data

ClinicalTripReport. ReviewerComments

Optional. Reviewer comments.

Character data

ClinicalTripReport. ReviewerLogin

Optional. Review login ID.

Character data

ClinicalTripReport. ApproverComments

Optional. Approver comments.

Character data

ClinicalTripReport. SiteNumber

Optional. Site number.

Character data

ClinicalTripReport. Status

Required. Status.

Character data

ClinicalTripReport. TemplateName

Optional. Template name.

Character data

ClinicalTripReport. TripReportCompleted

Optional. Trip report completed date.

Date

ClinicalTripReport. TripReportStatus

Optional. Trip report status.

Character data

ClinicalTripReport. Type

Required. Visit type.

Character data

Request Message Description: TripReportSynchronize

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

Table 1256. Request Message Description: TripReportSynchronize
Node
Description
Type

ClinicalTripReport.Id

Required. Site visit row ID.

Character data

ClinicalTripReport. ApproverLogin

Optional. Approver login.

Character data

ClinicalTripReport. Comment

Optional. Comments.

Character data

ClinicalTripReport. Completed

Optional. Completed flag.

Character data

ClinicalTripReport. Description

Required. Trip report description.

Character data

ClinicalTripReport. DisplayInvestigatorFirstName

Optional. First name of principal investigator.

Character data

ClinicalTripReport. DisplayInvestigatorLastName

Optional. Last name of the principal investigator.

Character data

ClinicalTripReport. Done

Optional. Completed date.

UTC Date Time

ClinicalTripReport. Planned

Optional. Planned date.

UTC Date Time

ClinicalTripReport. ProtocolSiteId

Required. Site row ID.

Character data

ClinicalTripReport. ReviewerComments

Optional. Reviewer comments,

Character data

ClinicalTripReport. ReviewerLogin

Optional. Reviewer login ID.

Character data

ClinicalTripReport. ApproverComments

Optional. Approver comments.

Character data

ClinicalTripReport. SiteNumber

Optional. Site number.

Character data

ClinicalTripReport. Status

Required. Status.

Character data

ClinicalTripReport. TemplateName

Optional. Template name.

Character data

ClinicalTripReport. TripReportCompleted

Optional. Trip report completed date.

Date

ClinicalTripReport. TripReportStatus

Optional. Trip report status.

Character data

ClinicalTripReport. Type

Required. Visit type.

Character data

LsClinicalSiteVisitAssignee. Id

Optional. Row ID of the employee in the site visit team.

Character data

LsClinicalSiteVisitAssignee. ActivityId

Required. Activity ID of the employee in the site visit team.

Character data

LsClinicalSiteVisitAssignee. ConfigurationName

Optional. Configuration name.

Character data

LsClinicalSiteVisitAssignee. EMailAddr

Optional. Email address.

Character data

LsClinicalSiteVisitAssignee. EmpId

Required. Employee ID.

Character data

LsClinicalSiteVisitAssignee. FirstName

Optional. Employee first name.

Character data

LsClinicalSiteVisitAssignee. IsPrimaryOwner

Optional. Is Primary Owner flag.

Character data

LsClinicalSiteVisitAssignee. JobTitle

Optional. Job title.

Character data

LsClinicalSiteVisitAssignee. LastName

Optional. Employee last name.

Character data

LsClinicalSiteVisitAssignee. Phone

Optional. Phone number.

Character data

LsClinicalSiteVisitAssignee. ShiftName

Optional. Shift name.

Character data

LsClinicalSiteVisitAssignee. UserId

Optional. User ID.

Character data

ClinicalAttendeeStatic. Id

Optional. Attendees row ID.

Character data

ClinicalAttendeeStatic. ActivityId

Required. Attendee's Activity ID.

Character data

ClinicalAttendeeStatic. ContactId

Required. Contact ID.

Character data

ClinicalFollowUp. Id

Required. Clinical followup row ID.

Character data

ClinicalFollowUp. ActivityUID

Required. Activity ID.

Character data

ClinicalFollowUp. Category

Required. Category.

Character data

ClinicalFollowUp. CreatedByName

Optional. Created user name.

Character data

ClinicalFollowUp. Description

Optional. Description.

Character data

ClinicalFollowUp. Display

Optional. Display.

Character data

ClinicalFollowUp. Done

Optional. Completed date.

UTC date and time.

ClinicalFollowUp. Due

Optional. Due date.

UTC date and time.

ClinicalFollowUp. ParentActivityId

Required. Parent Activity ID.

Character data

ClinicalFollowUp. ShortComment

Optional. Comments.

Character data

ClinicalFollowUp. Status

Optional. Status.

Character data

ClinicalFollowUp. Type

Optional. Activity type.

Character data

LsClinicalFollowUpAssignee. Id

Required. Followup item assignee row ID.

Character data

LsClinicalFollowUpAssignee. ActivityId

Required. Activity ID.

Character data

LsClinicalFollowUpAssignee. ConfigurationName

Optional. Configuration name.

Character data

LsClinicalFollowUpAssignee. EMailAddr

Optional. Email address.

Character data

LsClinicalFollowUpAssignee. EmpId

Required. Employee ID.

Character data

LsClinicalFollowUpAssignee. FirstName

Optional. First name.

Character data

LsClinicalFollowUpAssignee. IsPrimaryOwner

Optional. Primary Owner flag.

Character data

LsClinicalFollowUpAssignee. JobTitle

Optional. Job title.

Character data

LsClinicalFollowUpAssignee. LastName

Optional. Last name.

Character data

LsClinicalFollowUpAssignee. Phone

Optional. Phone.

Character data

LsClinicalFollowUpAssignee. ShiftName

Optional. Shift name.

Character data

LsClinicalFollowUpAssignee. UserId

Optional. User ID.

Character data

LsCaseReportFormsTracking. Id

Required. Case report form row ID.

Character data

LsCaseReportFormsTracking. CRFPages

Optional. Number of Case report form pages.

Character data

LsCaseReportFormsTracking. ActivityType

Optional. Activity type.

Character data

LsCaseReportFormsTracking. ActivityUID

Required. Activity ID.

Character data

LsCaseReportFormsTracking. Category

Required. Category.

Character data

LsCaseReportFormsTracking. Comments

Optional. Comments.

Character data

LsCaseReportFormsTracking. OwnedById

Optional. Owner's user ID.

Character data

LsCaseReportFormsTracking. ParentActivityId

Required. Parent activity ID.

Character data

LsCaseReportFormsTracking. ParentTemplateVersion

Optional. Template version.

Character data

LsCaseReportFormsTracking. PrivateFlag

Optional. Private flag.

Character data

LsCaseReportFormsTracking. Retrieved

Optional. Retrieved flag.

Character data

LsCaseReportFormsTracking. RetrievedDate

Optional. Retrieved date.

UTC date and time

LsCaseReportFormsTracking. SourceDocumentVerfied

Optional. Source Document Verified flag.

Character data

LsCaseReportFormsTracking. SourceDocumentVerifiedDate

Optional. Source document verified date.

UTC date and time.

LsCaseReportFormsTracking. SubjectInitial

Optional. Required subject initial.

Character data

LsCaseReportFormsTracking. SubjectNumber

Required. Subject number.

Character data

LsCaseReportFormsTracking. Visit

Required. Visit name.

Character data

LsCaseReportFormsTracking. VisitType

Required. Visit type.

Character data

Response Message Description: All SWILSClinicalTripReportInterfaceService Query Operations

For a description of these response messages, see Table 1257.

Table 1257. Response Message Description: All SWILSClinicalTripReportInterfaceService Query Operations
Node
Description
Type

ClinicalTripReport. Id

Site visit row ID.

Character data

ClinicalTripReport. ActivityUID

Site visit activity ID.

Character data

ClinicalTripReport. ApproverLogin

Approver login.

Character data

ClinicalTripReport. Comment

Comments.

Character data

ClinicalTripReport. Completed

The Completed flag.

Boolean

ClinicalTripReport. Description

Trip report description.

Character data

ClinicalTripReport. DisplayInvestigatorFirstName

The first name of the principal investigator.

Character data

ClinicalTripReport. DisplayInvestigatorLastName

The last name of the principal investigator.

Character data

ClinicalTripReport. Done

Completed date.

UTC date time

ClinicalTripReport. Planned

Planned date.

UTC Date Time

ClinicalTripReport. ProtocolNumber

Protocol number.

Character data

ClinicalTripReport. ProtocolSiteId

Site row ID.

Character data

ClinicalTripReport. ProtocolTitle

Protocol title.

Character data

ClinicalTripReport. ReviewerComments

Reviewer comments.

Character data

ClinicalTripReport. ReviewerLogin

Reviewer login ID.

Character data

ClinicalTripReport. ApproverComments

Approver comments.

Character data

ClinicalTripReport. SiteName

Trip report account.

Character data

ClinicalTripReport. SiteNumber

Site number.

Character data

ClinicalTripReport. Status

Status.

Character data

ClinicalTripReport. TemplateName

Template name.

Character data

ClinicalTripReport. TripReportCompleted

Trip report completed date.

Date

ClinicalTripReport. TripReportStatus

Trip report status.

Character data

ClinicalTripReport. Type

Visit type.

Character data

LsClinicalSiteVisitAssignee. Id

Row ID of the employee in the site visit team.

Character data

LsClinicalSiteVisitAssignee. ActivityId

Activity ID of the employee in the site visit team.

Character data

LsClinicalSiteVisitAssignee. ConfigurationName

Configuration name.

Character data

LsClinicalSiteVisitAssignee. EMailAddr

Email address.

Character data

LsClinicalSiteVisitAssignee. EmpId

Employee ID.

Character data

LsClinicalSiteVisitAssignee. FirstName

Employee first name.

Character data

LsClinicalSiteVisitAssignee. IsPrimaryOwner

Is Primary Owner flag.

Character data

LsClinicalSiteVisitAssignee. JobTitle

Job title.

Character data

LsClinicalSiteVisitAssignee. LastName

Employee last name.

Character data

LsClinicalSiteVisitAssignee. Phone

Phone number.

Character data

LsClinicalSiteVisitAssignee. ShiftName

Shift name.

Character data

LsClinicalSiteVisitAssignee. UserId

User ID.

Character data

LSClinicalSiteVisitAssignee_Position. Division

Division.

Character data

LSClinicalSiteVisitAssignee_Position. Name

Position name.

Character data

LSClinicalSiteVisitAssignee_Responsibility. Responsibility

Responsibility.

Character data

LSClinicalSiteVisitAssignee_Responsibility. PrimaryOrganization

Primary organization.

Character data

ListOfLSClinicalSiteVisitAssignee_Subcontractor. Subcontractor Name

Subcontractor name.

Character data

ClinicalAttendee. Id

Row ID of the attendee.

Character data

ClinicalAttendee. DisplayRole

Display role.

Character data

ClinicalAttendee. EmployeeFlag

Employee flag.

Boolean

ClinicalAttendee. FirstName

First name.

Character data

ClinicalAttendee. LastName

Last name.

Character data

ClinicalAttendee. Position

Position.

Character data

ClinicalAttendeeStatic. Id

Attendees row ID.

Character data

ClinicalAttendeeStatic. ActivityId

Attendee Activity ID.

Character data

ClinicalAttendeeStatic. ContactId

Contact ID

Character data

ClinicalChecklist. Id

Checklist row ID

Character data

ClinicalChecklist. ActivityUID

Checklist Activity ID.

Character data

ClinicalChecklist. Category

Category.

Character data

ClinicalChecklist. CreatedByName

Created user name.

Character data

ClinicalChecklist. Description

Description.

Character data

ClinicalChecklist. Display

Display.

Character data

ClinicalChecklist. ParentActivityId

Parent activity ID.

Character data

ClinicalChecklist. ShortComment

Comments.

Character data

ClinicalChecklist. Status

Status.

Character data

ClinicalChecklist. Type

Type.

Character data

LsClinicalChecklistAssignee. Id

Checklist assignee row ID.

Character data

LsClinicalChecklistAssignee. ActivityId

Activity ID.

Character data

LsClinicalChecklistAssignee. ConfigurationName

Configuration name.

Character data

LsClinicalChecklistAssignee. EMailAddr

Email address.

Character data

LsClinicalChecklistAssignee. FirstName

First name.

Character data

LsClinicalChecklistAssignee. IsPrimaryOwner

Is Primary Owner flag.

Character data

LsClinicalChecklistAssignee. JobTitle

Job title.

Character data

LsClinicalChecklistAssignee. LastName

Last name.

Character data

LsClinicalChecklistAssignee. Phone

Phone number.

Character data

LsClinicalChecklistAssignee. UserId

User ID.

Character data

LsClinicalChecklistAssignee. ShiftName

Schedule name.

Character data

LsClinicalChecklistAssignee. EmpId

Employee ID.

Character data

ClinicalFollowUp. Id

Clinical followup row ID.

Character data

ClinicalFollowUp. ActivityUID

Activity ID.

Character data

ClinicalFollowUp. Category

Category.

Character data

ClinicalFollowUp. CreatedByName

Created user name.

Character data

ClinicalFollowUp. Description

Description.

Character data

ClinicalFollowUp. Display

Display.

Character data

ClinicalFollowUp. Done

Completed date.

UTC Date Time

ClinicalFollowUp. Due

Due date.

UTC Date Time

ClinicalFollowUp. ParentActivityId

Parent activity ID

Character data

ClinicalFollowUp. ShortComment

Comments.

Character data

ClinicalFollowUp. Status

Status.

Character data

ClinicalFollowUp. Type

Activity type.

Character data

LsClinicalFollowUpAssignee. Id

Followup assignee row ID.

Character data

LsClinicalFollowUpAssignee. ActivityId

Activity ID.

Character data

LsClinicalFollowUpAssignee. ConfigurationName

Configuration name.

Character data

LsClinicalFollowUpAssignee. EmailAddr

Email address.

Character data

LsClinicalFollowUpAssignee. EmpId

Employee ID.

Character data

LsClinicalFollowUpAssignee. FirstName

First name.

Character data

LsClinicalFollowUpAssignee. IsPrimaryOwner

Is Primary Owner flag.

Character data

LsClinicalFollowUpAssignee. JobTitle

Job title.

Character data

LsClinicalFollowUpAssignee. LastName

Last name.

Character data

LsClinicalFollowUpAssignee. Phone

Phone number.

Character data

LsClinicalFollowUpAssignee. ShiftName

Schedule name.

Character data

LsClinicalFollowUpAssignee. UserId

User ID.

Character data

LSClinicalFollowUpAssignee_Position. Division

Position division.

Character data

LSClinicalFollowUpAssignee_Position. Name

Position.

Character data

LSClinicalFollowUpAssignee_Responsibility. Responsibility

Responsibility.

Character data

LSClinicalFollowUpAssignee_Subcontractor. SubcontractorName

Subcontractor name.

Character data

ClinicalFollowUpSiteLevel. Id

Followup site level row ID.

Character data

ClinicalFollowUpSiteLevel. ActivityUID

Activity ID.

Character data

ClinicalFollowUpSiteLevel. Category

Category.

 

ClinicalFollowUpSiteLevel. CreatedByName

Created user name.

Character data

ClinicalFollowUpSiteLevel. Description

Description.

Character data

ClinicalFollowUpSiteLevel. Display

Display.

Character data

ClinicalFollowUpSiteLevel. Done

Completed date.

UTC Date Time

ClinicalFollowUpSiteLevel. Due

Due date.

UTC Date Time

ClinicalFollowUpSiteLevel. ParentActivityId

Parent activity ID.

Character data

ClinicalFollowUpSiteLevel. ShortComment

Comments.

Character data

ClinicalFollowUpSiteLevel. Status

Status.

Character data

ClinicalFollowUpSiteLevel. Type

Type.

Character data

LsClinicalFollowUpSiteLevelAssignee. Id

Site level assignee row ID.

Character data

LsClinicalFollowUpSiteLevelAssignee. ActivityId

Activity ID.

Character data

LsClinicalFollowUpSiteLevelAssignee. ConfigurationName

Configuration name.

Character data

LsClinicalFollowUpSiteLevelAssignee. EMailAddr

Email address.

Character data

LsClinicalFollowUpSiteLevelAssignee. EmpId

Employee ID.

Character data

LsClinicalFollowUpSiteLevelAssignee. FirstName

First Name

Character data

LsClinicalFollowUpSiteLevelAssignee. IsPrimaryOwner

The Primary Owner flag.

Character data

LsClinicalFollowUpSiteLevelAssignee. JobTitle

Job title.

Character data

LsClinicalFollowUpSiteLevelAssignee. LastName

Last name.

Character data

LsClinicalFollowUpSiteLevelAssignee. Phone

Phone.

Character data

LsClinicalFollowUpSiteLevelAssignee. ShiftName

Shift name.

Character data

LsClinicalFollowUpSiteLevelAssignee. UserId

User ID.

Character data

LSClinicalFollowUpSiteLevelAssignee_Position. Division

Position division.

Character data

LSClinicalFollowUpSiteLevelAssignee_Position. Name

Position.

Character data

LSClinicalFollowUpSiteLevelAssignee_Responsibility. Responsibility

Responsibility.

Character data

LSClinicalFollowUpSiteLevelAssignee_Subcontractor. SubcontractorName

Contractor name.

Character data

LsCaseReportFormsTracking. Id

Case report form row ID.

Character data

LsCaseReportFormsTracking. CRFPages

Number of case report form pages.

Number

LsCaseReportFormsTracking. ActivityType

Activity type.

Character data

LsCaseReportFormsTracking. ActivityUID

Activity ID.

Character data

LsCaseReportFormsTracking. Category

Category.

Character data

LsCaseReportFormsTracking. Comments

Comments.

Character data

LsCaseReportFormsTracking. OwnedById

Owner user ID.

Character data

LsCaseReportFormsTracking. ParentActivityId

Parent activity ID.

Character data

LsCaseReportFormsTracking. ParentTemplateVersion

Template version.

Character data

LsCaseReportFormsTracking. PrivateFlag

Private flag.

Boolean

LsCaseReportFormsTracking. Retrieved

Retrieved flag.

Character data

LsCaseReportFormsTracking. RetrievedDate

Retrieved date.

UTC Date Time

LsCaseReportFormsTracking. SourceDocumentVerified

Source Document Verified flag.

Boolean

LsCaseReportFormsTracking. SourceDocumentVerifiedDate

Source document verification date

UTC Date Time

LsCaseReportFormsTracking. SubjectInitial

Subject initial.

Character data

LsCaseReportFormsTracking. SubjectNumber

Subject number.

Character data

LsCaseReportFormsTracking. Visit

Visit name.

Character data

LsCaseReportFormsTracking. VisitType

Visit type.

Character data

LsClinicalGeoLocation. Id

Geo location row ID.

Character data

LsClinicalGeoLocation. Comments

Comments.

Character data

LsClinicalGeoLocation. EmpId

Employee ID.

Character data

LsClinicalGeoLocation. Latitude

Latitude.

Number

LsClinicalGeoLocation. LoginId

Login user.

Character data

LsClinicalGeoLocation. Longitude

Longitude.

Number

LsClinicalGeoLocation. SiteVisitId

Site visit row ID.

Character data

LsClinicalGeoLocation. VisitDate

Visit date.

Date Time

SWILSClinicalTripReportInterfaceService 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 1258.

Table 1258. SWILSClinicalTripReportInterfaceService Service Object
Name
Boundary Object Type
Class

LS Clinical Trip Report Interface Services

Business Service

CSSEAIDataSyncService

Data Object (Integration Object)

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

Table 1259. SWILSClinicalTripReportInterfaceService Data Object
Siebel Repository Name
External Name

LS Clinical Trip Report Interface IO

Clinical Trip Report

Example Package for SWILSClinicalTripReportInterfaceService

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:

...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-QueryByExample-request.xml

...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-QueryPage-request.xml

...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-QueryById-request.xml

...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-InsertOrUpdate-request.xml

...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-Update-request.xml

...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-Synchronize-request.xml

Interface Description (WSDL) for SWILSClinicalTripReportInterfaceService

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.

...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-QueryByExample.WSDL

...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-QueryPage.WSDL

...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-QueryById.WSDL

...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-InsertOrUpdate.WSDL

...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-Synchronize.WSDL

...\SWILSClinicalTripReportInterfaceService\SWILSClinicalTripReportInterfaceService-Update.WSDL

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