This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Working with Sessions in GoToWebinar

Owned by Former user (Deleted)
Last updated: May 10, 2016 by Former user (Deleted)
5 min read

Overview

The following operations allow you to work with sessions. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with sessions, see Sample configuration. 

OperationDescription
getSessionById

Retrieves attendance details.

listSessionAttendeesRetrieves attendee details.
listSessionsRetrieves session details of a past webinar session.
getOrganizerSessionsRetrieves all completed sessions of all the webinars of a given organizer.
getSessionPerformanceRetrieves performance details for a session.
getSessionPollsRetrieves all collated attendee questions and answers for polls from a specific webinar session.
getSessionQuestionsRetrieves questions and answers for a past webinar session.
getSessionSurveysRetrieves surveys for a past webinar session.

Operation details

This section provides further details on the operations related to sessions.

Related GoToWebinar documentation

https://developer.citrixonline.com/content/gotowebinar-api-reference

Retrieving attendance details

The getSessionById operation retrieves attendance details for a webinar that has ended.

getSessionById 
<gotowebinar.getSessionById>
    <webinarKey>{$ctx:webinarKey}</webinarKey>
	<sessionKey>{$ctx:sessionKey}</sessionKey>
</gotowebinar.getSessionById>
Properties
  • webinarKey: Required - The ID of the webinar.
  • sessionKey: Required - The ID of the webinar session.
Sample request

Following is a sample REST/JSON request that can be handled by the getSessionById operation.

Sample Request for getSessionById 
{
    "apiUrl":"https://api.citrixonline.com",
    "accessToken":"UEGGrwswKRwB07lTOr0EoppdaxKo",
    "organizerKey":"3697511743350317068",
    "clientId":"IJfcaqp3xC034WXD1GGlstejnJS41huo",
    "refreshToken":"MDAKxJTJ3cAdhuzavhtOFNAmV5N0m7gm",
	"webinarKey":"6487648931392511233",
	"sessionKey":"2167614"
}

Retrieving attendee details 

The listSessionAttendees operation retrieves attendee details for all attendees of a webinar session. 

listSessionAttendees 
<gotowebinar.listSessionAttendees>
	<webinarKey>{$ctx:webinarKey}</webinarKey>
 	<sessionKey>{$ctx:sessionKey}</sessionKey>
</gotowebinar.listSessionAttendees>
Properties
  • webinarKey: Required - The ID of the webinar.
  • sessionKey: Required - The ID of the webinar session.
Sample request

Following is a sample REST/JSON request that can be handled by the listSessionAttendees operation.

Sample Request for listSessionAttendees 
{
    "apiUrl":"https://api.citrixonline.com",
    "accessToken":"UEGGrwswKRwB07lTOr0EoppdaxKo",
    "organizerKey":"3697511743350317068",
    "clientId":"IJfcaqp3xC034WXD1GGlstejnJS41huo",
    "refreshToken":"MDAKxJTJ3cAdhuzavhtOFNAmV5N0m7gm",
	"webinarKey":"6487648931392511233",
	"sessionKey":"2167614"
}

Retrieving session details 

The listSessions operation retrieves session details of a past webinar session.

listSessions 
<gotowebinar.listSessions>
 	<webinarKey>{$ctx:webinarKey}</webinarKey>
</gotowebinar.listSessions>
Properties
  • webinarKey: Required - The ID of the webinar.
Sample request

Following is a sample REST/JSON request that can be handled by the listSessions operation.

Sample Request for listSessions 
{
    "apiUrl":"https://api.citrixonline.com",
    "accessToken":"UEGGrwswKRwB07lTOr0EoppdaxKo",
    "organizerKey":"3697511743350317068",
    "clientId":"IJfcaqp3xC034WXD1GGlstejnJS41huo",
    "refreshToken":"MDAKxJTJ3cAdhuzavhtOFNAmV5N0m7gm",
	"webinarKey":"6487648931392511233"
}

Retrieving all completed sessions of all the webinars of an organizer

The getOrganizerSessions operation retrieves all completed sessions of all the webinars of a given organizer.

getOrganizerSessions 
<gotowebinar.getOrganizerSessions>
    <fromTime>{$ctx:fromTime}</fromTime>
    <toTime>{$ctx:toTime}</toTime>
</gotowebinar.getOrganizerSessions>
Properties
  • fromTime: Required - The starting time of the webinar.
  • toTime  : Required - The end time of the webinar session.
Sample request

Following is a sample REST/JSON request that can be handled by the getOrganizerSessions operation.

Sample Request for getOrganizerSessions 
{
    "apiUrl":"https://api.citrixonline.com",
    "accessToken":"UEGGrwswKRwB07lTOr0EoppdaxKo",
    "organizerKey":"3697511743350317068",
    "clientId":"IJfcaqp3xC034WXD1GGlstejnJS41huo",
    "refreshToken":"MDAKxJTJ3cAdhuzavhtOFNAmV5N0m7gm",
    "fromTime": "2015-05-09T16:45:58Z",
	"toTime":"2016-05-09T16:45:58Z"
}

Retrieving performance of a session 

The  getSessionPerformance operation retrieves performance details for a session.

getSessionPerformance 
<gotowebinar.getSessionPerformance>
    <webinarKey>{$ctx:webinarKey}</webinarKey>
    <sessionKey>{$ctx:sessionKey}</sessionKey>
</gotowebinar.getSessionPerformance>
Properties
  • webinarKey: Required - The ID of the webinar.
  • sessionKey:  Required - The ID of the webinar session.
Sample request

Following is a sample REST/JSON request that can be handled by the getSessionPerformance operation.

