Connectors Reference

GoToTraining

Citrix GoToTraining enables you to manage a stable and high-performance online training environment.

 

Status: Preview

Tier: Premium

Version: 1.0.0

 

Actions:

Name

Summary

ListTrainings ()

List trainings

GetTraining (string trainingid)

Get training

ListRegistrations (string trainingid)

List registrants

AddRegistrant (string trainingid, AddRegistrantParameterBody body)

Add registrant

GetRegistrant (string trainingid, string registrantKey)

Get Registrant

 

Triggers:

Name

Summary

OnNewTraining ()

When a training is created

OnNewRegistration (string trainingid)

When a registrant is added

 

Objects:

Name

Summary

AddRegistrantParameterBody

 

AddRegistrantResponse

 

Registrant

 

Training

 

 

Actions:

ListTrainings

Summary: List trainings

Description: Retrieves a list of trainings organized by the authenticated user.

 

Syntax:

GoToTraining.ListTrainings ()

 

Returns:

          Type:array of (Training)

 

GetTraining

Summary: Get training

Description: Retrieves all information about a scheduled training.

 

Syntax:

GoToTraining.GetTraining (string trainingid)

 

Parameters:

Name

Type

Summary

Required

Related Action

trainingid

string

(Training Id)

Training

True

ListTrainings

 

Returns:

          Type:Training

 

ListRegistrations

Summary: List registrants

Description: Retrieves details of all registrants for a specific training.

 

Syntax:

GoToTraining.ListRegistrations (string trainingid)

 

Parameters:

Name

Type

Summary

Required

Related Action

trainingid

string

(Training Id)

Training

True

ListTrainings

 

Returns:

          Type:array of (Registrant)

 

AddRegistrant

Summary: Add registrant

Description: Registers one person, identified by a unique email address, for a training.

 

Syntax:

GoToTraining.AddRegistrant (string trainingid, AddRegistrantParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

trainingid

string

(Training Id)

Training

True

ListTrainings

body

AddRegistrantParameterBody

 

 

True

 

Returns:

          Type:AddRegistrantResponse

 

GetRegistrant

Summary: Get Registrant

Description: Retrieves details of a specific registrant in a training.

 

Syntax:

GoToTraining.GetRegistrant (string trainingid, string registrantKey)

 

Parameters:

Name

Type

Summary

Required

Related Action

trainingid

string

(Training Id)

Training

True

ListTrainings

registrantKey

string

(Registrant key)

Registrant key

True

 

Returns:

          Type:Registrant

 

Triggers:

Trigger OnNewTraining

Summary: When a training is created

Description: Triggers when a new training is created.

 

Syntax:

GoToTraining.OnNewTraining ()

 

Returns:

          Type:array of (Training)

 

Trigger OnNewRegistration

Summary: When a registrant is added

Description: Triggers when a registrant is added to a training.

 

Syntax:

GoToTraining.OnNewRegistration (string trainingid)

 

Parameters:

Name

Type

Summary

Required

Related Action

trainingid

string

(Training Id)

Training

True

ListTrainings

 

Returns:

          Type:array of (Registrant)

 


 

AddRegistrantParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Registrant email

Registrant email

givenName

string

First name

First name

surname

string

Last name

Last name


 

AddRegistrantResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

joinUrl

string

Join Url

Url link to join the meeting.

confirmationUrl

string

Confirmation Url

Url link for rsvp.

registrantKey

string

Registrant Key

Unique identifier of the registrant.


 

Registrant

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Email

Registrant's email.

givenName

string

First name

Registrant's first name.

surname

string

Last name

Registrant's last name.

status

string

Status

Registrant's rsvp status.

registrationDate

string(date-time)

Registration date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

joinUrl

string

Join Url

Link to use by the registrant to join a training.

confirmationUrl

string

Confirmation Url

Link to use by the registrant to rsvp for a training.

registrantKey

string

Registrant Key

Unique key of the registrant.


 

Training

Summary:

Description:

 

          Properties:

Name

Type

Summary

trainingId

string

Training Id

Unique identifier of the training.

name

string

Title

Subject of the training.

timeZone

string

Time Zone

Where the training will take place.

times

array of (TimesItem)

 

 

organizers

array of (OrganizersItem)

 

 

registrationSettings

RegistrationSettings

Registration Settings

 

trainingKey

string

Training Key

Unique key of the training.

 

TimesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

startDate

string(date-time)

Start date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

endDate

string(date-time)

End date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

 

OrganizersItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

givenName

string

First Name

Organizer's first name.

surname

string

Last Name

Organizer's last name.

email

string

Email

Organizer's email.

organizerKey

string

Organizer key

Unique identifier of the organizer

 

RegistrationSettings

Summary: Registration Settings

Description:

 

          Properties:

Name

Type

Summary

disableConfirmationEmail

boolean

Disable Confirmation Email

 

disableWebRegistration

boolean

Disable Web Registration