OpenMeetings API Methods

Method: getAppointmentByRange ( String SID , Date starttime , Date endtime )

Load appointments by a start / end range for the current SID

Return Type: java.util.List

Params:

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as Loggedin
Date	starttime	start time, yyyy-mm-dd
Date	endtime	end time, yyyy-mm-dd

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/CalendarService/getAppointmentByRange?SID=VALUE&starttime=VALUE&endtime=VALUE

getAppointmentByRangeForUserId

Method: getAppointmentByRangeForUserId ( String SID , long userId , Date starttime , Date endtime )

Load appointments by a start / end range for the userId

Return Type: java.util.List

Params:

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as Loggedin
long	userId	the userId the calendar events should be loaded
Date	starttime	start time, yyyy-mm-dd
Date	endtime	end time, yyyy-mm-dd

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/CalendarService/getAppointmentByRangeForUserId?SID=VALUE&userId=VALUE&starttime=VALUE&endtime=VALUE

getNextAppointment

Method: getNextAppointment ( String SID )

Get the next Calendar event for the current user of the SID

Return Type: org.openmeetings.app.persistence.beans.calendar.Appointment

Params:

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as Loggedin

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/CalendarService/getNextAppointment?SID=VALUE

getNextAppointmentForUserId

Method: getNextAppointmentForUserId ( String SID , long userId )

Get the next Calendar event for userId

Return Type: org.openmeetings.app.persistence.beans.calendar.Appointment

Params:

Warning: Params in this method do not seem to be correctly documentated

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as Loggedin

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/CalendarService/getNextAppointmentForUserId?SID=VALUE&userId=VALUE

searchAppointmentByName

Method: searchAppointmentByName ( String SID , String appointmentName )

Search a calendar event for the current SID

Return Type: java.util.List

Params:

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as Loggedin
String	appointmentName	the search string

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/CalendarService/searchAppointmentByName?SID=VALUE&appointmentName=VALUE

saveAppointment

Method: saveAppointment ( String SID , String appointmentName , String appointmentLocation , String appointmentDescription , Calendar appointmentstart , Calendar appointmentend , Boolean isDaily , Boolean isWeekly , Boolean isMonthly , Boolean isYearly , Long categoryId , Long remind , String mmClient , Long roomType , String baseUrl , Long languageId , Boolean isPasswordProtected , String password )

Save an appointment

Return Type: java.lang.Long

Params:

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as Loggedin
String	appointmentName	name of the calendar event
String	appointmentLocation	location info text of the calendar event
String	appointmentDescription	description test of the calendar event
Calendar	appointmentstart	start as Date yyyy-mm-ddThh:mm:ss
Calendar	appointmentend	end as Date yyyy-mm-ddThh:mm:ss
Boolean	isDaily	if the calendar event should be repeated daily (not implemented)
Boolean	isWeekly	if the calendar event should be repeated weekly (not implemented)
Boolean	isMonthly	if the calendar event should be repeated monthly (not implemented)
Boolean	isYearly	if the calendar event should be repeated yearly (not implemented)
Long	categoryId	the category id of the calendar event
Long	remind	the reminder type of the calendar event
String	mmClient	List of clients, comma separated string, sample: 1,firstname,lastname,hans.tier@gmail.com,1,Etc/GMT+1 to add multiple clients you can use the same GET parameter in the URL multiple times, for example: &mmClient=1,firstname,lastname,hans .tier@gmail.com,1,Etc/GMT+1&mmClient =2,firstname,lastname,hans.tier@gmail.com,1,Etc/GMT+1
Long	roomType	the room type for the calendar event
String	baseUrl	the base URL for the invitations
Long	languageId	the language id of the calendar event, notification emails will be send in this language
Boolean	isPasswordProtected	if the room is password protected
String	password	the password for the room

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/CalendarService/saveAppointment?SID=VALUE&appointmentName=VALUE&appointmentLocation=VALUE&appointmentDescription=VALUE&appointmentstart=VALUE&appointmentend=VALUE&isDaily=VALUE&isWeekly=VALUE&isMonthly=VALUE&isYearly=VALUE&categoryId=VALUE&remind=VALUE&mmClient=VALUE&roomType=VALUE&baseUrl=VALUE&languageId=VALUE&isPasswordProtected=VALUE&password=VALUE

updateAppointmentTimeOnly

Method: updateAppointmentTimeOnly ( String SID , Long appointmentId , Date appointmentstart , Date appointmentend , String baseurl , Long languageId )

Update an calendar event time only

Return Type: java.lang.Long

Params:

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as Loggedin
Long	appointmentId	the calendar event that should be updated
Date	appointmentstart	start yyyy-mm-dd
Date	appointmentend	end yyyy-mm-dd
String	baseurl	the base URL for the invitations that will be send by email
Long	languageId	the language id

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/CalendarService/updateAppointmentTimeOnly?SID=VALUE&appointmentId=VALUE&appointmentstart=VALUE&appointmentend=VALUE&baseurl=VALUE&languageId=VALUE

updateAppointment