Sample Request for getSessionPerformance 
{
    "apiUrl":"https://api.citrixonline.com",
    "accessToken":"UEGGrwswKRwB07lTOr0EoppdaxKo",
    "organizerKey":"3697511743350317068",
    "clientId":"IJfcaqp3xC034WXD1GGlstejnJS41huo",
    "refreshToken":"MDAKxJTJ3cAdhuzavhtOFNAmV5N0m7gm",
	"webinarKey":"2458336850084791299",
    "sessionKey":"6571792"
}

Retrieving questions and answers for polls of a session 

The  getSessionPolls operation retrieves all collated attendee questions and answers for polls from a specific webinar session.

getSessionPolls 
<gotowebinar.getSessionPolls>
    <webinarKey>{$ctx:webinarKey}</webinarKey>
    <sessionKey>{$ctx:sessionKey}</sessionKey>
</gotowebinar.getSessionPolls>
Properties
  • webinarKey: Required - The ID of the webinar.
  • sessionKey: Required - The ID of the webinar session.
Sample request

Following is a sample REST/JSON request that can be handled by the getSessionPolls operation.

Sample Request for getSessionPolls 
{
    "apiUrl":"https://api.citrixonline.com",
    "accessToken":"UEGGrwswKRwB07lTOr0EoppdaxKo",
    "organizerKey":"3697511743350317068",
    "clientId":"IJfcaqp3xC034WXD1GGlstejnJS41huo",
    "refreshToken":"MDAKxJTJ3cAdhuzavhtOFNAmV5N0m7gm",
	"webinarKey":"6487648931392511233",
    "sessionKey": "6571792"
}

Retrieving questions and answers of a session 

The  getSessionQuestions operation retrieves questions and answers for a past webinar session.

getSessionQuestions 
<gotowebinar.getSessionQuestions>
    <webinarKey>{$ctx:webinarKey}</webinarKey>
    <sessionKey>{$ctx:sessionKey}</sessionKey>
</gotowebinar.getSessionQuestions>
Properties
  • webinarKey: Required - The ID of the webinar.
  • sessionKey: Required - The ID of the webinar session.
Sample request

Following is a sample REST/JSON request that can be handled by the getSessionQuestions operation.

Sample Request for getSessionQuestions 
{
    "apiUrl":"https://api.citrixonline.com",
    "accessToken":"UEGGrwswKRwB07lTOr0EoppdaxKo",
    "organizerKey":"3697511743350317068",
    "clientId":"IJfcaqp3xC034WXD1GGlstejnJS41huo",
    "refreshToken":"MDAKxJTJ3cAdhuzavhtOFNAmV5N0m7gm",
	"webinarKey":"6487648931392511233",
    "sessionKey":"6571792"
}

Retrieving surveys of a session 

The getSessionSurveys operation retrieves surveys for a past webinar session.

getSessionSurveys 
<gotowebinar.getSessionSurveys>
    <webinarKey>{$ctx:webinarKey}</webinarKey>
    <sessionKey>{$ctx:sessionKey}</sessionKey>
</gotowebinar.getSessionSurveys>
Properties
  • webinarKey: Required - The ID of the webinar.
  • sessionKey: Required - The ID of the webinar session.
Sample request

Following is a sample REST/JSON request that can be handled by the getSessionSurveys operation.

Sample Request for getSessionSurveys 
{
    "apiUrl":"https://api.citrixonline.com",
    "accessToken":"UEGGrwswKRwB07lTOr0EoppdaxKo",
    "organizerKey":"3697511743350317068",
    "clientId":"IJfcaqp3xC034WXD1GGlstejnJS41huo",
    "refreshToken":"MDAKxJTJ3cAdhuzavhtOFNAmV5N0m7gm",
	"webinarKey":"6487648931392511233",
    "sessionKey":"6571792"
}

Sample configuration

Following is a sample proxy service that illustrates how to connect to GoToWebinar with the init operation and use the getSessionById operation. The sample request for this proxy can be found in the  getSessionById  sample request. You can use this sample as a template for using other operations in this category.

Sample Proxy
<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="gotowebinar_getSessionById"
       transports="https,http"
       statistics="disable"
       trace="disable"
       startOnLoad="true">
   <target>
      <inSequence>
        <property name="accessToken" expression="json-eval($.accessToken)"/>
        <property name="organizerKey" expression="json-eval($.organizerKey)"/>
        <property name="apiUrl" expression="json-eval($.apiUrl)"/>
        <property name="refreshToken" expression="json-eval($.refreshToken)"/>
        <property name="clientId" expression="json-eval($.clientId)"/>
        <property name="registryPath" expression="json-eval($.registryPath)"/>
        <property name="intervalTime" expression="json-eval($.intervalTime)"/>
        <property name="webinarKey" expression="json-eval($.webinarKey)"/>
        <property name="sessionKey" expression="json-eval($.sessionKey)"/>
         <gotowebinar.init>
            <accessToken>{$ctx:accessToken}</accessToken>
            <organizerKey>{$ctx:organizerKey}</organizerKey>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <refreshToken>{$ctx:refreshToken}</refreshToken>
            <clientId>{$ctx:clientId}</clientId>
            <registryPath>{$ctx:registryPath}</registryPath>
            <intervalTime>{$ctx:intervalTime}</intervalTime>
         </gotowebinar.init>
         <gotowebinar.getSessionById>
            <webinarKey>{$ctx:webinarKey}</webinarKey>
            <sessionKey>{$ctx:sessionKey}</sessionKey>
         </gotowebinar.getSessionById>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>