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

LS Clinical Protocol Site Interface Service


Use this generic ASI-based Web service to pull information from protocol sites using Protocol Site, Region, or Protocol.

LS Clinical Protocol Interface Service Operations

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

Table 341. LS Clinical Clinical Protocol Interface Service Operations
Name
Description

QueryById

This operation returns Protocol Site Information for the specified Protocol Site Id in the "Id" tag.

QueryByExample

Used to query all the Sites information based on given filter criteria.

QueryPage

Used to query all the Sites details in pages based on given filter criteria.

Request Message Description: QueryById

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

Table 342. Request Message Description: QueryById
Name
Description
Type

PrimaryRowId

Required. Specify the Protocol Site RowId value for which the Protocol Site information should be returned.

String

UTCCanonical

This flag is N by default. If this flag is enabled (Y), then data from the Siebel application must be in UTC (Coordinated Universal Time) and canonical format. The data in UTC and canonical format is converted to Siebel Object Manager format as determined by the value of the UTCCanonical flag.

Boolean

Request Message Description: QueryByExample

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

Table 343. Request Message Description: QueryByExample
Node
Description
Type

ClinicalProtocolSite.
CompletedCount

Count of the subjects for which the status tracking visit is completed.

Number

ClinicalProtocolSite.Early
TerminatedCount

Count of the subjects that are early terminated.

Number

ClinicalProtocolSite.
EnrolledCount

Count of the subjects that are successfully enrolled.

Number

ClinicalProtocolSite.
PlannedSubjects

Number of planned subjects for the site.

Number

ClinicalProtocolSite.
Re-ScreenedCount

Count of the subjects that are rescreened.

Number

ClinicalProtocolSite.ScreenFailuresCount

Count of the subjects that are screen failed.

Number

ClinicalProtocolSite.
ScreenedCount

Count of the subjects that are screened successfully failed.

Number

ClinicalProtocolSite.AccountId

Account row ID.

Character data

ClinicalProtocolSite.
ActivateSynchronization
Flag

A Boolean flag that indicates if the sites are activated for synchronization. Used for SC-OC integration.

Boolean

ClinicalProtocolSite.
PrimarySiteAddress

Primary site address associated for the site. This is used for SC-OC integration.

Character data

ClinicalProtocolSite.
PrimarySiteAddressRowId

Primary site address row ID associated for the site. This is used for SC-OC integration.

Character data

ClinicalProtocolSite.Site
AddressType

Site address type.

Character data

ClinicalProtocolSite.
AmountCurrencyCode

Currency code of the site

Character data

ClinicalProtocolSite.
AmountEarnedToDate

Amount earned by the principal investigator.

Number

ClinicalProtocolSite.
AmountExchangeDate

Exchange date for the amount at the site.

Date

ClinicalProtocolSite.
AmountPaidToDate

Amount paid by the principal investigator.

Number

ClinicalProtocolSite.
CDMSSite

The integration name used for the protocol or study. This is used for SC-OC integration.

Character data

ClinicalProtocolSite.CDMSStudyId

The RowId of the Study/Protocol. This is used for SC-OC Integration.

Character data

ClinicalProtocolSite.City

City.

Character data

ClinicalProtocolSite.ClinicalProgramId

Program row ID.

Character data

ClinicalProtocolSite.ClinicalProgramName

Program name.

Character data

ClinicalProtocolSite.
Country

Country.

Character data

ClinicalProtocolSite.
Description

Description.

Character data

ClinicalProtocolSite.Email

Email address.

Character data

ClinicalProtocolSite.
FaxNumber

Fax number.

Number

ClinicalProtocolSite.
FirstSubjectEnrolledDate

Date when the subject was first enrolled.

Date

ClinicalProtocolSite.SiteRowId

Site row ID.

Character data

ClinicalProtocolSite.
InitiationCompletedDate

Date when the subject was first enrolled.

Date

ClinicalProtocolSite.
PrimaryInvestigatorFirst
Name

Principal investigator first name.

Character data

ClinicalProtocolSite.
PrimaryInvestigatorLast
Name

Principal investigator last name.

Character data

ClinicalProtocolSite.Last
CompletedDateFlag

Boolean flag value indicates if the reschedule should happen on the last completed date.

Boolean

ClinicalProtocolSite.Last
SubjectOffStudyDate

Date when the last subject was terminated.

Date

ClinicalProtocolSite.Locale
Id

