You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openmeetings.apache.org by so...@apache.org on 2015/02/24 07:35:33 UTC
svn commit: r1661849 - in /openmeetings/branches/3.0.x/docs:
CalendarService.html RoomService.html
Author: solomax
Date: Tue Feb 24 06:35:33 2015
New Revision: 1661849
URL: http://svn.apache.org/r1661849
Log:
Web services docs are updated
Modified:
openmeetings/branches/3.0.x/docs/CalendarService.html
openmeetings/branches/3.0.x/docs/RoomService.html
Modified: openmeetings/branches/3.0.x/docs/CalendarService.html
URL: http://svn.apache.org/viewvc/openmeetings/branches/3.0.x/docs/CalendarService.html?rev=1661849&r1=1661848&r2=1661849&view=diff
==============================================================================
--- openmeetings/branches/3.0.x/docs/CalendarService.html (original)
+++ openmeetings/branches/3.0.x/docs/CalendarService.html Tue Feb 24 06:35:33 2015
@@ -67,7 +67,7 @@
<div class="navigation_comment"><i >Get the next Calendar event for userId</i></div>
</div>
<div>
- <a href="#searchAppointmentByName"><b>searchAppointmentByName</b></a><br/>
+ <a href="#searchAppointmentByTitle"><b>searchAppointmentByTitle</b></a><br/>
<div class="navigation_comment"><i >Search a calendar event for the current SID</i></div>
</div>
<div>
@@ -117,16 +117,16 @@
Method: <i>getAppointmentByRange (
String SID
,
- Date starttime
+ Calendar starttime
,
- Date endtime
+ Calendar endtime
)
</i><br/>
<p>
Load appointments by a start / end range for the current SID
</p>
<p>
- Return Type: java.util.List<org.apache.openmeetings.db.entity.calendar.Appointment>
+ Return Type: java.util.List<org.apache.openmeetings.db.dto.calendar.AppointmentDTO>
</p>
<p>Params:</p>
@@ -149,7 +149,7 @@
<tr>
<td valign="top">
- Date
+ Calendar
</td>
<td valign="top">starttime</td>
<td valign="top">start time, yyyy-mm-dd</td>
@@ -157,7 +157,7 @@
<tr>
<td valign="top">
- Date
+ Calendar
</td>
<td valign="top">endtime</td>
<td valign="top">end time, yyyy-mm-dd</td>
@@ -181,16 +181,16 @@
,
long userId
,
- Date starttime
+ Calendar starttime
,
- Date endtime
+ Calendar endtime
)
</i><br/>
<p>
Load appointments by a start / end range for the userId
</p>
<p>
- Return Type: java.util.List<org.apache.openmeetings.db.entity.calendar.Appointment>
+ Return Type: java.util.List<org.apache.openmeetings.db.dto.calendar.AppointmentDTO>
</p>
<p>Params:</p>
@@ -221,7 +221,7 @@
<tr>
<td valign="top">
- Date
+ Calendar
</td>
<td valign="top">starttime</td>
<td valign="top">start time, yyyy-mm-dd</td>
@@ -229,7 +229,7 @@
<tr>
<td valign="top">
- Date
+ Calendar
</td>
<td valign="top">endtime</td>
<td valign="top">end time, yyyy-mm-dd</td>
@@ -256,7 +256,7 @@
Get the next Calendar event for the current user of the SID
</p>
<p>
- Return Type: org.apache.openmeetings.db.entity.calendar.Appointment
+ Return Type: org.apache.openmeetings.db.dto.calendar.AppointmentDTO
</p>
<p>Params:</p>
@@ -300,7 +300,7 @@
Get the next Calendar event for userId
</p>
<p>
- Return Type: org.apache.openmeetings.db.entity.calendar.Appointment
+ Return Type: org.apache.openmeetings.db.dto.calendar.AppointmentDTO
</p>
<p>Params:</p>
<b>Warning:</b><i> Params in this method do not seem to be correctly documentated</i>
@@ -332,11 +332,11 @@
<div class="method">
<div class="method_header">
<div style="margin-left:10px">
- <a name="searchAppointmentByName" ><b>searchAppointmentByName</b></a>
+ <a name="searchAppointmentByTitle" ><b>searchAppointmentByTitle</b></a>
</div>
</div>
- Method: <i>searchAppointmentByName (
+ Method: <i>searchAppointmentByTitle (
String SID
,
String appointmentName
@@ -346,7 +346,7 @@
Search a calendar event for the current SID
</p>
<p>
- Return Type: java.util.List<org.apache.openmeetings.db.entity.calendar.Appointment>
+ Return Type: java.util.List<org.apache.openmeetings.db.dto.calendar.AppointmentDTO>
</p>
<p>Params:</p>
@@ -379,7 +379,7 @@
</table>
<br/>
REST Sample Call/URL:<br/>
- <a href="http://localhost:5080/openmeetings/services/CalendarService/searchAppointmentByName?SID=VALUE&appointmentName=VALUE">http://localhost:5080/openmeetings/services/CalendarService/searchAppointmentByName?SID=VALUE&appointmentName=VALUE</a>
+ <a href="http://localhost:5080/openmeetings/services/CalendarService/searchAppointmentByTitle?SID=VALUE&appointmentName=VALUE">http://localhost:5080/openmeetings/services/CalendarService/searchAppointmentByTitle?SID=VALUE&appointmentName=VALUE</a>
</div>
<div class="method">
<div class="method_header">
@@ -986,7 +986,7 @@
Load a calendar event by its room id
</p>
<p>
- Return Type: org.apache.openmeetings.db.entity.calendar.Appointment
+ Return Type: org.apache.openmeetings.db.dto.calendar.AppointmentDTO
</p>
<p>Params:</p>
@@ -1078,7 +1078,7 @@
Get all reminder types for calendar events
</p>
<p>
- Return Type: java.util.List<org.apache.openmeetings.db.entity.calendar.AppointmentReminderTyps>
+ Return Type: java.util.List<org.apache.openmeetings.db.dto.calendar.AppointmentReminderTypeDTO>
</p>
<p>Params:</p>
Modified: openmeetings/branches/3.0.x/docs/RoomService.html
URL: http://svn.apache.org/viewvc/openmeetings/branches/3.0.x/docs/RoomService.html?rev=1661849&r1=1661848&r2=1661849&view=diff
==============================================================================
--- openmeetings/branches/3.0.x/docs/RoomService.html (original)
+++ openmeetings/branches/3.0.x/docs/RoomService.html Tue Feb 24 06:35:33 2015
@@ -2886,7 +2886,7 @@
,
Boolean waitForRecording
,
- Boolean allowRecording
+ boolean allowRecording
)
</i><br/>
<p>
@@ -3028,7 +3028,7 @@
<tr>
<td valign="top">
- Boolean
+ boolean
</td>
<td valign="top">allowRecording</td>
<td valign="top">if the recording option is available or not</td>
@@ -3076,7 +3076,7 @@
,
Boolean waitForRecording
,
- Boolean allowRecording
+ boolean allowRecording
,
Boolean hideTopBar
)
@@ -3221,7 +3221,7 @@
<tr>
<td valign="top">
- Boolean
+ boolean
</td>
<td valign="top">allowRecording</td>
<td valign="top">if the recording option is available or not</td>