com.citrix.gotomeeting.api

Class GroupsApi

java.lang.Object

com.citrix.gotomeeting.api.GroupsApi

public class GroupsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
List<OrganizerShort>	createOrganizer(String authorization, Long groupKey, OrganizerReq body) Create organizer in group Creates a new organizer and sends an email to the email address defined in request.
List<AttendeeByGroup>	getAttendeesByGroup(String authorization, Long groupKey, Date startDate, Date endDate) Get attendees by group Returns all attendees for all meetings within specified date range held by organizers within the specified group.
String	getBasePath()
List<Group>	getGroups(String authorization) Get groups List all groups for an account.
List<HistoricalMeetingByGroup>	getHistoricalMeetingsByGroup(String authorization, Long groupKey, Date startDate, Date endDate) Get historical meetings by group Get historical meetings for a specified group within a specified date range.
List<HistoryMeetingByGroup>	getHistoryMeetingsByGroup(String authorization, Long groupKey, Boolean history, Date startDate, Date endDate) Deprecated. Please use getHistoricalMeetingsByGroup() instead.
ApiInvoker	getInvoker()
List<OrganizerByGroup>	getOrganizersByGroup(String authorization, Long groupKey) Get organizers by group Returns all the organizers within a specific group.
List<ScheduledMeetingByGroup>	getScheduledMeetingsByGroup(String authorization, Long groupKey, Boolean scheduled, Date startDate, Date endDate) Deprecated. Please use getUpcomingMeetingsByGroup() instead
List<UpcomingMeetingByGroup>	getUpcomingMeetingsByGroup(String authorization, Long groupKey) Get upcoming meetings by group Get upcoming meetings for a specified group.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupsApi

public GroupsApi()

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

GroupsApi

public GroupsApi(String basePath)

Initializes a new instance of the GroupsApi 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()

getGroups

public List<Group> getGroups(String authorization)
                      throws ApiException

Get groups List all groups for an account. This API call is only available to users with the admin role.

Parameters:

authorization - Access token

Returns:

List<Group>

Throws:

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

getAttendeesByGroup

public List<AttendeeByGroup> getAttendeesByGroup(String authorization,
                                        Long groupKey,
                                        Date startDate,
                                        Date endDate)
                                          throws ApiException

Get attendees by group Returns all attendees for all meetings within specified date range held by organizers within the specified group. This API call is only available to users with the admin role. This API call can be used only for groups with maximum 50 organizers.

Parameters:

authorization - Access token

groupKey - The key of the group

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

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

Returns:

List<AttendeeByGroup>

Throws:

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

getScheduledMeetingsByGroup

@Deprecated
public List<ScheduledMeetingByGroup> getScheduledMeetingsByGroup(String authorization,
                                                                   Long groupKey,
                                                                   Boolean scheduled,
                                                                   Date startDate,
                                                                   Date endDate)
                                                          throws ApiException

Deprecated. Please use getUpcomingMeetingsByGroup() instead

Get scheduled meetings by group Get scheduled meetings for a group. This API is only available to corporate users with the admin role.

Parameters:

authorization - Access token

groupKey - The key of the group

scheduled - When 'true' returns all future meetings

startDate - If history=true, required start of date range, in ISO8601 UTC format

endDate - If history=true, required end of date range, in ISO8601 UTC format

Returns:

List<ScheduledMeetingByGroup>

Throws:

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

getHistoricalMeetingsByGroup

public List<HistoricalMeetingByGroup> getHistoricalMeetingsByGroup(String authorization,
                                                          Long groupKey,
                                                          Date startDate,
                                                          Date endDate)
                                                            throws ApiException

Get historical meetings by group Get historical meetings for a specified group within a specified date range. This API call is only available to users with the admin role. This API call can be used only for groups with maximum 50 organizers.

Parameters:

authorization - Access token

groupKey - The key of the group

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<HistoricalMeetingByGroup>

Throws:

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

getHistoryMeetingsByGroup

@Deprecated
public List<HistoryMeetingByGroup> getHistoryMeetingsByGroup(String authorization,
                                                               Long groupKey,
                                                               Boolean history,
                                                               Date startDate,
                                                               Date endDate)
                                                      throws ApiException

Deprecated. Please use getHistoricalMeetingsByGroup() instead.

Get historical meetings by group Get meetings for a specified group. Additional filters can be used to view only meetings within a specified date range. This API call is only available to users with the admin role.

Parameters:

authorization - Access token

groupKey - The key of the group

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

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

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

Returns:

List<HistoryMeetingByGroup>

Throws:

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

getOrganizersByGroup

public List<OrganizerByGroup> getOrganizersByGroup(String authorization,
                                          Long groupKey)
                                            throws ApiException

Get organizers by group Returns all the organizers within a specific group. This API call is only available to users with the admin role.

Parameters:

authorization - Access token

groupKey - The key of the group

Returns:

List<OrganizerByGroup>

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,
                                   Long groupKey,
                                   OrganizerReq body)
                                     throws ApiException

Create organizer in group Creates a new organizer and sends an email to the email address defined in 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

groupKey - The key of the group

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

getUpcomingMeetingsByGroup

public List<UpcomingMeetingByGroup> getUpcomingMeetingsByGroup(String authorization,
                                                      Long groupKey)
                                                        throws ApiException

Get upcoming meetings by group Get upcoming meetings for a specified group. This API call is only available to users with the admin role. This API call can be used only for groups with maximum 50 organizers.

Parameters:

authorization - Access token

groupKey - The key of the group

Returns:

List<UpcomingMeetingByGroup>

Throws:

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