Locale row ID.

Character data

ClinicalProtocolSite.LocaleName

Locale name.

Character data

ClinicalProtocolSite.Max
EnrollmentNumber

Maximum enrolled subjects.

Number

ClinicalProtocolSite.No
SubjectInfoFlag

Boolean flag indicating if the site has no subjects.

Boolean

ClinicalProtocolSite.PhoneNumber

Phone number.

Character data

ClinicalProtocolSite.
PrevCDMSSite

Previous CDMSSite. Used for SC-OC integration.

Character data

ClinicalProtocolSite.
PrimaryAddressId

Primary address row ID.

Character data

ClinicalProtocolSite.
PrimaryInvestigatorId

Primary investigator row ID.

Character data

ClinicalProtocolSite.
PrimaryPositionId

Primary position row ID.

Character data

ClinicalProtocolSite.
PrimarySubjectTemplate
Id

Primary Subject Template row ID.

Character data

ClinicalProtocolSite.
ProtocolId

Protocol row ID.

Character data

ClinicalProtocolSite.
ProtocolNumber

Protocol number.

Character data

ClinicalProtocolSite.
ProtocolNumberSites
Planned

Number of sites planned for the protocol.

Number

ClinicalProtocolSite.
ProtocolNumberSubjects
Planned

Number of subjects panned for the protocol.

Number

ClinicalProtocolSite.
ProtocolProductName

Product name associated to the protocol.

Character data

ClinicalProtocolSite.
ProtocolProgram
Indication

Program indication associated to the protocol.

Character data

ClinicalProtocolSite.
ProtocolSiteId

Protocol site row ID.

Character data

ClinicalProtocolSite.
ProtocolStatus

Protocol status.

Character data

ClinicalProtocolSite.
ProtocolTitle

Protocol title.

Character data

ClinicalProtocolSite.
Region

Region name.

Character data

ClinicalProtocolSite.
RegionPlannedSites

Planned number of sites for the region.

Character data

ClinicalProtocolSite.
RegionPlannedSubjects

Planned number of subjects for the region.

Character data

ClinicalProtocolSite.
RegionId

Region row ID.

Character data

ClinicalProtocolSite.
RegionNoSiteInfoFlag

Boolean flag, indicates if the region has no sites.

Boolean

ClinicalProtocolSite.
RegionStatus

Region status.

Character data

ClinicalProtocolSite.
RegionsRequiredFlag

Boolean flag, indicates if the regions are mandatory for the protocol.

Boolean

ClinicalProtocolSite.
SiteBillToAddressId

Site billed to assigned address row ID.

Character data

ClinicalProtocolSite.
SiteBillToContactId

Site billed to assigned contact ID.

Character data

ClinicalProtocolSite.Site
AccountRowId

Account Row Id assigned to the Site

Character data

ClinicalProtocolSite.Site
AccountName

Account name.

Character data

ClinicalProtocolSite.Site
Number

Site number.

Character data

ClinicalProtocolSite.State

State.

Character data

ClinicalProtocolSite.Status

Status.

Character data

ClinicalProtocolSite.StreetAddress

Street sddress.

Character data

ClinicalProtocolSite.
TerminatedDate

Terminated date.

Date

ClinicalProtocolSite.Time
Zone

Time zone in which the site is operating.

Character data

ClinicalProtocolSite.Time
ZoneId

Time zone row ID.

Character data

ClinicalProtocolSite.
TotalContractAmount

Total contract amount rolled up for the site.

Number

ClinicalProtocolSite.
TotalVATAmount

Total VAT amount rolled up to the site.

Number

ClinicalProtocolSite.
WithholdingAmount

Site withholding amount.

Number

ClinicalProtocolSite.
WithholdingPercentage

Site withholding amount percentrage.

Number

ClinicalProtocolSite.Zip

ZIP code.

Character data

ClinicalProtocolSite.
Searchspec

Search specification.

Character data

ClinicalProtocolSite_
Position.Division

Division.

Character data

ClinicalProtocolSite_
Position.DivisionBU

Division business unit.

Character data

ClinicalProtocolSite_
Position.DivisionLocation

Division location.

Character data

ClinicalProtocolSite_
Position.IsPrimaryMVG

Boolean flag indicating if the position is primary at the site.

Boolean

ClinicalProtocolSite_
Position.Name2

Name.

Character data

ClinicalProtocolSite_
Position.RowStatus

