2.3 Event Web Service

Schedule an event

Schedules a single study subject event (visit) in an OpenClinica Study.

NOTE: the scheduleEvent WSDL states that more than one event can be scheduled at a time, however the application will only schedule one event per request. See 13008 for further information.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:v1="http://openclinica.org/ws/event/v1" 
xmlns:bean="http://openclinica.org/ws/beans">
${insert header}
<soapenv:Body>
<v1:scheduleRequest>

<v1:event>
<bean:studySubjectRef>
<bean:label>?</bean:label>
</bean:studySubjectRef>
<bean:studyRef>
<bean:identifier>?</bean:identifier>
<!--Optional:-->
<bean:siteRef>
<bean:identifier>?</bean:identifier>
</bean:siteRef>
</bean:studyRef>
<bean:eventDefinitionOID>?</bean:eventDefinitionOID>
<bean:location>?</bean:location>
<bean:startDate>?</bean:startDate>
<!--Optional:-->
<bean:startTime>?</bean:startTime>
<!--Optional:-->
<bean:endDate>?</bean:endDate>
<!--Optional:-->
<bean:endTime>?</bean:endTime>
</v1:event>
</v1:scheduleRequest>
</soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
 <SOAP-ENV:Header/>
 <SOAP-ENV:Body>
 <scheduleResponse>
 <result>success</result>
 <eventDefinitionOID>SE_TEST</eventDefinitionOID>
 <studySubjectOID>SS_PERSON</studySubjectOID>
 <studyEventOrdinal>1</studyEventOrdinal>
 </scheduleResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Request Parameters

Response Parameters