Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Variable

Type

Usage

Status
colourRed
titlerequired
reg Registration

UUID

Uniquely identifies a user’s instance of an activity.  This value is generated by your system and must be unique for each user’s instance of an activity (it is unique to the user and the activity). This value should NOT be regenerated each time a users launches a course.

Status
colourRed
titlerequired
em Email

varchar(255)

Status
colourRed
titlerequired
fn Full Name

varchar(255)

Use %20 to URL encoded any spaces.

Status
colourRed
titlerequired
dom Domain

varchar(255)

This is the domain that you are launching the activity from. Please include subdomains subdomain.domain.com (if applicable), but do NOT include http:// or https:// or any paths to actual pages.

Status
colourRed
titlerequired
lmsId LMS ID

varchar(255)

The value is provided in the documentation for the system you are integrating with.

...

To find the course list and LMSID for the system you are integrating with:

  1. Go to Systems,

  2. Select the system you are integrating with, and

  3. Find the section for the Course API info.

...

Confiform
formNameCoursesAPI
Confiform field definition
fieldNameSystem
valuesSafeSport for NGBs=SafeSport for NGBs - safesport.org|SafeSport for Non-NGBs=SafeSport for Non-NGBs - athletesafety.org|USA Baseball=USA Baseball - usabdevelops.com
fieldLabelSystem
fieldDescriptionSelect the system you wish to integrate with.
typeselect
requiredtrue
macroHash-7175137701711497204
Confiform field definition
fieldNameGroup
fieldLabelGroup
fieldDescriptionEnter the name of the group or organization you are representing.
typetext
requiredtrue
macroHash-1042349709
Confiform field definition
fieldNameName
fieldLabelName
typetext
requiredtrue
macroHash471297695
Confiform field definition
fieldNameEmail
fieldLabelEmail
typetext
requiredtrue
macroHash-1642978919
Confiform field definition
fieldNameNotes
fieldLabelNotes
fieldDescriptionAny additional information or notes you would like to share.
typetextarea
macroHash1354356439
Confiform field definition
fieldNameDomainProduction
fieldLabelDomain (Production)
fieldDescriptionThis is the production domain for system that you are launching the activity from. Please include subdomains subdomain.domain.com (if applicable), but do NOT include "http://" or "https://" or any paths to actual pages.
typetext
requiredtrue
macroHash-1788352879
Confiform field definition
fieldNameDomainTesting
fieldLabelDomain (Testing)
fieldDescriptionThis is the testing domain for system that you are launching the activity from. Please include subdomains subdomain.domain.com (if applicable), but do NOT include "http://" or "https://" or any paths to actual pages.
typetext
requiredtrue
macroHash-536062758

...