Position status.

Character data

ClinicalProtocolSite_
Position.SalesRep

Sales representative.

Character data

ClinicalProtocolSite_
Position.Searchspec

Search specification.

Character data

ClinicalProtocolSite_
SubjectTemplate.
IRBApprovalDate

IRB approval date for the associated SVT.

Date

ClinicalProtocolSite_
SubjectTemplate.
IsPrimaryMVG

Boolean flag indicating if the subject template is primary at the site.

Boolean

ClinicalProtocolSite_
SubjectTemplate.Version

Subject template version.

Character data

ClinicalProtocolSite_
SubjectTemplate.
Searchspec

Subject template search specification.

Character data

Request Message Description: QueryPage

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

Table 344. Request Message Description: QueryPage
Name
Description
Type

UTCCanonical

This flag is N by default. If this flag is enabled (Y), then data from the Siebel application must be in UTC (Coordinated Universal Time) and canonical format. The data in UTC and canonical format is converted to Siebel Object Manager format as determined by the value of the UTCCanonical flag.

Boolean

SortSpec

Determines whether the sort order is ascending or descending. Valid values are ASC or DEC.

Character Data

StartRowNum

Determines the starting point for record retrieval. The 0-based index of the record within the recordset.

Number

LastPage

Indicates whether the record being returned is the last record in the record set. Valid values are true or false.

Character Data

PageSize

The number of records to be returned for a component. The default page size is 10. Note that there is a server parameter that controls the maximum page size (MaximumPageSize). If the pagesize attribute is greater than the maximum pagesize defined in the server parameter, an error occurs.

Number

ClinicalProtocolSite.CompletedCount

Required. Can be either '*' or a valid number.

Number

ClinicalProtocolSite.Early
TerminatedCount

An optional search specification.

Number

ClinicalProtocolSite.EnrolledCount

Required. Can be either '*' or a valid number.

Number

ClinicalProtocolSite.PlannedSubjects

Required. Can be either '*' or a valid number.

Number

ClinicalProtocolSite.
Re-ScreenedCount

Required. Can be either '*' or a valid number.

Number

ClinicalProtocolSite.Screen
FailuresCount

Required. Can be either '*' or a valid number.

Number

ClinicalProtocolSite.ScreenedCount

Required. Can be either '*' or a valid number.

Number

ClinicalProtocolSite.AccountId

Required. Can be either '*' or a valid Row ID.

Character data

ClinicalProtocolSite.Activate
SynchronizationFlag

Required. Can be either '*' or a valid Boolean value.

Boolean

ClinicalProtocolSite.PrimarySite
Address

Required. Can be either '*' or a valid address.

Character data

ClinicalProtocolSite.PrimarySite
AddressRowId

Required. Can be either '*' or a valid Address Row ID.

Character data

ClinicalProtocolSite.Site
AddressType

Required. Can be either '*' or a valid address type.

Character data

ClinicalProtocolSite.AmountCurrency
Code

Required. Can be either '*' or a valid currency code.

Character data

ClinicalProtocolSite.AmountEarnedToDate

Required. Can be either '*' or a valid number.

Number

ClinicalProtocolSite.AmountExchangeDate

Required. Can be either '*' or a valid date.

Date

ClinicalProtocolSite.AmountPaidTo
Date

Required. Can be either '*' or a valid date.

Number

ClinicalProtocolSite.CDMS
Site

Required. Can be either '*' or a valid study name associated. Used for SC-OC Integration.

Character data

ClinicalProtocolSite.CDMS
StudyId

Required. Can be either '*' or a valid study row ID.

Character data

ClinicalProtocolSite.City

Required. Can be either '*' or a valid city name.

Character data

ClinicalProtocolSite.Clinical
ProgramId

Required. Can be either '*' or a valid row ID.

Character data

ClinicalProtocolSite.Clinical
ProgramName

Required. Can be either '*' or a valid program name.

Character data

ClinicalProtocolSite.Country

Required. Can be either '*' or a valid country name.

Character data

ClinicalProtocolSite.
Description

Required. Can be either '*' or a valid description.

Character data

ClinicalProtocolSite.Email

Required. Can be either '*' or a valid email address.

Character data

ClinicalProtocolSite.
FaxNumber

Required. Can be either '*' or a valid fax number.

Number

ClinicalProtocolSite.FirstSubjectEnrolledDate

