Lists studySubjects in a study regardless of its state (i.e It also includes a removed studySubject in a study).

Usage

Lists study subjects that are a part of an OpenClinica study or site.

SOAP XML Request and Response Template

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://openclinica.org/ws/studySubject/v1" xmlns:bean="http://openclinica.org/ws/beans">
${insert header}
<soapenv:Body>
<v1:listAllByStudyRequest>
<bean:studyRef>
<bean:identifier>?</bean:identifier>
<!--Optional:
<bean:siteRef>
<bean:identifier>?</bean:identifier>
</bean:siteRef>--!>
</bean:studyRef>
</v1:listAllByStudyRequest>
</soapenv:Body>
</soapenv:Envelope>


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns4:listAllByStudyResponse xmlns:ns4="http://openclinica.org/ws/studySubject/v1" xmlns:ns2="http://openclinica.org/ws/beans" xmlns:ns3="http://openclinica.org/ws/crf/v1">
<ns4:result>Success</ns4:result>
<ns4:studySubjects>
<ns2:studySubject>
<ns2:label>label</ns2:label>
<ns2:secondaryLabel/>
<ns2:enrollmentDate>2010-03-31</ns2:enrollmentDate>
<ns2:subject>
<ns2:uniqueIdentifier/>
<ns2:gender>m</ns2:gender>
</ns2:subject>
<ns2:events>
<ns2:event>
<ns2:location>Boston</ns2:location>
<ns2:startDate>2010-03-31</ns2:startDate>
<ns2:startTime>00:00:00</ns2:startTime>
</ns2:event>
</ns2:events>
</ns2:studySubject>
</ns4:studySubjects>
</ns4:listAllByStudyResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameters

Request Parameters

 
ParameterUIDomainDBValidationsDatatypesExamplesRequired
studyRef:identifierUnique Protocol IDStudyBean:identifierstudy:unique_identifierN/AString<identifier>study identifier</identifier>Y
siteRef:identifierUnique Protocol IDStudyBean:identifierstudy:unique_identifierN/AString<identifier>site identifier</identifier>N

Response Parameters

 
ParameterUIDomainDBResult on successResult on fail
resultn/an/an/a<result>Success</result><result>Fail</result>
warningn/an/an/a<warning>A warning message</warning>n/a
errorn/an/an/an/a<error>An error message indicating reason of failure</error>
studySubject:labelStudySubject IDStudySubjectBean:labelstudy_subject:label<label>label</label>n/a
studySubject:secondaryLabelSecondary IDStudySubjectBean:secondaryLabelstudy_subject:secondary_label<secondaryLabel/> or <secondaryLabel>label</secondaryLabel>n/a
subject:uniqueIdentifierPerson IDSubjectBean:uniqueIdentifiersubject:unique_identifier<uniqueIdentifier/> or <uniqueIdentifier>uId</uniqueIdentifier>n/a
subject:genderSexSubjectBean:gendersubject:gender<gender>m</gender> or <gender>f</gender>n/a
subject:dateOfBirthDate of BirthSubjectBean:dateOfBirthsubject:date_of_birth<dateOfBirth>2008-12-12</dateOfBirth>n/a
subject:yearOfBirthDate of BirthSubjectBean:dateOfBirthsubject:date_of_birth<yearOfBirth>2008</yearOfBirth>n/a
event:locationLocationStudyEvent:locationstudy_event:location<location>Boston</location>n/a
event:startDateStart Date/TimeStudyEvent:dateStartedstudy_event:date_start<startDate>2010-08-16</startDate>n/a
event:startTimeStart Date/TimeStudyEvent:dateStartedstudy_event:date_start<startTime>12:00:00</startTime>n/a
event:endDateEnd Date/TimeStudyEvent:dateEndedstudy_event:date_end<endDate>2010-08-16</endDate>n/a
event:endTimeEnd Date/TimeStudyEvent:dateEndedstudy_event:date_ended<endTime>15:00:00</endTime>n/a