Returns a list of studies/sites. The roles associated with the user running this webservice will determine which studies/sites are listed.

Usage

Returns a list of all the studies and sites that are part of your OpenClinica instance and accessible by the web services user. The system will not list studies and sites the user does not have access to.

SOAP XML Request and Response Template

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://openclinica.org/ws/study/v1">
<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/>
</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/study/v1">
<result>Success</result>
<studies>
<study>
<identifier>default-study</identifier>
<oid>S_DEFAULTS1</oid>
<name>Default Study</name>
</study>
<study>
<identifier>Study A</identifier>
<oid>S_STUDYA</oid>
<name>A new study</name>
<sites>
<site>
<identifier>Site A</identifier>
<oid>S_SITEA</oid>
<name>1 Site</name>
</site>
</sites>
</study>
</studies>
</listAllResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parameters

Request Parameters

Not Available

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>
study:identifier Unique Protocol ID StudyBean:identifier study:unique_identifier<identifier>default-study</identifier>n/a
study:oidOIDStudyBean:oidstudy:oc_oid<oid>S_STUDY</oid>n/a
study:nameNameStudyBean:namestudy:name<name>Default Study</name>n/a
site:identifierUnique Protocol IDStudyBean:identifierstudy:unique_identifier<identifier>default-site</identifier>n/a
site:oidOIDStudyBean:namestudy:oc_oid<oid>S_SITE</oid>n/a
site:nameNameStudyBean:oidstudy:name<name>Default Site</name>n/a