Required. Can be either '*' or a valid date.

Date

ClinicalProtocolSite.SiteRowId

Required. Can be either '*' or a valid row ID.

Character data

ClinicalProtocolSite.
InitiationCompletedDate

Required. Can be either '*' or a valid date.

Date

ClinicalProtocolSite.Primary
InvestigatorFirstName

Required. Can be either '*' or a valid first name.

Character data

ClinicalProtocolSite.Primary
InvestigatorLastName

Required. Can be either '*' or a valid last name.

Character data

ClinicalProtocolSite.Last
CompletedDateFlag

Required. Can be either '*' or a valid Boolean value.

Boolean

ClinicalProtocolSite.Last
SubjectOffStudyDate

Required. Can be either '*' or a valid date.

Date

ClinicalProtocolSite.LocaleId

Required. Can be either '*' or a valid row ID.

Character data

ClinicalProtocolSite.Locale
Name

Required. Can be either '*' or a valid locale.

Character data

ClinicalProtocolSite.Max
EnrollmentNumber

Required. Can be either '*' or a valid number.

Number

ClinicalProtocolSite.No
SubjectInfoFlag

Required. Can be either '*' or a valid Boolean value.

Boolean

ClinicalProtocolSite.Phone
Number

Required. Can be either '*' or a valid phone number.

Character data

ClinicalProtocolSite.PrevCDMSSite

Required. Can be either '*' or a valid PrevCDMSSite value. This is used for SC-OC integration.

Character data

ClinicalProtocolSite.PrimaryAddressId

Required. Can be either '*' or a valid row ID.

Character data

ClinicalProtocolSite.Primary
InvestigatorId

Required. Can be either '*' or a valid row ID.

Character data

ClinicalProtocolSite.PrimaryPositionId

Required. Can be either '*' or a valid position Row Id.

Character data

ClinicalProtocolSite.PrimarySubjectTemplateId

Required. Can be either '*' or a valid Subject template row ID.

Character data

ClinicalProtocolSite.ProtocolId

Required. Can be either '*' or a valid protocol row ID.

Character data

ClinicalProtocolSite.ProtocolNumber

Required. Can be either '*' or a valid protocol number.

Character data

ClinicalProtocolSite.ProtocolNumber
SitesPlanned

Required. Can be either '*' or a valid number.

Number

ClinicalProtocolSite.ProtocolNumber
SubjectsPlanned

Required. Can be either '*' or a valid number.

Number

ClinicalProtocolSite.ProtocolProduct
Name

Required. Can be either '*' or a valid number.

Character data

ClinicalProtocolSite.ProtocolProgram
Indication

Required. Can be either '*' or a valid program indication.

Character data

ClinicalProtocolSite.ProtocolSiteId

Required. Can be either '*' or a valid protocol site row ID.

Character data

ClinicalProtocolSite.ProtocolStatus

Required. Can be either '*' or a valid protocol status.

Character data

ClinicalProtocolSite.ProtocolTitle

Required. Can be either '*' or a valid protocol title.

Character data

ClinicalProtocolSite.Region

Required. Can be either '*' or a valid region.

Character data

ClinicalProtocolSite.Region
PlannedSites

Required. Can be either '*' or a valid number of planned sites for the region.

Character data

ClinicalProtocolSite.Region
PlannedSubjects

Required. Can be either '*' or a valid number of planned subjects for the region.

Character data

ClinicalProtocolSite.Region
Id

Required. Can be either '*' or a valid region ID.

Character data

ClinicalProtocolSite.Region
NoSiteInfoFlag

Required. Can be either '*' or a valid Region No Site Info flag.

Boolean

ClinicalProtocolSite.Region
Status

Required. Can be either '*' or a valid region status.

Character data

ClinicalProtocolSite.RegionsRequiredFlag

Required. Can be either '*' or a valid Regions Required flag.

Boolean

ClinicalProtocolSite.SiteBill
ToAddressId

Required. Can be either '*' or a valid Site Bill To Address ID.

Character data

ClinicalProtocolSite.SiteBill
ToContactId

Required. Can be either '*' or a valid Site Bill To Contact ID.

Character data

ClinicalProtocolSite.Site
AccountRowId

Required. Can be either '*' or a valid Site ID.

Character data

ClinicalProtocolSite.Site
AccountName

Required. Can be either '*' or a valid Site name.

Character data

ClinicalProtocolSite.SiteNumber

