This service provides API methods for manipulating CRF item data in OpenClinica. The WSDL file associated with this service could be found here: http://host:8080/OpenClinica/ws/data/v1/dataWsdl.wsdl .

2.4.1 Import

Usage

This web service inserts CRF item data. The data supplied to the method should be in CDISC ODM XML format.

Starting with OpenClinica release 3.6, the UpsertOn tag and OpenClinica:Status clause are available. Details are provided in CDISC ODM XML format

Starting with OpenClinica release 3.1.3 if you have Rules attached to your CRF, you can run them when uploading data from web services by turning on ImportDataEntry flag in rules definition. For example, in order to enable a discrepancy note rule action executed on import the rule should have ImportDataEntry flag set to true:

<?xml version=”1.0″ encoding=”UTF-8″?>

<RuleImport>

    <RuleAssignment>

        <Target>I_RULES_WEIGHT</Target>

        <RuleRef OID=”RU2″>

            <DiscrepancyNoteAction IfExpressionEvaluates=”false”>

                <Run AdministrativeDataEntry=”true”

                    InitialDataEntry=”true” DoubleDataEntry=”true”

                    ImportDataEntry=”true” Batch=”false”/>

                <Message>This is a discrepancy note test</Message>

            </DiscrepancyNoteAction>

        </RuleRef>

    </RuleAssignment>

    <RuleDef OID=”RU2″ Name=”Blank exam date”>

        <Description>CRF can not be blank.</Description>

        <Expression>I_RULES_HEIGHT eq “100”</Expression>

    </RuleDef>

</RuleImport>

 

SOAP XML Request and Response Template

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://openclinica.org/ws/data/v1" xmlns:OpenClinica="http://www.openclinica.org/ns/odm_ext_v130/v3.1">
<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:importRequest>
<odm><![CDATA[
<ODM ....
.....
 </ODM>]]>
</odm>
</v1:importRequest> 
</soapenv:Body>
</soapenv:Envelope>
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
 .....
</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>