com.citrix.gotomeeting.api

Class OrganizersApi

java.lang.Object

com.citrix.gotomeeting.api.OrganizersApi

public class OrganizersApi
extends Object

Constructor Summary

Constructors

Constructor and Description
OrganizersApi() Initializes a new instance of the OrganizersApi class using the default endpoint base url for the services being accessed.
OrganizersApi(String basePath) Initializes a new instance of the OrganizersApi class using an endpoint base url other than the default.

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteOrganizer(String Authorization, Long organizerKey) Delete organizer Deletes the individual organizer specified by the organizer key.
void	deleteOrganizerByEmail(String Authorization, String email) Delete organizer by email Delete the individual organizer specified by the email address.
List<AttendeeByOrganizer>	getAttendeesByOrganizer(String Authorization, Long organizerKey, Date startDate, Date endDate) Get attendees by organizer Lists all attendees for all meetings within specified date range for a specified organizer.
String	getBasePath()
ApiInvoker	getInvoker()
List<MeetingByOrganizer>	getMeetingsByOrganizer(String Authorization, Long organizerKey, Boolean scheduled, Boolean history, Date startDate, Date endDate) Get meetings by organizer Gets future (scheduled) or past (history) meetings for a specified organizer.
List<Organizer>	getOrganizer(String Authorization, Long organizerKey) Get organizer Returns the individual organizer specified by the key.
List<Organizer>	getOrganizerByEmail(String Authorization, String email) Get organizer by email Gets the individual organizer specified by the organizers email.
void	updateOrganizer(String Authorization, Long organizerKey, OrganizerStatus body) Update organizer Updates the specified organizer status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrganizersApi

public OrganizersApi()

Initializes a new instance of the OrganizersApi class using the default endpoint base url for the services being accessed.

OrganizersApi

public OrganizersApi(String basePath)

Initializes a new instance of the OrganizersApi class using an endpoint base url other than the default. Use this constructor only if you should need to override the default endpoint base url.

Parameters:

basePath - The endpoint base url for the services being accessed.

Method Detail

getInvoker

public ApiInvoker getInvoker()

getBasePath

public String getBasePath()

getOrganizerByEmail

public List<Organizer> getOrganizerByEmail(String Authorization,
                                  String email)
                                    throws ApiException

Get organizer by email Gets the individual organizer specified by the organizers email. If an organizer does not have an organizerKey then they have not completed the confirmation process for their account (i.e., have not accepted the invite and created an account password). This API is only available to corporate users with the admin role.

Parameters:

Authorization - Access token.

email - The email of the organizer.

Returns:

List

Throws:

ApiException

deleteOrganizerByEmail

public void deleteOrganizerByEmail(String Authorization,
                          String email)
                            throws ApiException

Delete organizer by email Delete the individual organizer specified by the email address. This API is only available to corporate users with the admin role.

Parameters:

Authorization - Access token.

email - The email of the organizer.

Throws:

ApiException

getOrganizer

public List<Organizer> getOrganizer(String Authorization,
                           Long organizerKey)
                             throws ApiException

Get organizer Returns the individual organizer specified by the key. This API is only available to corporate users with the admin role. Non-admin users can only make this call for their own organizerKey.

Parameters:

Authorization - Access token.

organizerKey - The key of the organizer.

Returns:

List

Throws:

ApiException

deleteOrganizer

public void deleteOrganizer(String Authorization,
                   Long organizerKey)
                     throws ApiException

Delete organizer Deletes the individual organizer specified by the organizer key. This API is only available to corporate users with the admin role.

Parameters:

Authorization - Access token.

organizerKey - The key of the organizer.

Throws:

ApiException

updateOrganizer

public void updateOrganizer(String Authorization,
                   Long organizerKey,
                   OrganizerStatus body)
                     throws ApiException

Update organizer Updates the specified organizer status. Status can either by \"active\" or \"suspended\". Suspending an organizer disables their access to GoToMeeting. This API is only available to corporate users with the admin role.

Parameters:

Authorization - Access token.

organizerKey - The key of the organizer.

body - The organizer status.

Throws:

ApiException

getAttendeesByOrganizer

public List<AttendeeByOrganizer> getAttendeesByOrganizer(String Authorization,
                                                Long organizerKey,
                                                Date startDate,
                                                Date endDate)
                                                  throws ApiException

Get attendees by organizer Lists all attendees for all meetings within specified date range for a specified organizer. This API is only available to corporate users with the admin role.

Parameters:

Authorization - Access token.

organizerKey - The key of the organizer.

startDate - A required start of date range in ISO8601 UTC format.

endDate - A required end of date range in ISO8601 UTC format.

Returns:

List

Throws:

ApiException

getMeetingsByOrganizer

public List<MeetingByOrganizer> getMeetingsByOrganizer(String Authorization,
                                              Long organizerKey,
                                              Boolean scheduled,
                                              Boolean history,
                                              Date startDate,
                                              Date endDate)
                                                throws ApiException

Get meetings by organizer Gets future (scheduled) or past (history) meetings for a specified organizer. Limited to 60 days of meeting history. You cannot access another organizer's data unless you are the admin for a corporate account. This API is only available to corporate users with the admin role. Include 'history=true' and the past start and end dates in the URL to retrieve past meetings. Replace with 'scheduled=true' and future start and end dates to get scheduled meetings.

Parameters:

Authorization - Access token.

organizerKey - The key of the organizer.

scheduled - When "true" returns all future meetings.

history - When "true" returns all past meetings within date range.

startDate - If history or shceduled is "true", required start of date range, in ISO8601 UTC format.

endDate - If history or shcedule is "true", required end of date range, in ISO8601 UTC format.

Returns:

List

Throws:

ApiException