Required. Can be either '*' or a valid site number.

Character data

ClinicalProtocolSite.State

Required. Can be either '*' or a valid state.

Character data

ClinicalProtocolSite.Status

Required. Can be either '*' or a valid status.

Character data

ClinicalProtocolSite.StreetAddress

Required. Can be either '*' or a valid street address.

Character data

ClinicalProtocolSite.TerminatedDate

Required. Can be either '*' or a valid terminated date.

Date

ClinicalProtocolSite.TimeZone

Required. Can be either '*' or a valid time zone.

Character data

ClinicalProtocolSite.TimeZoneId

Required. Can be either '*' or a valid time zone ID.

Character data

ClinicalProtocolSite.TotalContract
Amount

Required. Can be either '*' or a valid total contract amount.

Number

ClinicalProtocolSite.TotalVATAmount

Required. Can be either '*' or a valid VAT amount.

Number

ClinicalProtocolSite.Withholding
Amount

Required. Can be either '*' or a valid withholding amount.

Number

ClinicalProtocolSite.Withholding
Percentage

Required. Can be either '*' or a valid withholding percentage.

Number

ClinicalProtocolSite.Zip

Required. Can be either '*' or a valid ZIP code.

Character data

ClinicalProtocolSite.Searchspec

Required. Can be either '*' or a valid search specification.

Character data

ClinicalProtocolSite_Position.Division

Required. Can be either '*' or a valid division.

Character data

ClinicalProtocolSite_Position.DivisionBU

Required. Can be either '*' or a valid division business unit.

Character data

ClinicalProtocolSite_Position.DivisionLocation

Required. Can be either '*' or a valid division location.

Character data

ClinicalProtocolSite_Position.IsPrimaryMVG

Required. Can be either '*' or a valid Boolean value.

Boolean

ClinicalProtocolSite_Position.Name2

Required. Can be either '*' or a valid name.

Character data

ClinicalProtocolSite_Position.RowStatus

Required. Can be either '*' or a valid row status.

Character data

ClinicalProtocolSite_Position.SalesRep

Required. Can be either '*' or a valid sales representative.

Character data

ClinicalProtocolSite_Position.Searchspec

Required. Can be either '*' or a valid search specification.

Character data

ClinicalProtocolSite_SubjectTemplate.IRBApprovalDate

Required. Can be either '*' or a valid IRB approval date.

Date

ClinicalProtocolSite_SubjectTemplate.IsPrimaryMVG

Required. Can be either '*' or a valid Boolean value.

Boolean

ClinicalProtocolSite_SubjectTemplate.Version

Required. Can be either '*' or a valid version.

Character data

ClinicalProtocolSite_SubjectTemplate.Searchspec

Required. Can be either '*' or a valid search specification.

Character data

Response Message Description: All LS Clinical Protocol Site Interface Service

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

Table 345. Response Message Description: All LS Clinical Protocol Site Interface Service
Name
Description
Type

ClinicalProtocolSite.
CompletedCount

Count of the subjects for which the status tracking visit is completed.

Number

ClinicalProtocolSite.Early
TerminatedCount

Count of the subjects that are early terminated.

Number

ClinicalProtocolSite.
EnrolledCount

Count of the subjects that are successfully enrolled.

Number

ClinicalProtocolSite.
PlannedSubjects

Number of planned subjects for the site.

Number

ClinicalProtocolSite.
Re-ScreenedCount

Count of the subjects that are rescreened.

Number

ClinicalProtocolSite.ScreenFailuresCount

Count of the subjects that are screen failed.

Number

ClinicalProtocolSite.ScreenedCount

Count of the subjects that are screened successfully failed.

Number

ClinicalProtocolSite.
AccountId

Account row ID.

Character data

ClinicalProtocolSite.
ActivateSynchronization
Flag

A Boolean flag which indicates if the sites are activated for synchronization. This is used for SC-OC Integration.

Boolean

ClinicalProtocolSite.PrimarySite
Address

Primary site address associated for the site. This is used for SC-OC Integration.

Character data

ClinicalProtocolSite.PrimarySite
AddressRowId

Primary site address row ID associated for the site. This is used for SC-OC Integration.

Character data

ClinicalProtocolSite.SiteAddressType

Site address type.

Character data

ClinicalProtocolSite.AmountCurrency
Code

Currency code of the site.

Character data

