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
List<OrganizerShort>	createOrganizer(String authorization, OrganizerReq body) Create organizer Creates a new organizer and sends an email to the email address defined in the request.
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 Deletes 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 a specified date range for a specified organizer.
String	getBasePath()
List<HistoricalMeeting>	getHistoricalMeetingsByOrganizer(String authorization, Long organizerKey, Date startDate, Date endDate) Get historical meetings by organizer Get historical meetings for a specified organizer within a specified date range.
ApiInvoker	getInvoker()
List<MeetingByOrganizer>	getMeetingsByOrganizer(String authorization, Long organizerKey, Boolean scheduled, Boolean history, Date startDate, Date endDate) Deprecated. Use getUpcomingMeetingsByOrganizer() and getHistoricalMeetingsByOrganizer() instead
List<Organizer>	getOrganizer(String authorization, Long organizerKey) Get organizer Returns the individual organizer specified by the key.
List<Organizer>	getOrganizerByEmail(String authorization, String email) Deprecated. Use getOrganizersAllOrByEmail() instead.
List<Organizer>	getOrganizersAllOrByEmail(String authorization, String email) Get organizer by email / Get all organizers Gets the individual organizer specified by the organizer's email address.
List<UpcomingMeeting>	getUpcomingMeetingsByOrganizer(String authorization, Long organizerKey) Get upcoming meetings by organizer Get upcoming meetings for a specified organizer.
void	updateOrganizer(String authorization, Long organizerKey, OrganizerStatus body) Update organizer Updates the products of the specified organizer.

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

@Deprecated
public List<Organizer> getOrganizerByEmail(String authorization,
                                             String email)
                                    throws ApiException

Deprecated. Use getOrganizersAllOrByEmail() instead.

Get organizer by email Gets the individual organizer specified by the organizer's email address. This API call is only available to users with the admin role.

Parameters:

authorization - Access token

email - The email address of the organizer

Returns:

List<Organizer>

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

getOrganizersAllOrByEmail

public List<Organizer> getOrganizersAllOrByEmail(String authorization,
                                        String email)
                                          throws ApiException

Get organizer by email / Get all organizers Gets the individual organizer specified by the organizer's email address. If an email address is not specified, all organizers are returned. This API call is only available to users with the admin role.

Parameters:

authorization - Access token

email - The email address of the organizer

Returns:

List<Organizer>

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

createOrganizer

public List<OrganizerShort> createOrganizer(String authorization,
                                   OrganizerReq body)
                                     throws ApiException

Create organizer Creates a new organizer and sends an email to the email address defined in the request. This API call is only available to users with the admin role. You may also pass 'G2W' or 'G2T' or 'OPENVOICE' as productType variables, creating organizers for those products. A G2W or G2T organizer will also have access to G2M.

Parameters:

authorization - Access token

body - The details of the organizer to be created

Returns:

List<OrganizerShort>

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

deleteOrganizerByEmail

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

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

Parameters:

authorization - Access token

email - The email address of the organizer

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

getOrganizer

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

Get organizer Returns the individual organizer specified by the key. This API call is only available to 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<Organizer>

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

updateOrganizer

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

Update organizer Updates the products of the specified organizer. To add a product (G2M, G2W, G2T, OPENVOICE) for the organizer, the call must be sent once for each product you want to add. To remove all products for the organizer, set status to 'suspended'. The call is limited to users with the admin role.

Parameters:

authorization - Access token

organizerKey - The key of the organizer

body - The organizer's status

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

deleteOrganizer

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

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

Parameters:

authorization - Access token

organizerKey - The key of the organizer

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

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 a specified date range for a specified organizer. This API call is only available to 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, e.g. 2015-07-01T22:00:00Z

endDate - A required end of date range in ISO8601 UTC format, e.g. 2015-07-01T23:00:00Z

Returns:

List<AttendeeByOrganizer>

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

getHistoricalMeetingsByOrganizer

public List<HistoricalMeeting> getHistoricalMeetingsByOrganizer(String authorization,
                                                       Long organizerKey,
                                                       Date startDate,
                                                       Date endDate)
                                                         throws ApiException

Get historical meetings by organizer Get historical meetings for a specified organizer within a specified date range. This API call is only available to users with the admin role.

Parameters:

authorization - Access token

organizerKey - The key of the organizer

startDate - Required start of date range, in ISO8601 UTC format, e.g. 2015-07-01T22:00:00Z

endDate - Required end of date range, in ISO8601 UTC format, e.g. 2015-07-01T23:00:00Z

Returns:

List<HistoricalMeeting>

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

getMeetingsByOrganizer

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

Deprecated. Use getUpcomingMeetingsByOrganizer() and getHistoricalMeetingsByOrganizer() instead

Get meetings by organizer Gets future (scheduled) or past (history) meetings for a specified organizer. Include 'history=true' and the past start and end dates in the URL to retrieve past meetings. Enter 'scheduled=true' (without dates) to get scheduled meetings.

Parameters:

authorization - Access token

organizerKey - The key of the organizer

scheduled - When 'true', returns all future meetings. Date range not supported.

history - When 'true', returns all past meetings within date range

startDate - If history is 'true', required start of date range, in ISO8601 UTC format, e.g. 2015-07-01T22:00:00Z

endDate - If history is 'true', required end of date range, in ISO8601 UTC format, e.g. 2015-07-01T23:00:00Z

Returns:

List<MeetingByOrganizer>

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization

getUpcomingMeetingsByOrganizer

public List<UpcomingMeeting> getUpcomingMeetingsByOrganizer(String authorization,
                                                   Long organizerKey)
                                                     throws ApiException

Get upcoming meetings by organizer Get upcoming meetings for a specified organizer. This API call is only available to users with the admin role.

Parameters:

authorization - Access token

organizerKey - The key of the organizer

Returns:

List<UpcomingMeeting>

Throws:

ApiException - If the response status code is not Successful 2xx, or an error has occurred during parameter serialization or response deserialization