Method: updateAppointment ( String SID , Long appointmentId , String appointmentName , String appointmentLocation , String appointmentDescription , Calendar appointmentstart , Calendar appointmentend , Boolean isDaily , Boolean isWeekly , Boolean isMonthly , Boolean isYearly , Long categoryId , Long remind , String mmClient , Long roomType , String baseurl , Long languageId , Boolean isPasswordProtected , String password )

Save an appointment

Return Type: java.lang.Long

Params:

Type	Fieldname	Description
String	SID	The SID of the User. This SID must be marked as Loggedin
Long	appointmentId	the id to update
String	appointmentName	name of the calendar event
String	appointmentLocation	location info text of the calendar event
String	appointmentDescription	description test of the calendar event
Calendar	appointmentstart	start as Date yyyy-mm-ddThh:mm:ss
Calendar	appointmentend	end as Date yyyy-mm-ddThh:mm:ss
Boolean	isDaily	if the calendar event should be repeated daily (not implemented)
Boolean	isWeekly	if the calendar event should be repeated weekly (not implemented)
Boolean	isMonthly	if the calendar event should be repeated monthly (not implemented)
Boolean	isYearly	if the calendar event should be repeated yearly (not implemented)
Long	categoryId	the category id of the calendar event
Long	remind	the reminder type of the calendar event
String	mmClient	List of clients, comma separated string, sample: 1,firstname,lastname,hans.tier@gmail.com,1,Etc/GMT+1 to add multiple clients you can use the same GET parameter in the URL multiple times, for example: &mmClient=1,firstname,lastname,hans .tier@gmail.com,1,Etc/GMT+1&mmClient =2,firstname,lastname,hans.tier@gmail.com,1,Etc/GMT+1
Long	roomType	the room type for the calendar event
String	baseUrl	the base URL for the invitations
Long	languageId	the language id of the calendar event, notification emails will be send in this language
Boolean	isPasswordProtected	if the room is password protected
String	password	the password for the room

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/CalendarService/updateAppointment?SID=VALUE&appointmentId=VALUE&appointmentName=VALUE&appointmentLocation=VALUE&appointmentDescription=VALUE&appointmentstart=VALUE&appointmentend=VALUE&isDaily=VALUE&isWeekly=VALUE&isMonthly=VALUE&isYearly=VALUE&categoryId=VALUE&remind=VALUE&mmClient=VALUE&roomType=VALUE&baseurl=VALUE&languageId=VALUE&isPasswordProtected=VALUE&password=VALUE

deleteAppointment

Method: deleteAppointment ( String SID , Long appointmentId , Long language_id )

delete a calendar event If the given SID is from an Administrator or Web-Service user, the user can delete any appointment.
If the SID is assigned to a simple user, he can only delete appointments where he is also the owner/creator of the appointment

Return Type: java.lang.Long

Params:

Type	Fieldname	Description
String	SID	an authenticated SID
Long	appointmentId	the id to delete
Long	language_id	the language id in which the notifications for the deleted appointment are send

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/CalendarService/deleteAppointment?SID=VALUE&appointmentId=VALUE&language_id=VALUE

getAppointmentByRoomId

Method: getAppointmentByRoomId ( String SID , Long room_id )

Load a calendar event by its room id

Return Type: org.openmeetings.app.persistence.beans.calendar.Appointment

Params:

Type	Fieldname	Description
String	SID
Long	room_id

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/CalendarService/getAppointmentByRoomId?SID=VALUE&room_id=VALUE

getAppointmentCategoryList

Method: getAppointmentCategoryList ( String SID )

Get all categories of calendar events

Return Type: java.util.List

Params:

Type	Fieldname	Description
String	SID

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/CalendarService/getAppointmentCategoryList?SID=VALUE

getAppointmentReminderTypList

Method: getAppointmentReminderTypList ( String SID )

Get all reminder types for calendar events

Return Type: java.util.List

Params:

Type	Fieldname	Description
String	SID

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/CalendarService/getAppointmentReminderTypList?SID=VALUE

getAppointmentsByWeekCalendar

Method: getAppointmentsByWeekCalendar ( String SID , int firstDayInWeek , Date startDate , Long requestUserId , Long omTimeZoneId , String javaTimeZoneName )

Get the appointments (calendar events) for the given requestUserId
The TimeZone can be either given by the Id of the timezone in the table "om_timezone" with the param timeZoneIdA
Or with the java name of the TimeZone in the param javaTimeZoneName

Return Type: java.util.List

Params:

Type	Fieldname	Description
String	SID	a valid user id
int	firstDayInWeek	the first dayin week, 0=Sunday, 1=Monday, ...
Date	startDate	the date it should start with
Long	requestUserId	the user id the calendar events are requested, if it is not the user id of the SID then the SID's user needs to have the right to watch those events
Long	omTimeZoneId	the id of the timezone (alternativly use javaTimeZoneName)
String	javaTimeZoneName	the name of the java time zone, see http://en.wikipedia.org/wiki/Time_zone#Java

REST Sample Call/URL:
http://localhost:5080/openmeetings/services/CalendarService/getAppointmentsByWeekCalendar?SID=VALUE&firstDayInWeek=VALUE&startDate=VALUE&requestUserId=VALUE&omTimeZoneId=VALUE&javaTimeZoneName=VALUE

Available WebServices:

WebService: CalendarService

Index of Methods available in CalendarService

Methods Details in CalendarService