ClinicalProtocolSite.AmountEarnedToDate

Amount Earned by the primary investigator.

Number

ClinicalProtocolSite.AmountExchangeDate

Exchange date for the amount at the site.

Date

ClinicalProtocolSite.AmountPaidTo
Date

Amount paid by the primary investigator.

Number

ClinicalProtocolSite.CDMSSite

The integration name used for the protocol or study. This is used for SC-OC Integration.

Character data

ClinicalProtocolSite.CDMSStudyId

The row ID of the study or protocol. This is used for SC-OC Integration.

Character data

ClinicalProtocolSite.City

City.

Character data

ClinicalProtocolSite.ClinicalProgramId

Program row ID.

Character data

ClinicalProtocolSite.ClinicalProgram
Name

Program name.

Character data

ClinicalProtocolSite.
Country

Country.

Character data

ClinicalProtocolSite.
Description

Description.

Character data

ClinicalProtocolSite.Email

Email address.

Character data

ClinicalProtocolSite.Fax
Number

Fax number.

Number

ClinicalProtocolSite.First
SubjectEnrolledDate

Date when the subject was first enrolled.

Date

ClinicalProtocolSite.Site
RowId

Site row ID.

Character data

ClinicalProtocolSite.
InitiationCompletedDate

Date when the subject was first enrolled.

Date

ClinicalProtocolSite.Primary
InvestigatorFirstName

Principal investigator first name.

Character data

ClinicalProtocolSite.Primary
InvestigatorLastName

Principal investigator last name.

Character data

ClinicalProtocolSite.Last
CompletedDateFlag

Boolean flag value indicates if the reschedule should happen on the last completed date.

Boolean

ClinicalProtocolSite.LastSubjectOff
StudyDate

Date when the last subject was terminated.

Date

ClinicalProtocolSite.Locale
Id

Locale row ID.

Character data

ClinicalProtocolSite.LocaleName

Locale name.

Character data

ClinicalProtocolSite.MaxEnrollment
Number

Maximum enrolled subjects.

Number

ClinicalProtocolSite.NoSubjectInfo
Flag

Boolean flag indicating if the sites has no subjects.

Boolean

ClinicalProtocolSite.PhoneNumber

Phone number.

Character data

ClinicalProtocolSite.PrevCDMSSite

Previous CDMSSite. Used for SC-OC Integration.

Character data

ClinicalProtocolSite.PrimaryAddressId

Primary address row ID.

Character data

ClinicalProtocolSite.PrimaryInvestigatorId

Primary investigator row ID.

Character data

ClinicalProtocolSite.PrimaryPositionId

Primary position row ID.

Character data

ClinicalProtocolSite.PrimarySubject
TemplateId

Primary subject template row ID.

Character data

ClinicalProtocolSite.ProtocolId

Protocol row ID.

Character data

ClinicalProtocolSite.ProtocolNumber

Protocol number.

Character data

ClinicalProtocolSite.ProtocolNumber
SitesPlanned

Number of sites planned for the protocol.

Number

ClinicalProtocolSite.ProtocolNumber
SubjectsPlanned

Number of subjects planned for the protocol.

Number

ClinicalProtocolSite.ProtocolProduct
Name

Product name associated to the protocol.

Character data

ClinicalProtocolSite.ProtocolProgram
Indication

Program indication associated to the protocol.

Character data

ClinicalProtocolSite.ProtocolSiteId

Protocol site row ID.

Character data

ClinicalProtocolSite.ProtocolStatus

Protocol status.

Character data

ClinicalProtocolSite.ProtocolTitle

Protocol title.

Character data

ClinicalProtocolSite.Region

Region name.

Character data

ClinicalProtocolSite.RegionPlanned
Sites

Planned number of sites for the region.

Character data

ClinicalProtocolSite.RegionPlanned
Subjects

Planned number of subjects for the region.

Character data

ClinicalProtocolSite.Region
Id

Region row ID.

Character data

ClinicalProtocolSite.RegionNoSiteInfoFlag

Boolean flag. It indicates whether the region has no sites.

Boolean

ClinicalProtocolSite.RegionStatus

Region status.

Character data

ClinicalProtocolSite.RegionsRequired
Flag

Boolean flag, indicates if the regions are mandatory for the protocol

Boolean

ClinicalProtocolSite.SiteBillToAddress
Id

Site billed to assigned address row ID.

Character data

