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.
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<HistoryMeetingByGroup>	getHistoryMeetingsByGroup(String Authorization, Long groupKey, Boolean history, Date startDate, Date endDate) Get historical meetings by group Get meetings for group.
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) Get scheduled meetings by group Get scheduled meetings for a 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 is only available to corporate users with the admin role.

Parameters:

Authorization - Access token.

Returns:

List

Throws:

ApiException

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 is only available to corporate users with the admin role.

Parameters:

Authorization - Access token.

groupKey - The key of the group.

startDate - Start of date range, in ISO8601 UTC format.

endDate - End of date range, in ISO8601 UTC format.

Returns:

List

Throws:

ApiException

getScheduledMeetingsByGroup

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

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

Throws:

ApiException

getHistoryMeetingsByGroup

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

Get historical meetings by group Get meetings for group. Additional filters can be used to view only meetings within a specified date range. Please note that you can only search 60 days worth of meeting history. This API is only available to corporate 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.

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

Returns:

List

Throws:

ApiException

createOrganizer

public List<OrganizerShort> createOrganizer(String Authorization,
                                   Long groupKey,
                                   OrganizerReq body)
                                     throws ApiException

Create organizer in group Creates a new organizer. Returns an empty response and sends an email to the email defined in request. The organizer is not assigned an organizer key until after the organizer confirms the account and creates their password. The organizer status can be found through Get Organizers by Group and specifying the same GroupKey. This API call is only available to admin users within corporate accounts. 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

Throws:

ApiException

getOrganizersByGroup

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

Get organizers by group Returns all the organizers within a specific group. If an organizer does not have an organizerKey then they have not completed the confirmation process for their account (i.e. accepted the invite and created an account password). This API is only available to corporate users with the admin role.

Parameters:

Authorization - Access token.

groupKey - The key of the group.

Returns:

List

Throws:

ApiException