Returns the study metadata. The roles associated with the user running this webservice will determine wether the study metadata is displayed.

Usage

Returns the study metadata for the requested study in OpenClinica.  It will contain information like the Study Name, Unique Protocol ID, and Study OID.

SOAP XML Request and Response Template

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://openclinica.org/ws/study/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:getMetadataRequest>
<v1:studyMetadata>
<bean:studyRef>
<bean:identifier>identifier</bean:identifier>
</bean:studyRef>
</v1:studyMetadata>
</v1:getMetadataRequest>
</soapenv:Body>
</soapenv:Envelope>



<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<createResponse xmlns="http://openclinica.org/ws/study/v1">
<result>Success</result>
<odm><![CDATA[<Study OID="S_DEFAULTS1">
<GlobalVariables>
<StudyName>Default Study</StudyName>
<StudyDescription>

</StudyDescription>
<ProtocolName>default-study</ProtocolName>
</GlobalVariables>
<MetaDataVersion>
<Protocol>
</Protocol>
</MetaDataVersion>
</Study>]]></odm>
</createResponse>
</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>