ClinicalProtocolSite.SiteBillToContact
Id

Site billed to assigned contact ID.

Character data

ClinicalProtocolSite.SiteAccountRowId

Account row ID assigned to the site.

Character data

ClinicalProtocolSite.SiteAccountName

Account Name.

Character data

ClinicalProtocolSite.SiteNumber

Site Number.

Character data

ClinicalProtocolSite.State

State.

Character data

ClinicalProtocolSite.Status

Status.

Character data

ClinicalProtocolSite.StreetAddress

Street address.

Character data

ClinicalProtocolSite.TerminatedDate

Terminated date.

Date

ClinicalProtocolSite.TimeZone

Time zone in which the site is operating.

Character data

ClinicalProtocolSite.TimeZoneId

Time zone row ID.

Character data

ClinicalProtocolSite.TotalContract
Amount

Total contract amount rolled up for the site.

Number

ClinicalProtocolSite.TotalVATAmount

Total VAT amount rolled up to the site.

Number

ClinicalProtocolSite.Withholding
Amount

Site withholding amount.

Number

ClinicalProtocolSite.Withholding
Percentage

Site withholding amount percentage.

Number

ClinicalProtocolSite.Zip

ZIP code.

Character data

ClinicalProtocolSite.Searchspec

Search specification.

Character data

ClinicalProtocolSite_
Position.Division

Division.

Character data

ClinicalProtocolSite_
Position.DivisionBU

Division business unit.

Character data

ClinicalProtocolSite_
Position.DivisionLocation

Division location.

Character data

ClinicalProtocolSite_
Position.IsPrimaryMVG

Boolean flag indicating if the position is primary at the site.

Boolean

ClinicalProtocolSite_
Position.Name2

Name.

Character data

ClinicalProtocolSite_
Position.RowStatus

Position status.

Character data

ClinicalProtocolSite_
Position.SalesRep

Sales representative.

Character data

ClinicalProtocolSite_
Position.Searchspec

Search specification.

Character data

ClinicalProtocolSite_
SubjectTemplate.IRB
ApprovalDate

IRB approval date for the associated SVT.

Date

ClinicalProtocolSite_
SubjectTemplate.IsPrimaryMVG

Boolean flag indicating if the subject template is primary at the site.

Boolean

ClinicalProtocolSite_
SubjectTemplate.Version

Subject template version.

Character data

ClinicalProtocolSite_
SubjectTemplate.
Searchspec

Subject template search specification.

Character data

LS Clinical Protocol Site Interface Service 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 366

Table 346. LS Clinical Protocol Site Interface Service Service Object
Name
Boundary Object Type
Class

LS Clinical Protocol Site Interface Service

LS Clinical Protocol Site Interface Service

CSSEAIDataSyncService

.

Data Object (Integration Object)

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

Table 347. LS Clinical Protocol Site Interface Service Data Object
Siebel Repository Name
External Name

LS Clinical Protocol Site Information IO

Clinical Protocol Site

Methods

For a description of the methods for this Web service, see Table 340.

Table 348. LS Clinical Protocol Site Interface Service Methods
Operation
Method

LSClinicalProtocolSiteInterfaceServiceQueryByExample

QueryByExample

LSClinicalProtocolSiteInterfaceServiceQueryById

QueryById

LSClinicalProtocolSiteInterfaceServiceQueryPage

QueryPage

Example Package for LS Clinical Protocol Site Interface Service

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:

...\LSClinical_ProtocolSite\LS_Clinical_Protocol_Site_Interface_Service-QueryByExample-request.xml

...\LSClinical_ProtocolSite\LS_Clinical_Protocol_Site_Interface_Service-QueryById-request.xml

...\LSClinical_ProtocolSite\LS_Clinical_Protocol_Site_Interface_Service-QueryPage-request.xml

Response

See the following file to view the sample code:

...\LSClinical_ProtocolSite\LS_Clinical_Protocol_Site_Interface_Service-response.xml

Interface Description (WSDL) for LS Clinical Protocol Site Interface Service

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.

...\LS Clinical_ProtocolSite\LS_Clinical_Protocol_Site_Interface_Service-QueryByExample.WSDL

...\LS Clinical_ProtocolSite\LS_Clinical_Protocol_Site_Interface_Service-QueryById.WSDL

...\LS Clinical_ProtocolSite\LS_Clinical_Protocol_Site_Interface_Service-QueryPage.WSDL

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