Skip to content

Instantly share code, notes, and snippets.

@kinlane
Created August 17, 2018 01:13
Show Gist options
  • Save kinlane/508370ef0cc34f1677fa3d2a946bdf2e to your computer and use it in GitHub Desktop.
Save kinlane/508370ef0cc34f1677fa3d2a946bdf2e to your computer and use it in GitHub Desktop.
GoToWebinar-openapi
{
"swagger": "2.0",
"info": {
"version": "1.0",
"title": "GoToWebinar API",
"description": "TODO: Add Description"
},
"host": "api.getgo.com",
"basePath": "/G2W/rest/organizers",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/{organizerKey}/webinars/{webinarKey}/panelists": {
"get": {
"description": "",
"summary": "Get webinar panelists",
"tags": [
"Panelists"
],
"operationId": "WebinarsPanelistsByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create Panelists",
"tags": [
"Panelists"
],
"operationId": "WebinarsPanelistsByOrganizerKeyAndWebinarKeyPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/CreatePanelistsrequest"
}
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerkey}/webinars": {
"post": {
"description": "",
"summary": "Create Webinar",
"tags": [
"Webinars"
],
"operationId": "WebinarsByOrganizerkeyPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateWebinarrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerkey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees/{registrantKey}": {
"get": {
"description": "",
"summary": "Get attendee",
"tags": [
"Attendees"
],
"operationId": "WebinarsSessionsSessionKeyAttendeesRegistrantKeyByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "sessionKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "registrantKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}": {
"get": {
"description": "",
"summary": "Get Webinar",
"tags": [
"Webinars"
],
"operationId": "WebinarsByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "",
"summary": "Update webinar",
"tags": [
"Webinars"
],
"operationId": "WebinarsByOrganizerKeyAndWebinarKeyPut",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/UpdateWebinarrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Cancel Webinar",
"tags": [
"Webinars"
],
"operationId": "WebinarsByOrganizerKeyAndWebinarKeyDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "sendCancellationEmails",
"in": "query",
"required": true,
"type": "boolean",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CancelWebinarrequest"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees/{registrantKey}/questions": {
"get": {
"description": "",
"summary": "Get attendee questions",
"tags": [
"Attendees"
],
"operationId": "WebinarsSessionsSessionKeyAttendeesRegistrantKeyQuestionsByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "sessionKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "registrantKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/surveys": {
"get": {
"description": "",
"summary": "Get session surveys",
"tags": [
"Sessions"
],
"operationId": "WebinarsSessionsSessionKeySurveysByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "sessionKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/registrants/{registrantKey}": {
"get": {
"description": "",
"summary": "Get Registrant",
"tags": [
"Registrants"
],
"operationId": "WebinarsRegistrantsRegistrantKeyByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "registrantKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "",
"summary": "Delete Registrant",
"tags": [
"Registrants"
],
"operationId": "WebinarsRegistrantsRegistrantKeyByOrganizerKeyAndWebinarKeyDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "registrantKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/meetingtimes": {
"get": {
"description": "",
"summary": "Get webinar meeting times",
"tags": [
"Webinars"
],
"operationId": "WebinarsMeetingtimesByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/historicalWebinars": {
"get": {
"description": "Returns details for completed webinars for the specified organizer and completed webinars of other organizers where the specified organizer is a co-organizer.\n\nParameters:\n- organizerkey \n- fromTime\n- toTime",
"summary": "Historical Webinars",
"tags": [
"Webinars"
],
"operationId": "HistoricalWebinarsByOrganizerKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "fromTime",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "toTime",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/audio": {
"get": {
"description": "",
"summary": "Get audio information",
"tags": [
"Webinars"
],
"operationId": "WebinarsAudioByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "ONLY USE ONE IN THE BODY",
"summary": "Update audio information",
"tags": [
"Webinars"
],
"operationId": "WebinarsAudioByOrganizerKeyAndWebinarKeyPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/registrants": {
"get": {
"description": "",
"summary": "Get registrants",
"tags": [
"Registrants"
],
"operationId": "WebinarsRegistrantsByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create Registrant (Version 2)",
"tags": [
"Registrants"
],
"operationId": "WebinarsRegistrantsByOrganizerKeyAndWebinarKeyPost2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreateRegistrant(version2)request"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/panelists/{panelistKey}/resendInvitation": {
"post": {
"description": "",
"summary": "Resend panelist invitation",
"tags": [
"Panelists"
],
"operationId": "WebinarsPanelistsPanelistKeyResendInvitationByOrganizerKeyAndWebinarKeyPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ResendPanelistInvitationrequest"
}
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "panelistKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/performance": {
"get": {
"description": "",
"summary": "Get performance for all webinar sessions",
"tags": [
"Webinars"
],
"operationId": "WebinarsPerformanceByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/coorganizers/{coorganizerkey}/resendInvitation": {
"post": {
"description": "",
"summary": "Resend invitation",
"tags": [
"Co-Organizers"
],
"operationId": "WebinarsCoorganizersCoorganizerkeyResendInvitationByOrganizerKeyAndWebinarKeyPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "coorganizerkey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/polls": {
"get": {
"description": "",
"summary": "Get session polls",
"tags": [
"Sessions"
],
"operationId": "WebinarsSessionsSessionKeyPollsByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "sessionKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/questions": {
"get": {
"description": "",
"summary": "Get session questions",
"tags": [
"Sessions"
],
"operationId": "WebinarsSessionsSessionKeyQuestionsByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "sessionKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/sessions": {
"get": {
"description": "",
"summary": "Get webinar sessions",
"tags": [
"Sessions"
],
"operationId": "WebinarsSessionsByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/registrants/fields": {
"get": {
"description": "",
"summary": "Get registration fields",
"tags": [
"Registrants"
],
"operationId": "WebinarsRegistrantsFieldsByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees": {
"get": {
"description": "",
"summary": "Get session attendees",
"tags": [
"Attendees"
],
"operationId": "WebinarsSessionsSessionKeyAttendeesByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "sessionKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/attendees": {
"get": {
"description": "",
"summary": "Get attendees for all webinar sessions",
"tags": [
"Webinars"
],
"operationId": "WebinarsAttendeesByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars": {
"get": {
"description": "Returns webinars scheduled for the future for a specified organizer.",
"summary": "Get All Webinars",
"tags": [
"Webinars"
],
"operationId": "WebinarsByOrganizerKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/coorganizers": {
"get": {
"description": "",
"summary": "Get co-organizers",
"tags": [
"Co-Organizers"
],
"operationId": "WebinarsCoorganizersByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "",
"summary": "Create co-organizers",
"tags": [
"Co-Organizers"
],
"operationId": "WebinarsCoorganizersByOrganizerKeyAndWebinarKeyPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Create coOrganizersrequest"
}
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/upcomingWebinars": {
"get": {
"description": "Returns webinars scheduled for the future for the specified organizer and webinars of other organizers where the specified organizer is a co-organizer.",
"summary": "Upcoming Webinars",
"tags": [
"Webinars"
],
"operationId": "UpcomingWebinarsByOrganizerKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/sessions": {
"get": {
"description": "",
"summary": "Get organizer sessions",
"tags": [
"Sessions"
],
"operationId": "SessionsByOrganizerKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "fromTime",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "toTime",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/coorganizers/{coorganizerkey}": {
"delete": {
"description": "",
"summary": "Delete co-organizers",
"tags": [
"Co-Organizers"
],
"operationId": "WebinarsCoorganizersCoorganizerkeyByOrganizerKeyAndWebinarKeyDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "coorganizerkey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/panelists/{panelistKey}": {
"delete": {
"description": "",
"summary": "Delete webinar panelist",
"tags": [
"Panelists"
],
"operationId": "WebinarsPanelistsPanelistKeyByOrganizerKeyAndWebinarKeyDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DeleteWebinarPanelistrequest"
}
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "panelistKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}": {
"get": {
"description": "",
"summary": "Get webinar session",
"tags": [
"Sessions"
],
"operationId": "WebinarsSessionsSessionKeyByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "sessionKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/performance": {
"get": {
"description": "",
"summary": "Get session performance",
"tags": [
"Sessions"
],
"operationId": "WebinarsSessionsSessionKeyPerformanceByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "sessionKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees/{registrantKey}/surveys": {
"get": {
"description": "",
"summary": "Get attendee survey answers",
"tags": [
"Attendees"
],
"operationId": "WebinarsSessionsSessionKeyAttendeesRegistrantKeySurveysByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "sessionKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "registrantKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/{organizerKey}/webinars/{webinarKey}/sessions/{sessionKey}/attendees/{registrantKey}/polls": {
"get": {
"description": "",
"summary": "Get attendee poll answers",
"tags": [
"Attendees"
],
"operationId": "WebinarsSessionsSessionKeyAttendeesRegistrantKeyPollsByOrganizerKeyAndWebinarKeyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "organizerKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "webinarKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "sessionKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
},
{
"name": "registrantKey",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
}
},
"definitions": {
"CreateWebinarrequest": {
"title": "Create WebinarRequest",
"example": {
"subject": "API Test WEbinar",
"description": "Creating a test API webinar",
"times": [
{
"startTime": "2016-07-09T22:00:00Z",
"endTime": "2016-07-09T23:00:00Z"
}
],
"timeZone": "America/Los_Angeles"
},
"type": "object",
"properties": {
"subject": {
"description": "",
"example": "API Test WEbinar",
"type": "string"
},
"description": {
"description": "",
"example": "Creating a test API webinar",
"type": "string"
},
"times": {
"description": "",
"example": [
{
"startTime": "2016-07-09T22:00:00Z",
"endTime": "2016-07-09T23:00:00Z"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Time1"
}
},
"timeZone": {
"description": "",
"example": "America/Los_Angeles",
"type": "string"
}
},
"required": [
"subject",
"description",
"times",
"timeZone"
]
},
"Time1": {
"title": "Time1",
"example": {
"startTime": "2016-07-09T22:00:00Z",
"endTime": "2016-07-09T23:00:00Z"
},
"type": "object",
"properties": {
"startTime": {
"description": "",
"example": "7/9/2016 10:00:00 PM",
"type": "string"
},
"endTime": {
"description": "",
"example": "7/9/2016 11:00:00 PM",
"type": "string"
}
},
"required": [
"startTime",
"endTime"
]
},
"CancelWebinarrequest": {
"title": "Cancel WebinarRequest",
"example": {
"subject": "API Test WEbinar",
"description": "Creating a test API webinar",
"times": [
{
"startTime": "2016-07-09T22:00:00Z",
"endTime": "2016-07-09T23:00:00Z"
}
],
"timeZone": "America/Los_Angeles"
},
"type": "object",
"properties": {
"subject": {
"description": "",
"example": "API Test WEbinar",
"type": "string"
},
"description": {
"description": "",
"example": "Creating a test API webinar",
"type": "string"
},
"times": {
"description": "",
"example": [
{
"startTime": "2016-07-09T22:00:00Z",
"endTime": "2016-07-09T23:00:00Z"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Time1"
}
},
"timeZone": {
"description": "",
"example": "America/Los_Angeles",
"type": "string"
}
},
"required": [
"subject",
"description",
"times",
"timeZone"
]
},
"ResendPanelistInvitationrequest": {
"title": "Resend panelist invitationRequest",
"example": {
"name": "First Last",
"email": "email@address.com"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "First Last",
"type": "string"
},
"email": {
"description": "",
"example": "email@address.com",
"type": "string"
}
},
"required": [
"name",
"email"
]
},
"UpdateWebinarrequest": {
"title": "Update webinarRequest",
"example": {
"description": "example",
"subject": "Example"
},
"type": "object",
"properties": {
"description": {
"description": "",
"example": "example",
"type": "string"
},
"subject": {
"description": "",
"example": "Example",
"type": "string"
}
},
"required": [
"description",
"subject"
]
},
"CreateRegistrant(version1)request": {
"title": "Create Registrant (Version 1)Request",
"example": {
"lastName": "Four",
"email": "registrantfour@example.com",
"firstName": "Registrant"
},
"type": "object",
"properties": {
"lastName": {
"description": "",
"example": "Four",
"type": "string"
},
"email": {
"description": "",
"example": "registrantfour@example.com",
"type": "string"
},
"firstName": {
"description": "",
"example": "Registrant",
"type": "string"
}
},
"required": [
"lastName",
"email",
"firstName"
]
},
"CreateRegistrant(version2)request": {
"title": "Create Registrant (Version 2)Request",
"example": {
"firstName": "Registrant",
"lastName": "Five",
"email": "registrantfive@example.com",
"city": "A City",
"state": "California",
"responses": [
{
"questionKey": 33519384,
"answerKey": 33519385
},
{
"questionKey": 33519388,
"responseText": "A short answer that's written out."
}
]
},
"type": "object",
"properties": {
"firstName": {
"description": "",
"example": "Registrant",
"type": "string"
},
"lastName": {
"description": "",
"example": "Five",
"type": "string"
},
"email": {
"description": "",
"example": "registrantfive@example.com",
"type": "string"
},
"city": {
"description": "",
"example": "A City",
"type": "string"
},
"state": {
"description": "",
"example": "California",
"type": "string"
},
"responses": {
"description": "",
"example": [
{
"questionKey": 33519384,
"answerKey": 33519385
},
{
"questionKey": 33519388,
"responseText": "A short answer that's written out."
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Response"
}
}
},
"required": [
"firstName",
"lastName",
"email",
"city",
"state",
"responses"
]
},
"Response": {
"title": "Response",
"example": {
"questionKey": 33519384,
"answerKey": 33519385
},
"type": "object",
"properties": {
"questionKey": {
"description": "",
"example": 33519384,
"type": "integer",
"format": "int32"
},
"answerKey": {
"description": "",
"example": 33519385,
"type": "integer",
"format": "int32"
},
"responseText": {
"description": "",
"example": "A short answer that's written out.",
"type": "string"
}
},
"required": [
"questionKey"
]
},
"Create coOrganizersrequest": {
"title": "Create co-organizersRequest",
"example": {
"email": "tyler.rosenow@global.citrixonline.com",
"organizerKey": "848685880436592387",
"external": false,
"surname": "Rosenow",
"givenName": "Tyler"
},
"type": "object",
"properties": {
"email": {
"description": "",
"example": "tyler.rosenow@global.citrixonline.com",
"type": "string"
},
"external": {
"description": "",
"example": false,
"type": "boolean"
},
"givenName": {
"description": "",
"example": "Tyler",
"type": "string"
},
"organizerKey": {
"description": "",
"example": "848685880436592387",
"type": "string"
},
"surname": {
"description": "",
"example": "Rosenow",
"type": "string"
}
},
"required": [
"email",
"external",
"givenName"
]
},
"CreatePanelistsrequest": {
"title": "Create PanelistsRequest",
"example": {
"name": "First Last",
"email": "email@address.com"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "First Last",
"type": "string"
},
"email": {
"description": "",
"example": "email@address.com",
"type": "string"
}
},
"required": [
"name",
"email"
]
},
"DeleteWebinarPanelistrequest": {
"title": "Delete webinar panelistRequest",
"example": {
"name": "First Last",
"email": "email@address.com"
},
"type": "object",
"properties": {
"name": {
"description": "",
"example": "First Last",
"type": "string"
},
"email": {
"description": "",
"example": "email@address.com",
"type": "string"
}
},
"required": [
"name",
"email"
]
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment