listAll (Lists study event definitions in study)

2.6.1 listAll (Lists study event definitions in study)

Returns a list of study event definitions.

Usage

Returns a list of study event definitions and their properties for a single study in OpenClinica.

SOAP XML based Request and Response Template

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://openclinica.org/ws/studyEventDefinition/v1" xmlns:bean="http://openclinica.org/ws/beans">
 <soapenv:Header>
 <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
 <wsse:UsernameToken wsu:Id="UsernameToken-27777511" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
 <wsse:Username>user</wsse:Username>
 <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
 </wsse:UsernameToken>
 </wsse:Security>
</soapenv:Header>
 <soapenv:Body>
 <v1:listAllRequest>
 <v1:studyEventDefinitionListAll>
 <bean:studyRef>
 <bean:identifier>PG33xyz</bean:identifier>
 </bean:studyRef>
 </v1:studyEventDefinitionListAll>
 </v1:listAllRequest>
 </soapenv:Body>
</soapenv:Envelope>


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
 <SOAP-ENV:Header/>
 <SOAP-ENV:Body>
 <listAllResponse xmlns="http://openclinica.org/ws/studyEventDefinition/v1">
 <result>Success</result>
 <studyEventDefinitions>
 <studyEventDefinition>
 <oid>SE_INITIALV</oid>
 <name>Initial Visit</name>
 <eventDefinitionCrfs>
 <eventDefinitionCrf>
 <required>true</required>
 <doubleDataEntry>false</doubleDataEntry>
 <passwordRequired>false</passwordRequired>
 <hideCrf>false</hideCrf>
 <sourceDataVerificaiton>100% Required</sourceDataVerificaiton>
 <crf>
 <oid>F_DEMO</oid>
 <name>Demographics-Dynamics</name>
 </crf>
 <defaultCrfVersion>
 <oid>F_DEMO_1</oid>
 <name>1</name>
 </defaultCrfVersion>
 </eventDefinitionCrf>
 <eventDefinitionCrf>
 <required>true</required>
 <doubleDataEntry>false</doubleDataEntry>
 <passwordRequired>false</passwordRequired>
 <hideCrf>false</hideCrf>
 <sourceDataVerificaiton>Not Required</sourceDataVerificaiton>
 <crf>
 <oid>F_GROU</oid>
 <name>Groups_Adverse_Events</name>
 </crf>
 <defaultCrfVersion>
 <oid>F_GROU_NONC</oid>
 <name>Non-Cascade</name>
 </defaultCrfVersion>
 </eventDefinitionCrf>
 </eventDefinitionCrfs>
 </studyEventDefinition>
 </studyEventDefinitions>
 </listAllResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameters

Request Parameters

Parameter	UI	Domain	DB	Validations	Datatypes	Examples	Required
studyRef:identifier	Unique Protocol ID	StudyBean:identifier	study:unique_identifier	N/A	String	<identifier>study identifier</identifier>	Y
siteRef:identifier	Unique Protocol ID	StudyBean:identifier	study:unique_identifier	N/A	String	<identifier>site identifier</identifier>	N

Response Parameters

Parameter	UI	Domain	DB	Result on success	Result on fail
result	n/a	n/a	n/a	<result>Success</result>	<result>Fail</result>
warning	n/a	n/a	n/a	<warning>A warning message</warning>	n/a
error	n/a	n/a	n/a	n/a	<error>An error message indicating reason of failure</error>
studyEventDefinition:oid	OID	StudyEventDefinitionBean:oid	study_event_definition:oc_oid	<oid>SE_INITIALV</oid>	n/a
studyEventDefinition:name	Name	StudyEventDefinitionBean:name	study_event_definition:name	<name>S_STUDY</name>	n/a
eventDefinitionCrf:required	Required	EventDefinitionCRFBean:requiredCRF	event_definition_crf:required_crf	<required>true</required>	n/a
eventDefinitionCrf:doubleDataEntry	Double Data Entry	EventDefinitionCRFBean:doubleEntry	event_definition_crf:double_entry	<doubleDataEntry>false</doubleDataEntry>	n/a
eventDefinitionCrf:passwordRequired	Password Required	EventDefinitionCRFBean:electronicSignature	event_definition_crf:electronic_signature	<passwordRequired>false</passwordRequired>	n/a
eventDefinitionCrf:hideCrf	Hide CRF	EventDefinitionCRFBean:hideCrf	event_definition_crf:hide_crf	<hideCrf>false</hideCrf>	n/a
eventDefinitionCrf:sourceDataVerificaiton	Source Data Verification	EventDefinitionCRFBean:sourceDataVerification	event_definition_crf:source_data_verification_code	<sourceDataVerificaiton>100% Required</sourceDataVerificaiton>	n/a
crf:oid	OID	CRFBean:name	crf:name	<name>Demographics-Dynamics</name>	n/a
crf:name	Name	CRFBean:oid	crf:oc_oid	<oid>F_DEMO</oid>	n/a
defaultCrfVersion:oid	n/a	CRFVersionBean:oid	crf_version:oc_oid	<oid>F_DEMO</oid>	n/a
defaultCrfVersion:name	Default Version	CRFVersionBean:name	crf_version:name	<name>1</name>	n/a

Export PDF