Administrate Developers

LMS GraphQL API Reference

Upcoming changes · Download schema

Types

Query

Root Query Type

hello : String

Returns Hello String

coursePreview : CoursePreviewConnection

Course Preview

Argument Type Description
jwt String
achievements : AchievementConnection!

Fetches a list of Achievements

Argument Type Description
filters [AchievementFieldFilter]
order AchievementFieldOrder
after String
first Int
offset Int
achievementsCount : AchievementsCount

Achievements Count

Argument Type Description
filters [AchievementFieldFilter]
trainingPassTypes : TrainingPassTypeConnection

Fetches a list of Training Pass Types

trainingRequests : TrainingRequestConnection

Fetches Training Requests

Argument Type Description
filters [TrainingRequestFieldFilter]
order TrainingRequestFieldOrder
after String
first Int
offset Int
portalCustomFieldTemplates : [PortalCustomFieldTemplate]

Fetches Portal Custom Field Templates

Argument Type Description
type SupportsCustomFieldPortalEntities
registerables : RegisterableConnection

Fetches Registerables

Argument Type Description
filters [RegisterableFieldFilter]
order RegisterableFieldOrder
after String
first Int
offset Int
registerablesCount : RegisterablesCount

Registerables Count

Argument Type Description
filters [RegisterableFieldFilter]
registrations : RegistrationConnection

Fetches Registrations

Argument Type Description
filters [RegistrationFieldFilter]
order RegistrationFieldOrder
after String
first Int
offset Int
registrationsWithProgress : RegistrationWithProgressConnection

Fetches Registrations with Progress

Argument Type Description
filters [RegistrationFieldFilter]
order RegistrationFieldOrder
after String
first Int
offset Int
events : EventConnection

Fetches Events

Argument Type Description
filters [EventFieldFilter]
order EventFieldOrder
first Int
offset Int
after String
viewer : Viewer

Fetches information about the currently logged in user

portalForHost : Portal

Fetches a Portal for a specified Host URL

Argument Type Description
host URL
categories : CategoryConnection

Fetches Categories

catalogue : CatalogueConnection

Query a Catalogue of Items to Sell

Argument Type Description
filters [CatalogueFieldFilter]
order CatalogueFieldOrder
after String
first Int
offset Int
cancellationReasons : CancellationReasonConnection

Fetches a list of Cancellation Reasons

Argument Type Description
filters [CancellationReasonFieldFilter]
order CancellationReasonFieldOrder
after String
first Int
offset Int
cancellationRequests : CancellationRequestConnection

Fetches a list of Cancellation Requests

Argument Type Description
filters [CancellationRequestFieldFilter]
order CancellationRequestFieldOrder
after String
first Int
offset Int
coordinatorManagedAccounts : AccountConnection!

Fetches the Accounts that the Coordinator is responsible for

Argument Type Description
filters [AccountFieldFilter]
order AccountFieldOrder
after String
first Int
offset Int
coordinatorManagedContacts : ContactConnection!

Fetches the Contacts belonging to the Accounts that the Coordinator is responsible for

Argument Type Description
filters [ContactFieldFilter]
order ContactFieldOrder
after String
first Int
offset Int
pointOfSaleLearnerFields : [PointOfSaleLearnerFieldDefinition!]

Fetches a list of Point of Sale Learner Fields

Argument Type Description
entityType PointOfSaleFieldEntityType
filters [PointOfSaleFieldFilter]
contentAndRegistrationDetails : ContentAndRegistration

Content and Registration

Argument Type Description
contentId ID
trainingTokenIssues : TrainingTokenIssueConnection

Fetches a list of Training Token Issues

tokenIssueTransactions : TokenIssueTransactions

Fetches a list of Training Token Transactions

Argument Type Description
tokenIssueId ID
order TokenIssueTransactionFieldOrder
after String
first Int
offset Int
Back to top

Mutation

Root Mutation Type

attempt : AttemptMutations

Available Mutations on an Attempt

registration : RegistrationMutations

Available Mutations on a Registration

registerable : RegisterableMutations

Available Mutations on a Registerable

viewer : ViewerMutations

Available Mutations on a Viewer

viewerCredentials : ViewerCredentialsMutations

Available Mutations on Viewer Credentials

trainingRequest : TrainingRequestMutations

Available Mutations for Training Requests

cancellationRequest : CancellationRequestMutations

Mutations available for a Cancellation Request

contact : ContactMutations

Mutations for Contacts

Back to top

Account

An organisation which groups Contacts together

id : ID!

ID of the Account

name : String!

Name of the Account

ancestors : [AccountAncestor!]!

A list of Account ancestors for this account

Back to top

AccountAncestor

An Account Ancestor

id : ID!

ID of the Account Ancestor

name : String!

Name of the Account Ancestor

Back to top

AccountConnection

A paginated Account list related to the Node

pageInfo : PageInfo!

Information regarding the pagination of the list

edges : [AccountEdge!]!

The paginated list of relationships

Back to top

AccountEdge

an Edge type describes the connection between the node and its parent

cursor : String!

An opaque string that indicates a specific point in paginating through a list

node : Account!

The Account involved in the relationship

Back to top

AccountField

Fields for filtering and ordering an Account list

id

The ID of the Account

name

The name of the Account

Back to top

AccountFieldFilter

Used to filter an Account List

value : String

Value to filter the list

field : AccountField

Name of the field to filter the list

operation : FilterOperation

The method to compare the value to filter the list

Back to top

AccountFieldOrder

Used for ordering the results by a specific field and direction

field : AccountField

Name of the field to order by

direction : OrderDirection

Direction to order by

Back to top

Achievement

An Achievement

Related types: Node

id : ID!

The ID of the Achievement

achievementType : AchievementType

The Achievement Type linked to the Achievement

achievedAt : Datetime

The date and time this Achievement was created

expiresAt : Datetime

The date this Achievement expires

lifecycleState : AchievementState

The Lifecycle State of the Achievement

registerable : Registerable

The Registerable associated to the Achievement

identifier : String

The string identifier of the Achievement

certificateUrl : String

URL to the Certificate

documentUrls : [String]

List of Document URLs

documentIds : [ID]

List of Document IDs

Back to top

AchievementConnection

A paginated Achievement list related to the Node

pageInfo : PageInfo!

Information regarding the pagination of the list

edges : [AchievementEdge!]!

The paginated list of relationships

Back to top

AchievementEdge

an Edge type describes the connection between the node and its parent

cursor : String!

An opaque string that indicates a specific point in paginating through a list

node : Achievement!

The Achievement involved in the relationship

Back to top

AchievementField

Fields for filtering and ordering an Achievement list

id

The ID of the Achievement

expiresAt

The date this Achievement expires

achievementTypeName

The name of the Achievement Type linked to the Achievement

Back to top

AchievementFieldFilter

Used to filter an Achievement List

value : String

Value to filter the list

field : AchievementField

Name of the field to filter the list

operation : FilterOperation

The method to compare the value to filter the list

Back to top

AchievementFieldOrder

Used for ordering the results by a specific field and direction

field : AchievementField

Name of the field to order by

direction : OrderDirection

Direction to order by

Back to top

AchievementsCount

Count of Achievements

count : Int

Count of Achievements

Back to top

AchievementState

State of an Achievement

active

Active Achievement

revoked

Revoked Achievement

expired

Expired Achievement

Back to top

AchievementType

An Achievement Type

Related types: Node

id : ID

The ID of the Achievement Type

name : String

The name given to the Achievement Type

certificateType : CertificateType

The Certificate Type associated with the Achievment Type

Back to top

AssociateUnnamedLearnerWithContactsInput

An input to associate Contacts with an Unnamed Learner

registrationId : ID!

The ID of the Unnamed Learner with which to associate the Contacts

contactIds : [ID!]!

A list of Contact IDs to associate this Registration with

Back to top

AssociateUnnamedLearnerWithContactsResponseType

A response from associating an Unnamed Learner with Contacts

registrations : [Registration]

The Registrations that were associated with existing Contacts

errors : [FieldError]

The errors returned by the mutation

Back to top

Attempt

An Attempt

id : ID!

ID of the Attempt

registration : Registration!

Registration linked to the Attempt

content : ExternalContentResult!

The Attempts Content

accompanyingDocumentation : String

Any accompanying documentation on the Attempt

Back to top

AttemptMutateResponseType

A Response from mutating an Attempt

errors : [FieldError!]!

The errors returned by the mutation

attempt : Attempt

The Attempt that was mutated

Back to top

AttemptMutations

Attempt Mutations

recordExternalProgress : AttemptMutateResponseType

Mutations for Attempts

Argument Type Description
input RecordExternalProgressInput

Records a Learners progress through a piece of External Content
Back to top

AttemptScormContentInput

An input for recording a SCORM attempt

registrationId : ID

The ID of the Registration attempting the SCORM Content

contentId : ID

The ID of the SCORM Content being attempted

Back to top

Attendance

Details about a learners attendance

sessionDetail : SessionDetailConnection

A summary of sessiosn for this Learner

sessionsAttended : Int

The number of sessions the Learner has attended

sessionsMissed : Int

The number of sessions the Learner has missed

totalSessions : Int

The total number of sessions for this Learner

Back to top

Boolean

The Boolean scalar type represents true or false.

Back to top

Brand

A Contact facing identity used with Portals such as LMS and Weblink

id : ID

The ID of this Brand

name : String

The name of this Brand

branding : Branding

The elements used to define this Brand's visual identity

singleSignOnOnly : Boolean!

Indicates if Contacts can log into this Portal only by Single Sign On

welcomeMessage : WelcomeMessage

A Welcome Message associated to this Brand

Back to top

Branding

A collection of elements used to define a Brand's visual identity

images : BrandingImages

The Images used by this Branding

colours : BrandingColours

The Colours used by this Branding

buttons : BrandingButtons

The Button options used by this Branding

Back to top

BrandingButtons

Settings that define Branding Buttons

borderRadius : String

The border radius on Buttons that have this Branding applied

Back to top

BrandingColours

A collection of Colours that are part of a Branding

contrastText : Colour

The text Color used on color branded backgrounds like title bars

mainText : Colour

The text Color used on light backgrounds like the Course description and Event lists

navigationBackground : Colour

The Background Color used on Page Navigation Bars

navigationButtonText : Colour

The text Color used on buttons within the Navigation Bar

primary : Colour

The primary Branding Color used as a highlight and selection Colour

primaryActionButton : Colour

The background Color used on primary actions, like the checkout button

primaryActionButtonText : Colour

The text Color used on primary actions, like the checkout button

secondary : Colour

The secondary Branding Color

secondaryActionButton : Colour

The background Color used on secondary actions, like the cancel button

secondaryActionButtonText : Colour

The text Color used on secondary actions, like the cancel button

Back to top

BrandingImage

Settings that define a Branding Image

imageUrl : String

The URL of the image

Back to top

BrandingImages

A collection of Images that are part of a Branding

favicon : BrandingImage

The favicon Image displayed in browser tabs that have this Branding applied

Back to top

CancellationReason

A cancellation Reason

Related types: Node

id : ID

The ID of the Cancellation Reason

text : String

The Text for the Cancellation Reason

Back to top

CancellationReasonConnection

A paginated CancellationReason list related to the Node

pageInfo : PageInfo

Information regarding the pagination of the list

edges : [CancellationReasonEdge]

The paginated list of relationships

Back to top

CancellationReasonEdge

an Edge type describes the connection between the node and its parent

cursor : String

An opaque string that indicates a specific point in paginating through a list

node : CancellationReason

The Cancellation Reason involved in the relationship

Back to top

CancellationReasonField

Fields for filtering and ordering a CancellationReason list

id

The ID of the Cancellation Reason

Back to top

CancellationReasonFieldFilter

Used to filter a CancellationReason List

value : String

Value to filter the list

field : CancellationReasonField

Name of the field to filter the list

operation : FilterOperation

The method to compare the value to filter the list

Back to top

CancellationReasonFieldOrder

Used for ordering the results by a specific field and direction

field : CancellationReasonField

Name of the field to order by

direction : OrderDirection

Direction to order by

Back to top

CancellationRequest

A cancellation request

Related types: Node

id : ID

The ID of the Cancellation Request

registerableId : ID

Registerable ID

approvalState : String

The Approval State of the Cancellation Request

learner : String

The Learner linked to the Cancellation Request

reason : String

The Reason for the Cancellation Request

reasonNotes : String

The note that accompanies the above Reason for the Cancellation Request

createdAt : Datetime

When the Cancellation Request was created

updatedAt : Datetime

The last time the Cancellation Request was updated

event : Event

The Event on the Cancellation Request

Back to top

CancellationRequestConnection

A paginated CancellationRequest list related to the Node

pageInfo : PageInfo

Information regarding the pagination of the list

edges : [CancellationRequestEdge]

The paginated list of relationships

Back to top

CancellationRequestEdge

an Edge type describes the connection between the node and its parent

cursor : String

An opaque string that indicates a specific point in paginating through a list

node : CancellationRequest

The Cancellation Request involved in the relationship

Back to top

CancellationRequestField

Fields for filtering and ordering a CancellationRequest list

id

The ID of the Cancellation Request

contactId

The ID of the Contact requesting the cancellation

brandId

The ID of the Brand of the Cancellation Request

approvalState

The Approval State of the Cancellation Request

Back to top

CancellationRequestFieldFilter

Used to filter a CancellationRequest List

value : String

Value to filter the list

field : CancellationRequestField

Name of the field to filter the list

operation : FilterOperation

The method to compare the value to filter the list

Back to top

CancellationRequestFieldOrder

Used for ordering the results by a specific field and direction

field : CancellationRequestField

Name of the field to order by

direction : OrderDirection

Direction to order by

Back to top

CancellationRequestMutations

Mutations available for Cancellation Request

create : CreateCancellationRequestMutationResponseType

Creates a Cancellation Request

Argument Type Description
input CreateCancellationRequestInputType
Back to top

CatalogueConnection

A paginated Catalogue list related to the Node

pageInfo : PageInfo

Information regarding the pagination of the list

edges : [CatalogueEdge]

The paginated list of relationships

Back to top

CatalogueEdge

an Edge type describes the connection between the node and its parent

cursor : String

An opaque string that indicates a specific point in paginating through a list

node : CatalogueItem

The Catalogue Item involved in the relationship

Back to top

CatalogueField

Fields for filtering and ordering a Catalogue list

id

The ID of the Catalogue Item

learningCategoryId

The ID of a Category to which the Catalogue Item belongs

type

The type of training the Catalogue Item represents

name

The name of the Catalogue Item

Back to top

CatalogueFieldFilter

Used to filter a Catalogue List

value : String

Value to filter the list

field : CatalogueField

Name of the field to filter the list

operation : FilterOperation

The method to compare the value to filter the list

Back to top

CatalogueFieldOrder

Used for ordering the results by a specific field and direction

field : CatalogueField

Name of the field to order by

direction : OrderDirection

Direction to order by

Back to top

CatalogueItem

A thing that is available to be sold

id : ID

The ID of the Catalogue Item

name : String

The name of the Catalogue Item

category : Category

Category

code : String

Code

teaserDescription : String

Teaser Description

description : String

Description

prerequisites : String

Prerequisites

topicsCovered : String

Topics Covered

faqs : String

FAQs

outcomes : String

Outcomes

imageUrl : String

Image URL

Back to top

Category

A Category for Courses and Learning Paths

id : ID

ID for the Category

name : String

Name for the Category

subcategories : SubcategoryConnection

A list of Subcategories for the Category

Back to top

CategoryConnection

A paginated Cateogry list related to the Node

edges : [CategoryEdge]

The paginated list of relationships

Back to top

CategoryEdge

an Edge type describes the connection between the node and its parent

node : Category

The Category involved in the relationship

Back to top

CertificateType

A Certificate Type

Related types: Node

id : ID!

The ID of the Certificate Type

name : String!

The name of the Certificate Type

Back to top

Colour

A hexidecimal code of format #RRGGBB that represents a colour

Back to top

Comment

Comment made by a Learner on LMS content

id : ID!

The Document ID

comment : String!

The text of the Comment

createdAt : Datetime!

The Date and Time the Comment was created

contact : Contact!

The Contact for the user that created the Comment

Back to top

CommentConnection

A paginated Comment list related to the Node

pageInfo : PageInfo!

Information regarding the pagination of the list

edges : [CommentEdge!]!

The paginated list of relationships

Back to top

CommentEdge

an Edge type describes the connection between the node and its parent

cursor : String!

An opaque string that indicates a specific point in paginating through a list

node : Comment!

The Comment involved in the relationship

Back to top

CommentField

Fields for filtering and ordering a Comment list

comment

The text of the Comment

createdAt

The Date and Time the Comment was created

Back to top

CommentFieldFilter

Used to filter a Comment List

value : String

Value to filter the list

field : CommentField

Name of the field to filter the list

operation : FilterOperation

The method to compare the value to filter the list

Back to top

CommentFieldOrder

Used for ordering the results by a specific field and direction

field : CommentField

Name of the field to order by

direction : OrderDirection

Direction to order by

Back to top

Contact

A person/individual

id : ID!

ID of the Contact

firstName : String!

The first name of the Contact

lastName : String!

The last name of the Contact

emailAddress : String

Primary email address of the Contact

jobRole : String

The job role of the Contact

faxPhoneNumber : String

The fax phone number of the Contact

homePhoneNumber : String

The home phone number of the Contact

mobilePhoneNumber : String

The mobile phone number of the Contact

officePhoneNumber : String

The office phone number for the Contact

department : String

The department of the Contact

postalAddress : PostalAddress

Postal Address of the Contact

account : Account!

Primary Account the Contact belongs to

managedAccounts : AccountConnection!

The Accounts the Contact is responsible for

Argument Type Description
filters [AccountFieldFilter]
order AccountFieldOrder
after String
first Int
offset Int
registrations : RegistrationConnection!

Registrations for the Contact

Argument Type Description
filters [RegistrationFieldFilter]
order RegistrationFieldOrder
after String
first Int
offset Int
learningPathRegistrations : LearningPathRegistrationConnection!

Learning Path Registrations for the Contact

Argument Type Description
filters [LearningPathRegistrationFieldFilter]
order LearningPathRegistrationFieldOrder
after String
first Int
offset Int
phoneNumbers : [ContactPhoneNumber]

The list of Phone Numbers for the Account

isCoordinator : Boolean!

A coordinator for any Account

customFieldValues : [ContactCustomFieldValue]

Custom Field Values for the Account

isOverlappingCoordinator : Boolean!

A coordinator managing at least one Account the current Viewer manages

Back to top

ContactConnection

A paginated Contact list related to the Node

pageInfo : PageInfo!

Information regarding the pagination of the list

edges : [ContactEdge!]!

The paginated list of relationships

Back to top

ContactCoordinatorInput

An input to make or revoke a Contact a Coordinator for specific accounts

accountIds : [ID!]

The Account IDs being added or removed

contactId : ID!

The Contact ID of the Coordinator

Back to top

ContactCreateInput

An input for creating a Contact

accountId : ID!

The account ID that the Contact belongs to

personalName : PersonalNameInputType!

The personal name of the Contact

jobRole : String

The job role of the Contact

phoneNumbers : [ContactPhoneNumberInputType]

The list of Phone Numbers of the Contact

emailAddresses : [ContactEmailAddressesInputType]

The list of Email Addresses of the Contact

postalAddress : PostalAddressInput

The postal address of the Contact

Back to top

ContactCustomFieldValue

The custom field set in System

definitionKey : String

The identifier of the Custom Field Definition

value : String

The value stored

Back to top

ContactEdge

an Edge type describes the connection between the node and its parent

cursor : String!

An opaque string that indicates a specific point in paginating through a list

node : Contact!

The Contact involved in the relationship

Back to top

ContactEmailAddressesInputType

An input for an email address of a Contact

usage : ContactEmailAddressUsage

The ContactEmailAddressUsage of the Email Address being mutated

address : String

The email address

Back to top

ContactEmailAddressUsage

The usages of an email address on a Contact

primary

The primary email address for the Contact

secondary

The secondary email address for the Contact

Back to top

ContactField

Fields for filtering and ordering a Contact list

accountId

The ID of the Primary Account to which the Contact belongs

emailAddress

The primary email address of the Contact

firstName

The first name of the Contact

id

The ID of the Contact

isCoordinator

Denotes if the Contact is a Coordinator for any Account

lastName

The last name of the Contact

name

The full name of the Contact

isOverlappingCoordinator

Denotes if the Contact coordinates at least one Account that the current Viewer also coordinates

Back to top

ContactFieldFilter

Used to filter a Contact List

value : String

Value to filter the list

field : ContactField

Name of the field to filter the list

operation : FilterOperation

The method to compare the value to filter the list

Back to top

ContactFieldOrder

Used for ordering the results by a specific field and direction

field : ContactField

Name of the field to order by

direction : OrderDirection

Direction to order by

Back to top

ContactMutateResponseType

A response from mutating a Contact

contact : Contact

The Contact that was mutated

errors : [FieldError]

The errors returned by the mutation

Back to top

ContactMutations

Mutations for Contacts

update : ContactMutateResponseType

Updates the Contact

Argument Type Description
input ContactUpdateInput
create : ContactMutateResponseType

Creates a Contact

Argument Type Description
input ContactCreateInput
makeCoordinatorForAccounts : ContactMutateResponseType

Makes a Contact a Coordinator for the supplied Accounts

Argument Type Description
input ContactCoordinatorInput
revokeCoordinatorForAccounts : ContactMutateResponseType

Revoke Coordinator rights for a Contact for the supplied Accounts

Argument Type Description
input ContactCoordinatorInput
Back to top

ContactPhoneNumber

A Phone Number for a Contact

usage : ContactPhoneNumberUsage

The usage of the phone number

number : String

The phone number

Back to top

ContactPhoneNumberInputType

An input for a phone number for a Contact

usage : ContactPhoneNumberUsage

The ContactPhoneNumberUsage of the PhoneNumber being mutated

number : String

The phone number

Back to top

ContactPhoneNumberUsage

Contact Phone Number Usage

fax

A phone number to be used for faxing

home

A phone number for the Contact's home

mobile

A phone number for the Contact's mobile/cell phone

office

A phone number for the Contact's office

Back to top

ContactUpdateInput

An input for updating a Contact

contactId : ID!

The ID of the Contact being updated

personalName : PersonalNameInputType

New Personal Name

accountId : ID

The accountID for this Contact

jobRole : String

The new job role of the Contact

phoneNumbers : [ContactPhoneNumberInputType]

The list of Phone Numbers of the Contact being added or updated

postalAddress : PostalAddressInput

The postal address of the Contact

Back to top

Content

Substantive information or creative material to aid training

Related types: Document Separator Video Scorm ExternalActivity KryterionActivity DiscussionTopic

id : ID

ID of the Content

displayName : String

The main display name of the content

htmlDescription : String

Optional description of Content. Contains HTML.

isRequired : Boolean

Whether or not the Content is required for the Learner to complete the Event

isPublic : Boolean

Public content can be displayed to annonymous users for free

order : Int

The order in which the Content should be displayed

type : String

Type of Content

autoComplete : Boolean

Flag indicating if the content should be auto completed on learner access

isPremium : Boolean

If the content requires a Training Pass to access it

includedInPassTypeIds : [ID]

List of Training Pass Type IDs that grant access to this content

Back to top

ContentAndRegistration

Content and Registration

content : Content

The details of the Content

registration : RegistrationDetails

The details of the Registration

Back to top

ContentConnection

A paginated Content list related to the Node

pageInfo : PageInfo

Information regarding the pagination of the list

edges : [ContentEdge]

The paginated list of relationships

Back to top

ContentEdge

an Edge type describes the connection between the node and its parent

cursor : String

An opaque string that indicates a specific point in paginating through a list

node : Content

The Content involved in the relationship

Back to top

ContentResult

A Result for a Learner on a piece of Content

Related types: ScormContentResult VideoContentResult ExternalContentResult ResourceContentResult

id : ID

The ID of the ContentResult

contentId : ID

The ID to the piece of Content this result relates to

content : Content

The Content this result relates to

attempts : Int

The attempts on this Content

completedAttempts : Int

The number of completed attempts the Learner has had on this Content

progress : Decimal

The percentage complete the Learner has achieved on the Content

score : Decimal

The score the Learner has achieved on the Content

scorePercent : Decimal

The score percent the Learner has achieved on the Content

lastAccessed : Datetime

The date and time when the Content was last accessed

status : ContentResultStatus

The current status of the Content

Back to top

ContentResultConnection

A paginated ContentResult list related to the Node

pageInfo : PageInfo

Information regarding the pagination of the list

edges : [ContentResultEdge]

The paginated list of relationships

Back to top

ContentResultEdge

an Edge type describes the connection between the node and its parent

cursor : String

An opaque string that indicates a specific point in paginating through a list

node : ContentResult

The Content Result involved in the relationship

Back to top

ContentResultField

Fields for filtering and ordering a ContentResult list

contentId

The ID to the piece of Content this result relates to

Back to top

ContentResultFieldFilter

Used to filter a ContentResult List

value : String

Value to filter the list

field : ContentResultField

Name of the field to filter the list

operation : FilterOperation

The method to compare the value to filter the list

Back to top

ContentResultFieldOrder

Used for ordering the results by a specific field and direction

field : ContentResultField

Name of the field to order by

direction : OrderDirection

Direction to order by

Back to top

ContentResultStatus

Statuses for Content Results

completed

The Content was completed

downloaded

The Content has been downloaded

failed

The Content was failed

incomplete

The Content has not been completed

passed

The Content was passed

Back to top

Country

A nation with a designated ISO country code

id : ID

The ID of the Country

code : String

ISO designated country code

name : String

Name of the Country

Back to top

Course

The instance of training at a set time and location

Related types: Node

id : ID!

ID of the Course

title : String!

Title of the Course

code : String

Course Code

learningMode : LearningMode

The form the training takes for instance classroom or blended

start : Datetime

The date and time the Course starts

startDate : Datetime

The date the Course starts

end : Datetime

The date and time the Course ends

endDate : Datetime

The date the Course ends

lmsStart : Datetime

The starting date and time when the LMS access or self paced learning is scheduled to open

lmsEnd : Datetime

The ending date and time when the LMS access or self paced learning is scheduled to close

imageUrl : String

URL for the Course Image

message : String

The message for the Course

resources : [CourseResource!]!

Resources on the Course

categories : CategoryConnection

Categories the Course is in

location : Location

Location at which the Course takes place

remainingPlaces : Int

Number of Learner places remaining on the Course

accessDuration : Int

The number of days the self-paced Course is accessible for

achievementTypes : [AchievementType]

The Achievement Types for this Course

sessions : SessionsConnection

Sessions that belong to the Course

content : ContentConnection

Content that belongs to the Course

Argument Type Description
after String
first Int
offset Int
learnerId String
documents : [DmsDocument!]!

Documents mapped to this Course

lmsAnnouncements : String

The Course LMS Announcements/Notes

allowedMissedSessions : Int

The number of missed sessions a Learner is allowed to qualify as Passed upon Event completion

instructors : [Instructor!]!

The Instructors for the Event

Deprecated fields (1)
achievementType : AchievementType

Removal date: 2025-07-21.

This field is no longer used. Please use "achievementTypes".

Back to top

CourseObjective

A Course Objective on a Learning Path

Related types: Node LearningObjective

id : ID

ID of the Course Objective

order : Int

The order of this Learning Objective in the set of Learning Path Objectives

credits : Int

The number of Credits that this Learning Objective represents

expectedCompletionDays : Decimal

The expected required time in days to complete the Learning Objective

group : LearningObjectiveGroup

The option group this objective belongs to, or null if it is not part of a group

course : Course

The Course used for this Objective

selectableEvents : [Event]

A restricted list of Events that can be selected to fulfil the Objective. An empty list signifies that any Event for the Objective's Course can be selected.

Back to top

CourseOutcome

The Outcome from the Course Objective

Related types: Node LearningPathResult

id : ID

ID for the Course Outcome

order : Int

The order of this Outcome in the set of Learning Assignment Outcomes

credits : Int

The number of credits that the Outcome represents

completed : Boolean

Denotes whether or not the Outcome has been completed by the Learner

objectiveId : ID

The ID of the Objective to which the Outcome refers

course : Course

The Course to which the Outcome refers to

registrationId : ID

Course Outcome Registration ID

Back to top

CoursePreviewConnection

A paginated Registration list to be previewed during Event configuration

pageInfo : PageInfo

Information regarding the pagination of the list

edges : [RegistrationEdge]

The paginated list of relationships

Back to top

CourseResource

A Resource for the Course

label : String!

Label of the Resource

Back to top

CreateCancellationRequestInputType

An Input to create a Cancellation Request

learnerId : ID

ID of the Learner on the Cancellation Request

reasonId : ID

ID of the Reason why the Cancellation is being Requested

reasonNotes : String

Notes on the Cancellation Reason

Back to top

CreateCancellationRequestMutationResponseType

The response from Creating a Cancellation Request

cancellationRequest : CancellationRequest

The newly created Cancellation Request

errors : [FieldError]

Errors from the mutation

Back to top

CreateTrainingRequestInputType

Create a new Training Request Opportunity

trainingRequestItemId : ID

Training Request Item ID

pointOfSaleFieldValues : [PointOfSaleFieldValueType!]

Point of Sale Field Values

Back to top

CustomFieldValueInputType

An Input for Custom Field Value

definitionKey : ID

The identifier for the CustomFieldDefinition of the CustomFieldValue being mutated

value : String

The new value of the CustomFieldValue. Defining this as null will set the value to null

Back to top

Datetime

A datetime as an ISO 8601 formatted string

Back to top

Decimal

A fixed-point number as an integer and fractional part String

Back to top

DeleteDiscussionCommentInput

An input for deleting a Discussion Comment

commentId : ID!

The ID of the Discussion Comment to be deleted

Back to top

DeliveryMethod

The form the training takes

lms

The training is delivered through an LMS

classroom

The training is delivered in a classroom

blended

The training is delivered in part in a classroom, and in part through an LMS

Back to top

DiscussionTopic

A type of content on an Event that allows Learners to post comments related to the Event which can be seen by other Learners registered to the Event

Related types: Node Content

id : ID!

The ID of the DiscussionTopic

displayName : String

The main display name of the Content

htmlDescription : String

The description of the Content. Contains HTML.

isRequired : Boolean

Whether or not the Content is required for the Learner to complete the Event

isPublic : Boolean

Public Content can be displayed to annonymous users for free

order : Int!

The order in which the Content should be displayed

type : String!

The Content type

comments : CommentConnection!

The Comments posted to the DiscussionTopic

Argument Type Description
filters [CommentFieldFilter]
order CommentFieldOrder
after String
first Int
offset Int
autoComplete : Boolean

Flag indicating if the Content should be auto completed on Learner access

isPremium : Boolean

Flag indicating if the content requires a Training Pass to access it

includedInPassTypeIds : [ID]

List of Training Pass Type IDs that grant access to this Content

Back to top

DmsDocument

Document stored in the DMS

id : ID

DMS Document ID

name : String

DMS Document Name

description : String

DMS Document Description

fileSizeStr : String

The size of this Document in bytes. Returned as string, to allow universal support for values larger than 2 gigabytes.

identifyingHash : String

An identifier used to fetch the Document Revision from the DMS.

Deprecated fields (1)
fileSize : Int

Removal date: 2024-04-03.

This field does not support values larger than 2 gigabytes. Please use "fileSizeStr".

Back to top

Document

Content in the form of a Document

Related types: Node Content

id : ID

ID of the Document

displayName : String

The main display name of the Content

htmlDescription : String

Description of Content. Contains HTML.

order : Int

The order in which the Content should be displayed

type : String

Type of the Content

identifyingHash : String

An identifier used to fetch the Document Revision

fileSizeStr : String

The size of this Document Revision in bytes. Returned as string, to allow universal support for values larger than 2 gigabytes.

isRequired : Boolean

Whether or not the Content is required for the Learner to complete the Event

isPublic : Boolean

Public Content can be displayed to annonymous users for free

originalExtension : String

The original extension of the file, without the dot

autoComplete : Boolean

Flag indicating if the content should be auto completed on Learner access

isPremium : Boolean

Flag indicating if the content requires a Training Pass to access it

includedInPassTypeIds : [ID]

List of Training Pass Type IDs that grant access to this content

Deprecated fields (1)
fileSize : Int

Removal date: 2024-04-03.

This field does not support values larger than 2 gigabytes. Please use "fileSizeStr".

Back to top

DocumentObjective

A Document Objective on a Learning Path

Related types: Node LearningObjective

id : ID

ID of the Document Objective

order : Int

The order of this Learning Objective in the set of Learning Path Objectives

credits : Int

The number of credits this Learning Objective represents

expectedCompletionDays : Decimal

The expected required time in days to complete the learning objective

group : LearningObjectiveGroup

The option group this objective belongs to, or null if it is not part of a group

document : Document

The document that must be accessed to complete this objective

Back to top

DocumentOutcome

The Outcome from the Document Objective

Related types: Node LearningPathResult

id : ID

ID for the Document Outcome

order : Int

The order of this Outcome in the set of Learning Assignment Outcomes

credits : Int

The number of credits that the Outcome represents

completed : Boolean

Denotes whether or not the Outcome has been completed by the Learner

objectiveId : ID

The ID of the Learning Objective to which the Outcome refers

document : Document

The Document to which this Outcome refers to

Back to top

EnsureKryterionAccountInput

An input for creating an external Kryterion resource

registrationId : ID

The ID of the Registration for which to create a Kryterion Account

contentId : ID

The ID of the Kryterion Activity

Back to top

EnsureKryterionAccountResponseType

The Response for a Kryterion resource creation

registration : Registration

The Learner for which we have created a Kryterion Account

kryterionAccountExists : Boolean

Boolean indicating whether a Kryterion Account exists for the Registration

errors : [FieldError]

The errors returned by the mutation

Back to top

Event

The instance of training covering a particular course at a set time and location

id : ID

ID of the Event

code : String

Code for the Event

name : String

Name of the Event

deliveryMethod : DeliveryMethod

The form the training takes

location : Location

Location at which the Event takes place

start : String

The date and time the Event starts

end : String

The date and time the Event ends

timeZoneName : String

The time zone in which the dates and times of the Event are scheduled

remainingPlaces : Int

Number of places remaining on the Event

accessDuration : Int

The number of days this Event is accessible for

classroomStart : String

The starting date and time of the earliest, active classroom Session for the Event

classroomEnd : String

The ending date and time of the latest, acitve classroom Session for the Event

lmsStart : String

The starting date and time when the LMS access or self paced learning is scheduled to open

lmsEnd : String

The ending date and time when the LMS access or self paced learning is scheduled to close

imageHash : String

Hash for the Event Image

lifecycleState : String

The state of the Event in its lifecycle

documents : [DmsDocument!]!

Documents mapped to this Event

lmsAnnouncements : String

The Event LMS Announcements/Note

instructors : [Instructor!]!

The Instructors for the Event

Back to top

EventConnection

A paginated Event list related to the Node

pageInfo : PageInfo

Information regarding the pagination of the list

edges : [EventEdge]

The paginated list of relationships

Back to top

EventEdge

an Edge type describes the connection between the node and its parent

cursor : String

An opaque string that indicates a specific point in paginating through a list

node : Event

The Event involved in the relationship

Back to top

EventField

Fields for filtering and ordering an Event list

id

The ID of the Event

title

The title of the Event

courseCode

The Code of the Course Template used to create this Event

start

The date and time the Event starts

registerBy

The cut off date and time for registering onto an event

timeZonedStart

The date and time the Event starts with timezone information

lifecycleState

The state of the Event in its lifecycle

remainingPlaces

The remaining places on the Event

Back to top

EventFieldFilter

Used to filter an Event List

value : String

Value to filter the list

field : EventField

Name of the field to filter the list

operation : FilterOperation

The method to compare the value to filter the list

Back to top

EventFieldOrder

Used for ordering the results by a specific field and direction

field : EventField

Name of the field to order by

direction : OrderDirection

Direction to order by

Back to top

ExternalActivity

Content in the form of an External Activity

Related types: Node Content

id : ID

ID of the External Activity

displayName : String

The main display name of the External Activity

htmlDescription : String

Description of the External Activity. Contains HTML.

externalActivityUrl : String

URL for the Learner to engage with the External Activity

isRequired : Boolean

Whether or not the External Activity is required for the Learner to complete the Event.

isPublic : Boolean

Public Content can be displayed to annonymous users for free

order : Int

The order in which the Content should be displayed

type : String

Type of the Content

autoComplete : Boolean

Flag indicating if the External Activity should be auto completed on Learner access

isPremium : Boolean

Flag indicating if the content requires a Training Pass to access it

includedInPassTypeIds : [ID]

List of Training Pass Type IDs that grant access to this content

Back to top

ExternalActivityStatus

An enumeration of statuses of External Activities

completed

The External Activity was completed

passed

The External Activity was passed

failed

The External Activity was failed

Back to top

ExternalAttempt

Data on the attempt of an External Activity

Related types: Node

id : ID

ID of the Attempt

accompanyingDocumentation : String

Accompanying documentation that is stored along with the progress of this External Activity

Back to top

ExternalContentResult

A summary of results for a Learner on a piece of External Content

Related types: Node ContentResult

id : ID

The ID of the Content

contentId : ID

The ID to the piece of Content this result relates to

content : Content

The Content this result relates to

attempts : Int

The Learner attempts on the Content

completedAttempts : Int

The number of complete attempts the Learner has had on this Content

progress : Decimal

The percentage complete the Learner has achieved on the Content

score : Decimal

The score the learner has achieved on the Content

scorePercent : Decimal

The score percent the Learner has achieved on the Content

lastAccessed : Datetime

The date and time when the Content was last accessed

status : ContentResultStatus

The current status of the Content

latestAttempt : ExternalAttempt

Information on the last attempt the Learner made on the External Activity

Back to top

ExternalObjective

An External Objective on a Learning Path

Related types: Node LearningObjective

id : ID

ID of the External Objective

order : Int

The order of this Learning Objective in the set of Learning Path Objectives

credits : Int

The number of credits that this Learning Objective represents

expectedCompletionDays : Decimal

The expected required time in days to complete the Learning Objective

group : LearningObjectiveGroup

The option group this objective belongs to, or null if it is not part of a group

external : String

External Objective

name : String

External Objective name

Back to top

ExternalOutcome

The Outcome from the External Objective

Related types: Node LearningPathResult

id : ID

ID for the External Outcome

order : Int

The order of this Outcome in the set of Learning Assignment Outcomes

credits : Int

The number of credits that the Outcome represents

completed : Boolean

Denotes whether or not the outcome has been completed by the Learner

objectiveId : ID

The ID of the Objective to which the Outcome refers

external : String

The External Activity to which the Outcome refers to

Back to top

FieldError

An error returned specific to a field

label : String

Attribute to which the error relates

value : String

Error message and resolution hint

message : String

Value that triggered the error

Back to top

FilterOperation

Used to limit results returned eq - Equals ge - Greater than or Equal to gt - Greater Than like - Like le - Less than or Equal to lt - Less Than ne - Not Equal isnull - Is Null notnull - Is Not Null wordlike - Match a word/expression while excluding punctuations and case sensitivity in - Match any of a list of values contains - Matches a subset of values notin - Does not match any of a list of values

eq

Field must be equal to value.

ge

Field must be greater than or equal to value.

gt

Field must be greater than value.

like

Field must be like value, % is any String.

le

Field must be less than or equal to value.

lt

Field must be less than value.

ne

Field must not equal value.

Back to top

FulfilObjectiveInput

An input for fulfilling an objective on a Learning Path

eventId : ID

The Event that will fulfil this Objective

learningPathRegistrationId : ID

The Learning Path Registration whose Objective will be fulfilled

objectiveId : ID

The Learning Path Objective to be fulfilled

Back to top

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Back to top

IdentityProvider

An Identity Provider e.g. an OAuth2 or SAML service

name : String

The name of this Identity Provider

singleSignOnInitiateEndpoint : String

The endpoint on the SSO service to use to initiate single sign-on using this Identity Provider

signOutUrl : String

The URL that signs out of this Identity Provider

id : ID

The ID of this Identity Provider

Back to top

IdentityProviderConnection

A paginated IdentityProvider list related to the Node

pageInfo : PageInfo

Information regarding the pagination of the list

edges : [IdentityProviderEdge]

The paginated list of relationships

Back to top

IdentityProviderEdge

A representation of a relationship between an Identity Provider and another Node

cursor : String

An opaque string that indicates a specific point in paginating through a list

node : IdentityProvider

The Identity Provider involved in the relationship

Back to top

Instructor

An Instructor for a Course.

Related types: Node

id : ID!

The staff identifier of the Instructor.

name : String!

The naem of the Instructor.

Back to top

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Back to top

KryterionActivity

Content in the form of a Kryterion Activity

Related types: Node Content

id : ID

ID of the Kryterion Activity

displayName : String

The main display name of the content

htmlDescription : String

Description of the Content. Contains HTML.

kryterionUrl : String

URL for the Kryterion Activity

kryterionCourseId : String

Course ID for the Kryterion Activity

isRequired : Boolean

Whether or not the Content is required for the Learner to complete the Event

isPublic : Boolean

Public Content can be displayed to annonymous users for free

order : Int

The order in which the Content should be displayed

type : String

Type of Content

autoComplete : Boolean

Flag indicating if the Content should be auto completed on learner access

isPremium : Boolean

Flag indicating if the Content requires a Training Pass to access it

includedInPassTypeIds : [ID]

List of Training Pass Type IDs that grant access to the Content

Back to top

LearningMode

The learning mode of an Event

blended

Blended

classroom

Classroom

selfPaced

Self-paced

Back to top

LearningObjective

An objective on a Learning Path

Related types: LearningPathObjective ExternalObjective URLObjective CourseObjective DocumentObjective

id : ID

The ID of the LearningObjective

order : Int

The order of this LearningObjective in the set of LearningPath objectives

credits : Int

The number of credits that this LearningObjective represents

expectedCompletionDays : Decimal

The expected required time in days to complete the learning objective

group : LearningObjectiveGroup

The option group this objective belongs to, or null if it is not part of a group

Back to top

LearningObjectiveConnection

A paginated LearningObjective list related to the Node

pageInfo : PageInfo

Information regarding the pagination of the list

edges : [LearningObjectiveEdge]

The paginated list of relationships

Back to top

LearningObjectiveEdge

an Edge type describes the connection between the node and its parent

cursor : String

An opaque string that indicates a specific point in paginating through a list

node : LearningObjective

The Learning Objective involved in the relationship

Back to top

LearningObjectiveField

Fields for filtering and ordering a LearningObjective list

id

The ID of the LearningObjective

Back to top

LearningObjectiveFieldFilter

Used to filter a LearningObjective List

value : String

Value to filter the list

field : LearningObjectiveField

Name of the field to filter the list

operation : FilterOperation

The method to compare the value to filter the list

Back to top

LearningObjectiveFieldOrder

Used for ordering the results by a specific field and direction

field : LearningObjectiveField

Name of the field to order by

direction : OrderDirection

Direction to order by

Back to top

LearningObjectiveGroup

The option group a LearningObjective belongs to, where the Learner only needs to complete a number of the grouped objectives

id : ID!

The ID of the group (the LearningPathStep)

numRequired : Int

The number of objectives in the group the Learner needs to complete

hoursRequired : Decimal

The number of hours in the group the Learner needs to complete

Back to top

LearningPath

A Learning Journey containing a set of objectives to be completed

Related types: Node

id : ID!

The ID of the Learning Path

longDescription : String

The description of the Learning Path

name : String!

The name of the Learning Path

start : Datetime

The earliest Start of the Learning Path based on its Learning Objectives

end : Datetime

The latest End of the Learning Path based on its Learning Objectives

imageUrl : String

URL to the image for the Learning Path

achievementType : AchievementType

The AchievementType that can be earned when the Learning Path is passed

enforceObjectiveOrder : Boolean!

Whether the Learner needs to complete objectives in order

objectives : LearningObjectiveConnection

The LearningObjectives of the LearningPath

Argument Type Description
filters [LearningObjectiveFieldFilter]
order LearningObjectiveFieldOrder
after String
first Int
offset Int
Back to top

LearningPathLearnerLifecycleState

The lifecycle state of a Learning Path Learner

active

Active Learning Path Learner

cancelled

Cancelled Learning Path Learner

completed

Completed Learning Path Learner

Back to top

LearningPathObjective

A Learning Path Objective on a Learning Path

Related types: Node LearningObjective

id : ID

ID of the Learning Path Objective

order : Int

The order of this Learning Objective in the set of Learning Path Objectives

credits : Int

The number of credits that this Learning Objective represents

expectedCompletionDays : Decimal

The expected required time in days to complete the Learning Objective

group : LearningObjectiveGroup

The option group this objective belongs to, or null if it is not part of a group

learningPath : LearningPath

The Learning Path used by this Objective

Back to top

LearningPathOutcome

The Outcome from the Learning Path Objective

Related types: Node LearningPathResult

id : ID

ID for the Learning Path Outcome

order : Int

The order of this Outcome in the set of Learning Assignment Outcomes

credits : Int

The number of credits that the Outcome represents

completed : Boolean

Denotes whether or not the Outcome has been completed by the Learner

objectiveId : ID

The ID of the Objective to which the Outcome refers

learningPath : LearningPath

The Learning Path to which the Outcome refers to

Back to top

LearningPathRegistration

A Learner registered on a Learning Path

Related types: Node Registerable

id : ID!

ID of the Learning Path Registration

contactId : ID

ID of the Contact this Registration is for

trackingIdentifier : String

An External Identifier to identify this Registerable instead of Contact

isActive : Boolean!

The active status of the Learning Path Learner

passAccessExpired : Boolean!

If the registration was made via a Training Pass, confirms access is still available

trainingPassTypeId : ID

The ID of the Training Pass type used to register on the Learning Path

brandId : String

The Brand ID for this Registerable

regionId : ID

The Region ID for this Learning Path Registration

title : String

Title for the Learning Path Registration

expectedProgress : Decimal

The expected progress is a percentage that a Learner is expected to complete based on the current date and the path start date

lifecycleState : LearningPathLearnerLifecycleState!

The Lifecycle State of the Learning Path Learner

progressMade : Decimal

The amount a Learner has completed on the Learning Path across all Learning Path Outcomes

startDate : Datetime

The start date of the Learning Path Registration

learningPath : LearningPath

The Learning Path the Registration is for

lastAccessed : Datetime

The date and time a Learning Path Learner last viewed the Learning Path through the LMS

achievement : Achievement

The Achievement earned by the Learner

results : LearningPathResultConnection

The Learning Path Result

Argument Type Description
filters [LearningPathResultFieldFilter]
order LearningPathResultFieldOrder
after String
first Int
offset Int
Back to top

LearningPathRegistrationConnection

A paginated LearningPathRegistration list related to the Node

pageInfo : PageInfo!

Information regarding the pagination of the list

edges : [LearningPathRegistrationEdge!]!

The paginated list of relationships

Back to top

LearningPathRegistrationEdge

an Edge type describes the connection between the node and its parent

cursor : String!

An opaque string that indicates a specific point in paginating through a list

node : LearningPathRegistration!

The Learning Path Registration involved in the relationship

Back to top

LearningPathRegistrationField

Fields for filtering and ordering a LearningPathRegistration list

id

The ID of the Learning Path, Registration

isActive

The active status of the Learning Path Learner

isComplete

Denotes whether or not the Learning Path has been completed

contactId

ID of the Contact this Registration is for

managedContactId

ID of the Contact this Registration is for

brandId

The Brand ID for this Learning Path Registration

title

Title for the Learning Path Registration

lastAccessed

The date and time a Learning Path Learner last viewed the Learning Path through the LMS

hasParent

If the Learning Path has a parent

Back to top

LearningPathRegistrationFieldFilter

Used to filter a LearningPathRegistration List

value : String

Value to filter the list

field : LearningPathRegistrationField!

Name of the field to filter the list

operation : FilterOperation!

The method to compare the value to filter the list

Back to top

LearningPathRegistrationFieldOrder

Used for ordering the results by a specific field and direction

field : LearningPathRegistrationField!

Name of the field to order by

direction : OrderDirection!

Direction to order by

Back to top

LearningPathResult

The Result from the Learning Path

Related types: LearningPathOutcome ExternalOutcome URLOutcome CourseOutcome DocumentOutcome

id : ID

ID for the Learning Path Result

order : Int

The order of this Learning Outcome in the set of Learning Assignment Outcomes

credits : Int

The number of credits that the Learning Path Result represents

completed : Boolean

Denotes whether or not the Outcome has been completed by the Learner

objectiveId : ID

ID of the Learning Objective to which the Learning Path Result refers

Back to top

LearningPathResultConnection

A paginated LearningPathResult list related to the Node

pageInfo : PageInfo

Information regarding the pagination of the list

edges : [LearningPathResultEdge]

The paginated list of relationships

Back to top

LearningPathResultEdge

an Edge type describes the connection between the node and its parent

cursor : String

An opaque string that indicates a specific point in paginating through a list

node : LearningPathResult

The Learning Path Result involved in the relationship

Back to top

LearningPathResultField

Fields for filtering and ordering a LearningPathResult list

completed

Denotes whether or not the Outcome has been completed

Back to top

LearningPathResultFieldFilter

Used to filter a LearningPathResult List

value : String

Value to filter the list

field : LearningPathResultField

Name of the field to filter the list

operation : FilterOperation

The method to compare the value to filter the list

Back to top

LearningPathResultFieldOrder

Used for ordering the results by a specific field and direction

field : LearningPathResultField

Name of the field to order by

direction : OrderDirection

Direction to order by

Back to top

Location

A particular place used for training

Related types: Node

id : ID!

ID of the Location

name : String!

Name of the Location

Back to top

MappedField

A POS Custom Field that is mapped to a specific Entity's Field.

entityType : MappedFieldEntityType!

The mapped entity type

field : String!

The mapped field

Back to top

MappedFieldEntityType

An enumeration of different entity types that can be mapped

contact

Maps to a field on the Contact entity

customContact

Maps to a custom field on the Contact entity

learner

Maps to a custom field on the Learner entity

pathLearner

Maps to a custom field on the Learning Path Learner entity

Back to top

Node

An entity with an ID

Related types: Document Achievement AchievementType CertificateType Separator Video Scorm ExternalActivity KryterionActivity DiscussionTopic ScormContentResult ScormAttempt VideoContentResult ExternalContentResult ResourceContentResult LearningPathRegistration LearningPath LearningPathOutcome ExternalOutcome URLOutcome CourseOutcome Course Instructor DocumentOutcome LearningPathObjective ExternalObjective URLObjective CourseObjective DocumentObjective Registration Location TrainingRequest CancellationRequest ExternalAttempt RegistrationWithProgress CancellationReason

id : ID

The id of the node

Back to top

OpportunityStep

The step in the sales pipeline an Opportunity is currently in

id : ID

ID of the OpportunityStep

name : String

Name of the OpportunityStep

Back to top

OrderDirection

The directions used for sorts asc - Ascending desc - Descending

asc

Ascending

desc

Descending

Back to top

PageInfo

Information about pagination in a connection.

hasNextPage : Boolean!

If there are more items when paginating forwards.

hasPreviousPage : Boolean!

If there are more items when paginating backwards.

startCursor : String!

The cursor to continue paginating forwards.

endCursor : String!

The cursor to continue paginating backwards.

totalRecords : Int!

The total number of records available for pagination.

Back to top

PaymentMethodType

A method of payment

id : ID

Unique identifier for this Payment Method

name : String

A descriptive name for this Payment Method

Back to top

PersonalNameInputType

An Input for a Personal Name of an entity

firstName : String

The first name of the person

lastName : String

The last name of the person

Back to top

PointOfSaleField

Fields for filtering and ordering a PointOfSale list

isValidForCourseTemplate

Denotes if the PointOfSaleField can be used with a Course Template

Back to top

PointOfSaleFieldEntityType

Point of Sale Field Entity Type

EventRegistration

The Point of Sale field is for an Event

PathRegistration

The Point of Sale field is for a Learning Path

Back to top

PointOfSaleFieldFilter

Used to filter a PointOfSale List

value : String

Value to filter the list

field : PointOfSaleField

Name of the field to filter the list

operation : FilterOperation

The method to compare the value to filter the list

Back to top

PointOfSaleFieldValueType

Point of Sale Value

definitionKey : String!

The Key for the Point of Sale Field

value : String

The Value of the Point of Sale field

Back to top

PointOfSaleLearnerFieldDefinition

A Point of Sale Field

label : String!

The label of the Custom Field Definiton

key : String!

The identifier for this definition

description : String

A description explaining the use of the Custom Field

type : String!

The type of value allowed for this Custom Field

isRequired : Boolean!

Whether the custom field is required

section : String

The Learner Details Information section that this definition should be displayed in

options : [PointOfSaleLearnerFieldDefinitionOption!]

Choices to present for a Custom Field with choice options

mappedField : MappedField

The mapping between an entity type and a field

Back to top

PointOfSaleLearnerFieldDefinitionOption

A choice to present for a Custom Field with choice options

label : String!

The label of the option

value : String!

The value of the option

Back to top

Portal

A separate website that Contacts can access, for example: An LMS or Web Store

identityProviders : IdentityProviderConnection

The Identity Providers for this Portal

singleSignOnOnly : Boolean

Indicates if Contacts can log into this Portal only by Single Sign On

profileSettings : ProfileSettings!

Indicates profile behaviors enabled for this Portal

emptyPortalRedirectUrl : String

The URL that the Contact is redirected to if they log in with no content to view

linkedWebLinkPortals : [WebLinkPortal]

The WebLink Portals associated with this Portal

termsAndConditions : String

The terms and conditions for Portal checkout flow

brand : Brand

The Brand that owns this Portal

isBookingPortal : Boolean

Dictates if Booking Portal behaviours are enabled for this Portal

isApprovalPortal : Boolean

Dictates if Approval Portal behaviours are enabled for this Portal

isSelfRegistrationPortal : Boolean!

Dictates if Self-Registration behaviours are enabled for this Portal

customFieldDependenciesEnabled : Boolean

Dictates whether Custom Field option dependencies are enforced on this instance

Back to top

PortalCustomFieldTemplate

CustomFieldDefinition for a Type on a Portal

key : String

The identifier for this definition

name : String

The name for this definition

description : String

A description explaining the use for the Custom Field

options : [PortalCustomFieldTemplateOption]

Choices to present for a Custom Field with choice options

type : String

The type of value allowed for this Custom Field

dependency : PortalCustomFieldTemplateDependency

The Custom Field whose value narrows this one's options, and the rules narrowing them

Back to top

PortalCustomFieldTemplateDependency

A Custom Field's parent field and the rules narrowing its options

parentField : String

The key of the Custom Field whose value narrows this one

rules : [PortalCustomFieldTemplateDependencyRule]

The narrowing rules, empty when a parent is linked but unruled

Back to top

PortalCustomFieldTemplateDependencyRule

The options one Custom Field permits while its parent holds a value

parentValue : String

The value of the parent Custom Field this rule applies to

allowedOptions : [String]

The option values this rule permits

Back to top

PortalCustomFieldTemplateOption

An option for a PortalCustomFieldTemplate

label : String

The label for the option

value : String

The value of the option

Back to top

PostalAddress

A postal address

streetAddress1 : String

The first line of the address, typically unit, street number, or intended recipient

streetAddress2 : String

The second line of the address, typically street, building, or residence address

streetAddress3 : String

The third line of the address, typically locality, or further miscellaneous address information

town : String

The city or town

region : String

The region, country, or state

postcode : String

The postal code or zip code

province : Province

The State/Province of the Address

country : Country

The Country the address is within

Back to top

PostalAddressInput

An input for creating a postal address

streetAddress1 : String

The first line of the address, typically unit, street number, or intended recipient

streetAddress2 : String

The second line of the address, typically street, building, or residence address

streetAddress3 : String

The third line of the address, typically locality, or further miscellaneous address information

town : String

The city or town

region : String

The region, country, or state

postcode : String

The postal code or zip code

provinceCode : String

The code of the State/Province of the Postal Address

countryId : String

The ID of a Country for the Address

Back to top

ProfileSettings

Indicates profile behaviors enabled for this Portal

allowEditName : Boolean!

Is the Learner allowed to edit the Profile Name

allowEditJobTitle : Boolean!

Is the Learner allowed to edit the Profile Job Title

showJobTitle : Boolean!

Is the Learner allowed to view the Profile Job Title

allowEditEmail : Boolean!

Is the Learner is allowed to edit the Profile email

Back to top

Province

An administrative subdivision of a nation with a designated ISO code

code : String

ISO designated province code

countryCode : String

Country Code of the where the province is

name : String

Name of the Province

Back to top

RecordDiscussionCommentInput

An input for recording a submitted discussion comment

registrationId : ID!

The ID of the Registration submitting the discussion comment

contentId : ID!

The ID of the Discussion Content

comment : String!

The actual comment submitted

Back to top

RecordExternalContentAccessedInput

An input for recording external content being accessed

registrationId : ID

The ID of the Registration with the External Activity

contentId : ID

The ID of the External Activity

Back to top

RecordExternalProgressInput

An input for recording External progress

attemptId : ID!

The ID of the Attempt for which to record progress

status : ExternalActivityStatus!

The status of the External Activity

accompanyingDocumentation : String

Up to 64kb of data to store relevant to this External Activity

Back to top

RecordResourceDownloadInput

An input for recording a resource download

registrationId : ID

The ID of the Registration downloading the resource

contentId : ID

The ID of the Content being downloaded

Back to top

RecordScormProgressInput

An input for recording SCORM progress

registrationId : ID

The ID of the Registration progressing the SCORM Content

contentId : ID

The ID of the Content being progressed

attemptId : ID

The ID of the Attempt for which to record progress

data : String

The data associated with the SCORM progress

sessionFinished : Boolean

Flag indicating the end of SCORM session (LMSFinish/Terminate call)

Back to top

RecordVideoProgressInput

An input for recording video progress

registrationId : ID

The ID of the Registration viewing the Video

contentId : ID

The ID of the Content being viewed

data : String

The data associated with the Video progress

Back to top

Registerable

Represents a Contact participating in learning through an Event or a Learning Path

Related types: LearningPathRegistration Registration RegistrationWithProgress

id : ID!

The ID of the Registerable

isActive : Boolean!

The Learner or Learning Path Learners Active Status

contactId : ID

The Learner or Learning Path Learners contact ID

brandId : String

The Brand ID for this Registerable

title : String

The Title to show on the LMS for this Registerable

lastAccessed : Datetime

The last datetime a Learner or Learning Path Learner accessed in the LMS

achievement : Achievement

The Achievement earned by the Learner

Back to top

RegisterableConnection

A paginated Registerable list related to the Node

pageInfo : PageInfo

Information regarding the pagination of the list

edges : [RegisterableEdge]!

The paginated list of relationships

Back to top

RegisterableEdge

an Edge type describes the connection between the node and its parent

cursor : String

An opaque string that indicates a specific point in paginating through a list

node : Registerable

The Registerable involved in the relationship

Back to top

RegisterableField

Fields for filtering and ordering a Registerable list

id

The ID of the Registerable

isActive

The Learner or Learning Path Learners Active Status

passAccessExpired

If the Registerable was made with a Training Pass, confirms access is still available

isComplete

Denotes whether or not the Registerable has been completed

contactId

The Learner or Learning Path Learner's Contact ID

managedContactId

The Learner or Learning Path Learner's Contact ID

brandId

The Brand ID for this Registerable

allBrands

If true, it will return registerables for all brands, not just the portal brand (default: false)

title

The title of the Registerable

lastAccessed

The last datetime a Learner or Learning Path Learner accessed in the LMS

hasParent

If the registerable is a Learning Path, if that Learning Path has a parent

Back to top

RegisterableFieldFilter

Used to filter a Registerable List

value : String

Value to filter the list

field : RegisterableField

Name of the field to filter the list

operation : FilterOperation

The method to compare the value to filter the list

Back to top

RegisterableFieldOrder

Used for ordering the results by a specific field and direction

field : RegisterableField

Name of the field to order by

direction : OrderDirection

Direction to order by

Back to top

RegisterableMutateResponseType

A Response from mutating a Registerable

registerable : Registerable

The Registerable that was mutated

errors : [FieldError]

The errors returned by the mutation

Back to top

RegisterableMutations

Mutations for Registerables

fulfilObjective : RegisterableMutateResponseType

Fulfil an abstract Learning Objective with a concrete objective

Argument Type Description
input FulfilObjectiveInput

The input type with the values used to fulfil an Objective
Back to top

RegisterablesCount

Count of Registerables

count : Int

The number of Registerables

Back to top

RegisterEventParticipationInput

An input for registering onto an Event

eventId : ID!

The ID of the Event on which to register

Back to top

RegisterEventParticipationResponseType

A response from registering onto an Event

registration : Registration

The Registration that was created for the Event

errors : [FieldError]

The errors returned by the mutation

Back to top

RegisterLearningPathLearnerInput

An input for registering onto a Learning Path

learningPathId : ID!

The ID of the Learning Path on which to register

trainingPassTypeId : String

The ID of the held Training Pass to be used for registration

selectedEvents : [SelectedLearningObjectiveEvent!]

Which Events have been selected to fulfill Course Objectives on the Learning Path

Back to top

RegisterLearningPathLearnerResponseType

A response from registering onto a Learning Path

registration : LearningPathRegistration

The Registration that was created for the Learning Path

errors : [FieldError]

The errors returned by the mutation

Back to top

RegisterPassholderInput

An input for registering onto an Event using a Training Pass

eventId : ID!

The ID of the Event on which to register

trainingPassId : ID!

The ID of the held Training Pass to be used for registration

Back to top

RegisterPassholderResponseType

A response from registering onto an Event using a Training Pass

registration : Registration

The Registration that was created for the Event

errors : [FieldError]

The errors returned by the mutation

Back to top

Registration

A Registration

Related types: Node Registerable

id : ID!

ID of the Registration

eventId : ID

ID of the Event linked to the Registration

isActive : Boolean!

Whether the Registration is Active

passAccessExpired : Boolean

If the Registration was made with a Training Pass, confirms access is still available

contactId : ID

ID of the Contact linked to the Registration

trackingId : String

An External Identifier used to identify this Registration

brandId : String

The Brand ID for this Registration

title : String

The Title to show in the LMS for this Registration

expiry : Datetime

The date and time from which the Learner can no longer access the Event

totalPiecesOfContent : Int!

The total pieces of Content for this Registration

completedPiecesOfContent : Int!

The number of pieces of Content that have been completed

hasPassed : Boolean

Whether the Learner has passed or failed

type : String!

Type of Registration

course : Course

Course linked to the Registration

lastAccessed : Datetime

The date and time the Learner last accessed this in the LMS

achievement : Achievement

The Achievement

achievements : [Achievement]

List of Achievements

quantity : Int!

The quantity of Learners on this Registration

contentResults : ContentResultConnection

A paginated ContentResult list related to the Node

Argument Type Description
filters [ContentResultFieldFilter]
order ContentResultFieldOrder
after String
first Int
offset Int
learningPathRegistration : LearningPathRegistration

The Learning Path Registration

attendance : Attendance

Details of the learner attendance

trainingPassTypeId : ID

The ID of the Training Pass Type that was used to Register

Back to top

RegistrationConnection

A paginated Registration list related to the Node

pageInfo : PageInfo

Information regarding the pagination of the list

edges : [RegistrationEdge]

The paginated list of relationships

Back to top

RegistrationDetails

Details of the Registration

id : ID

Registration Details identifier

contactId : ID

ID of the Learner

trackingId : String

An external identifier to identify this Learner

isUnnamed : Boolean

Denotes whether this is a record for Unnamed Learner(s)

contentResult : ContentResult

A summary of results for this Learner

learningPath : LearningPath

The Learning Path for the Event this Learner is Registered on

Back to top

RegistrationEdge

an Edge type describes the connection between the node and its parent

cursor : String

An opaque string that indicates a specific point in paginating through a list

node : Registration

The Registration involved in the relationship

Back to top

RegistrationField

Fields for filtering and ordering a Registration list

id

The ID of the Registration

active

Whether the Registration is Active

courseTitle

The Title of the Course Tempplate of the Registration

courseLastAccessed

The last datetime a Learner or LearningPathLearner accessed the LMS

lastAccessed

The date and time the Learner last accessed this event in the LMS

courseStart

The start datetime of the Course of the Registration, with timezone information

courseStartDate

The start datetime of the Course of the Registration

courseEnd

The end datetime of the Course of the Registration, with timezone information

courseEndDate

The end datetime of the Course of the Registration

courseLocationName

The name of the Location of the Course of the Registration

hasParentLearningPathRegistration

Denotes if this Registration is part of a Learning Path Registration

isComplete

Denotes whether or not the Registration has been completed

courseId

The ID of the Course linked to the Registration

courseTemplateId

The ID of the Course Tempalte linked to the Registration

Back to top

RegistrationFieldFilter

Used to filter a Registration List

value : String

Value to filter the list

field : RegistrationField

Name of the field to filter the list

operation : FilterOperation

The method to compare the value to filter the list

Back to top

RegistrationFieldOrder

Used for ordering the results by a specific field and direction

field : RegistrationField

Name of the field to order by

direction : OrderDirection

Direction to order by

Back to top

RegistrationMutateResponseType

A Response from mutating a Registration

registration : Registration

The Registration that was mutated

errors : [FieldError]

The errors returned by the mutation

Back to top

RegistrationMutations

Mutations for Registrations

recordResourceDownload : RegistrationMutateResponseType

Records when a resource or document is downloaded

Argument Type Description
input RecordResourceDownloadInput

The input type with the download information
recordVideoProgress : RegistrationMutateResponseType

Records a Registration's progress through a piece of Video Content

Argument Type Description
input RecordVideoProgressInput

The input type with the Video progress information
attemptScormContent : RegistrationMutateResponseType

Creates an attempt on a piece of SCORM Content

Argument Type Description
input AttemptScormContentInput

The input type with the information to create the attempt
recordScormProgress : RegistrationMutateResponseType

Records a Registration's progress through a piece of SCORM Content

Argument Type Description
input RecordScormProgressInput

The input type with the SCORM progress information
recordExternalContentAccessed : RegistrationMutateResponseType

Records a Registration's progress through a piece of External Content

Argument Type Description
input RecordExternalContentAccessedInput

The input type with the external content access information
associateUnnamedEventLearnerWithContacts : AssociateUnnamedLearnerWithContactsResponseType

Associate an Unnamed Learner with existing Contacts

Argument Type Description
input AssociateUnnamedLearnerWithContactsInput!

The input type with the values used to associate a Learner with existing Contacts
registerEventParticipation : RegisterEventParticipationResponseType

Register onto an Event

Argument Type Description
input RegisterEventParticipationInput!

The input type with the values used to register onto an Event
registerPassholder : RegisterPassholderResponseType

Register onto an Event using a Training Pass

Argument Type Description
input RegisterPassholderInput!

The details needed for registration
registerLearningPathLearner : RegisterLearningPathLearnerResponseType

Register onto a Learning Path

Argument Type Description
input RegisterLearningPathLearnerInput!

The input with the values used to register onto a Learning Path
recordDiscussionComment : RegistrationMutateResponseType

Records a submitted discussion comment

Argument Type Description
input RecordDiscussionCommentInput

The input type with the discussion comment information
deleteDiscussionComment : RegistrationMutateResponseType!

Delete a Discussion Comment

Argument Type Description
input DeleteDiscussionCommentInput!

The input type identifying the Discussion Comment to be deleted
ensureKryterionAccount : EnsureKryterionAccountResponseType!

Creates an account in Kryterion if one does not already exist

Argument Type Description
input EnsureKryterionAccountInput

The input type with the values used to create a Kryterion account
Back to top

RegistrationWithProgress

A Registration

Related types: Node Registerable

id : ID!

ID of the Registration

eventId : ID

ID of the Event linked to the Registration

isActive : Boolean!

Whether the Registration is Active

passAccessExpired : Boolean

If the Registration was made with a Training Pass, confirms access is still available

contactId : ID

ID of the Contact linked to the Registration

trackingId : String

An External Identifier used to identify this Registration

brandId : String

The Brand ID for this Registration

title : String

The Title to show in the LMS for this Registration

expiry : Datetime

The date and time from which the Learner can no longer access the Event

totalPiecesOfContent : Int!

The total pieces of Content for this Registration

completedPiecesOfContent : Int!

The number of pieces of Content that have been completed

hasPassed : Boolean

Whether the Learner has passed or failed

type : String!

Type of Registration

course : Course

Course linked to the Registration

lastAccessed : Datetime

The date and time the Learner last accessed this in the LMS

achievement : Achievement

The Achievement

achievements : [Achievement]

List of Achievements

quantity : Int!

The quantity of Learners on this Registration

contentResults : ContentResultConnection

A paginated ContentResult list related to the Node

learningPathRegistration : LearningPathRegistration

The Learning Path Registration

attendance : Attendance

Details of the learner attendance

trainingPassTypeId : ID

The ID of the Training Pass Type that was used to Register

Back to top

RegistrationWithProgressConnection

A paginated RegistrationWithProgress list related to the Node

pageInfo : PageInfo

Information regarding the pagination of the list

edges : [RegistrationWithProgressEdge]

The paginated list of relationships

Back to top

RegistrationWithProgressEdge

an Edge type describes the connection between the node and its parent

cursor : String

An opaque string that indicates a specific point in paginating through a list

node : RegistrationWithProgress

The Registration With Progress involved in the relationship

Back to top

ResourceContentResult

A summary of results for a Learner on a piece of EventContent

Related types: Node ContentResult

id : ID

The ID of the Content Result

contentId : ID

The ID of the piece of Content this result relates to

content : Content

The Content this result relates to

attempts : Int

The attempts on this Content

completedAttempts : Int

The number of complete attempts the Learner has had on this Content

progress : Decimal

The percentage complete the Learner has achieved on the Content

score : Decimal

The score the Learner has achieved on the Content

scorePercent : Decimal

The score percent the Learner has achieved on the Content

lastAccessed : Datetime

The date and time when the Content was last accessed

status : ContentResultStatus

The current status of the Content

Back to top

Scorm

Content in the form of SCORM

Related types: Node Content

id : ID

ID of the SCORM Content

displayName : String

The main display name for the content

htmlDescription : String

Description for the Content. Contains HTML

order : Int

The order in which the Content should be displayed

type : String

The type of Content

identifyingHash : String

An identifier used to fetch the Document Revision

fileSizeStr : String

The size of the SCORM file in bytes. Returned as string, to allow universal support for values larger than 2 gigabytes.

version : Version

The version of the SCORM Content

entrypoint : String

The entrypoint for the SCORM content

maxAttempts : Int

The maxiumum number of attempts permitted for this SCORM Content

isRequired : Boolean

Whether or not the Content is required for the Learner to complete the Event

isPublic : Boolean

Public Content can be displayed for annonymous users for free

autoComplete : Boolean

Flag indicating if the Content should be auto completed on Learner access

isPremium : Boolean

Flag indicating if the content requires a Training Pass to access it

includedInPassTypeIds : [ID]

List of Training Pass Type IDs that grant access to this Content

Deprecated fields (1)
fileSize : Int

Removal date: 2024-04-03.

This field does not support values larger than 2 gigabytes. Please use "fileSizeStr".

Back to top

ScormAttempt

Data on a SCORM Attempt

Related types: Node

id : ID

ID of the Attempt

data : String

Information about the ScormAttempt

Back to top

ScormContentResult

A summary of results for a Learner on a piece of SCORM type EventContent

Related types: Node ContentResult

id : ID

ID of the Content Result

contentId : ID

The ID to the piece of Content this Result relates to

content : Content

The Content this result relates to

attempts : Int

The Learner attempts on the Content

completedAttempts : Int

The number of Complete attempts the Learner has had on this Content

progress : Decimal

The percentage complete the Learner has achieved on the Content

score : Decimal

The score the Learner has achieved on this Content

scorePercent : Decimal

The score percent the learner has achieved on the Content

lastAccessed : Datetime

The date and time when the Content was last accessed

status : ContentResultStatus

The current status of the Content

latestAttempt : ScormAttempt

Information on the last attempt the Learner made on the SCORM content

Back to top

SelectedLearningObjectiveEvent

An input for specifying which Events will fulfill a Course Objective when registering onto a Learning Path

objectiveId : ID!

The Learning Path Objective to be fulfilled

eventId : String

The Event that has been selected to fulfill this Objective

Back to top

Separator

Used to Separator Content on a Course

Related types: Node Content

id : ID

ID of the Separator

displayName : String

The main display name of the Separator

htmlDescription : String

Optional description - contains HTML

isRequired : Boolean

Whether or not the Content is required for the Learner to complete the Event

isPublic : Boolean

Public Content can be displayed to annonymous users for free

order : Int

The order in which the Separator should be displayed

type : String

The type of Content

autoComplete : Boolean

Flag indicating if the Content should be autocompleted on Learner access

isPremium : Boolean

Flag indicating if the Content requires a Training Pass to access it

includedInPassTypeIds : [ID]

List of Training Pass Type IDs that grant access to this content

Back to top

Session

A period of time used for learning or teaching

id : ID

ID of the Session

title : String

Title of the Session

timeZonedStart : Datetime

Time zone offset date and time the Session starts

timeZonedEnd : Datetime

Time zone offset date and time the Session ends

location : Location

Location at which the Event takes place

remoteMeetingUrl : String

The URL of the remote meeting

Back to top

SessionDetail

A summary of session details

session : Session

Sessions that belong to the Event

attendanceMark : String

The attendance Status of the Learner

Back to top

SessionDetailConnection

A paginated SessionDetail list related to the Node

edges : [SessionDetailEdge]

The paginated list of relationships

Back to top

SessionDetailEdge

an Edge type describes the connection between the node and its parent

node : SessionDetail

The Session Detail involved in the relationship

Back to top

SessionsConnection

A paginated Sessions list related to the Node

edges : [SessionsEdge]

The paginated list of relationships

Back to top

SessionsEdge

an Edge type describes the connection between the node and its parent

node : Session

The Session involved in the relationship

Back to top

SetPasswordInputType

An input for setting a password

newPassword : String

The new password

currentPassword : String

The current password

host : String

The URL of the Host of the Portal for which to set the password

verifyEmail : Boolean

Whether setting the password should be verified by email

Back to top

SingleSignOnError

Single Sign On Error

Related types: SingleSignOnResult

success : Boolean

Success Flag

code : String

Code

Back to top

SingleSignOnResult

Single Sign On Result

Related types: SingleSignOnSuccess SingleSignOnError

success : Boolean

Success Flag

Back to top

SingleSignOnSuccess

Single Sign On Success

Related types: SingleSignOnResult

success : Boolean

Success Flag

portalToken : String

Portal Token

username : String

Username

previousPath : String

Previous Path

Back to top

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Back to top

Subcategory

A subcategory for a Category

id : ID

ID for the Subcategory

name : String

Name for the Subcategory

Back to top

SubcategoryConnection

A paginated Subcategorylist related to the Node

edges : [SubcategoryEdge]

The paginated list of relationships

Back to top

SubcategoryEdge

an Edge type describes the connection between the node and its parent

node : Subcategory

The Subcategory involved in the relationship

Back to top

SupportsCustomFieldPortalEntities

Types that support CustomField Definitions on a Portal

Viewer

The current Viewer

Back to top

TokenIssueTransaction

A record of a balance change in a Token Account

type : String

Reason for the Training Token balance change

notes : String

Notes describing the adjustment

balanceDelta : Int

The amount by which the Account balance changed

occurredAt : Datetime

When this Transaction occurred

registerableTitle : String

The title of the Registerable that the Training Tokens were exchanged for

tokenReceiptNumber : String

The number of the Token Receipt

Back to top

TokenIssueTransactionField

Fields for filtering and ordering a TokenIssueTransaction list

occurredAt

When this Transaction occurred

Back to top

TokenIssueTransactionFieldOrder

Used for ordering the results by a specific field and direction

field : TokenIssueTransactionField

Name of the field to order by

direction : OrderDirection

Direction to order by

Back to top

TokenIssueTransactions

Transactions agains a Token Issue

transactions : TrainingTokenIssueTransactionConnection

The Training Token Transactions against the Token Issue

Back to top

TrainingPass

A Training Pass

id : ID

ID of the Training Pass

validFrom : Datetime

The UTC date and time this Training Pass should be valid from. To get current Training Pass status, always use lifecycleState.

validUntil : Datetime

The UTC date and time this Training Pass should be valid until. To get current Training Pass status, always use lifecycleState.

lifecycleState : String

Current status of this Training Pass. This is the only field you have to check if you want to know if the Training Pass is active. This field is always up to date.

trainingPassTypeId : ID

The ID of the Training Pass Type linked to the Training Pass

trainingPassTypeCode : String

Code for the Training Pass Type linked to the Training Pass

trainingPassTypeName : String

Name of the Training Pass Type linked to the Training Pass

Back to top

TrainingPassType

A Training Pass Type

id : ID

ID of the Training Pass Type

code : String

Code for the Training Pass Type

name : String

Name of the Training Pass Type

description : String

Descriptiong of the Training Pass Type

Back to top

TrainingPassTypeConnection

A paginated TrainingPassType list related to the Node

edges : [TrainingPassTypeEdge]

The paginated list of relationships

Back to top

TrainingPassTypeEdge

an Edge type describes the connection between the node and its parent

node : TrainingPassType

The Training Pass Type involved in the relationship

Back to top

TrainingRequest

A Training Request Opportunity

Related types: Node

id : ID

ID of the Training Request

registerableId : ID

ID of the Registerable linked to the Training Request

createdAt : Datetime

Date and time the Training Request was created

updatedAt : Datetime

Date and time the Training Request was updated

stepName : String

Name of the OpportunityStep

stageName : String

Name of the OpportunityStep

state : String

State of the Training Request

training : TrainingRequestItem

The Training being requested

Back to top

TrainingRequestConnection

A paginated TrainingRequest list related to the Node

pageInfo : PageInfo

Information regarding the pagination of the list

edges : [TrainingRequestEdge]

The paginated list of relationships

Back to top

TrainingRequestEdge

an Edge type describes the connection between the node and its parent

cursor : String

An opaque string that indicates a specific point in paginating through a list

node : TrainingRequest

The Training Request involved in the relationship

Back to top

TrainingRequestField

Fields for filtering and ordering a TrainingRequest list

id

The ID of the TrainingRequestField

state

The state of the Training Request

stepName

The name of the OpportunityStep the TrainingRequest is currently in

createdAt

The date and time the Training Request was created

updatedAt

The date and time the Training Request was updated

courseTemplateId

The ID of the Course Template being requested

Back to top

TrainingRequestFieldFilter

Used to filter a TrainingRequest List

value : String

Value to filter the list

field : TrainingRequestField

Name of the field to filter the list

operation : FilterOperation

The method to compare the value to filter the list

Back to top

TrainingRequestFieldOrder

Used for ordering the results by a specific field and direction

field : TrainingRequestField

Name of the field to order by

direction : OrderDirection

Direction to order by

Back to top

TrainingRequestItem

An item of Training to be requested

id : ID

The Training Request Item ID

title : String

Title of the Training being requested

type : String

Type of the Training being requested

start : Datetime

Start date and time

end : Datetime

End date and time

imageUrl : String

Image URL

location : String

Location

Back to top

TrainingRequestMutations

Mutations for Training Requests

createTrainingRequest : TrainingRequestMutationsResponseType

Create a new Training Request Opportunity

Argument Type Description
input CreateTrainingRequestInputType
Back to top

TrainingRequestMutationsResponseType

The Response from mutating a Training Request

trainingRequest : TrainingRequest

The mutated Training Request

errors : [FieldError]

Errors from the mutation

Back to top

TrainingTokenIssue

A Block of Tokens Issued To An Account

id : ID

ID of the Node

initialBalance : Int

The number of tokens which were originally issued

currentBalance : Int

The number of unredeemed and unexpired tokens for this Token Issue

redeemed : Int

The number of tokens redeemed for this Token Issue

tokenType : String

The type of Training Token

tokenTypeId : ID

Identifier for the type of Training Token

createdAt : Datetime

A timestamp representing when the Training Token was issued

expiresAt : Datetime

A timestamp representing when any remaining unused Tokens will be forfeited

isExpired : Boolean

Whether or not the expiresAt date has passed

paymentCode : String

The Payment Code used for Paying using this Token Issue. Also contains the value for any Imported Payment Code which was generated on a system out-with Administrate

legacyCode : String

Record Identifier used in previous versions of Administrate's API and should only be used for Integrations requiring crossover between versions.

Back to top

TrainingTokenIssueConnection

A paginated Training Token Issue list related to the Node

edges : [TrainingTokenIssueEdge]

The paginated list of relationships

Back to top

TrainingTokenIssueEdge

an Edge type describes the connection between the node and its parent

node : TrainingTokenIssue

The Training Token Issue involved in the relationship

Back to top

TrainingTokenIssueTransactionConnection

A paginated Token Issue Transaction list related to the Node

pageInfo : PageInfo

Information regarding the pagination of the list

edges : [TrainingTokenIssueTransactionEdge]

The paginated list of relationships

Back to top

TrainingTokenIssueTransactionEdge

an Edge type describes the connection between the node and its parent

node : TokenIssueTransaction

The Token Issue Transaction involved in the relationship

Back to top

URL

A universal resource locator that can be used to fetch data

Back to top

URLObjective

A URL objective on a Learning Path

Related types: Node LearningObjective

id : ID

ID of the URL Objective

order : Int

The order of this Learning Objective in the set of Learning Path Objectives

credits : Int

The number of credits that this Learning Objective represents

expectedCompletionDays : Decimal

The expected required time in days to complete the Learning Objective

group : LearningObjectiveGroup

The option group this objective belongs to, or null if it is not part of a group

url : String

URL used for this Objective

Back to top

URLOutcome

The Outcome from the URL Objective

Related types: Node LearningPathResult

id : ID

ID for the URL Outcome

order : Int

The order of this Outcome in the set of Learning Assignment Outcomes

credits : Int

The number of credits that the Outcome represents

completed : Boolean

Denotes whether or not the Outcome has been completed by the Learner

objectiveId : ID

The ID of the Objective to which the Outcome refers

url : String

URL to which the Outcome refers to

Back to top

Version

SCORM Versions

SCORM12

SCORM Version 1.2

SCORM2004

SCORM Version 2004

Back to top

Video

Content in the form of a Video

Related types: Node Content

id : ID

ID of the Video

displayName : String

The main display name of the Content

htmlDescription : String

Description of the Content. Contains HTML.

isRequired : Boolean

Whether or not the Content is required for the Learner to complete the Event

isPublic : Boolean

Public Content can be displayed to annonymous users for free

order : Int

The order in which the Content should be displayed

type : String

Type of the Content

wistiaVideoId : String

The ID for the video on Wistia

fileSizeStr : String

The size of this Video in bytes. Returned as string, to allow universal support for values larger than 2 gigabytes

autoComplete : Boolean

Flag indicating if the content should be auto completed on learner access

isPremium : Boolean

Flag indicating if the Content requires a Training Pass to access it

includedInPassTypeIds : [ID]

List of Training Pass Type IDs that grant access to this Content

Deprecated fields (1)
fileSize : Int

Removal date: 2024-04-03.

This field does not support values larger than 2 gigabytes. Please use "fileSizeStr".

Back to top

VideoContentResult

A summary of results for a Learner on a piece of Video Content

Related types: Node ContentResult

id : ID

The ID of the Content Result

contentId : ID

The ID to the piece of Content this result relates to

content : Content

The Content this result relates to

attempts : Int

The Learner attempts on the Content

completedAttempts : Int

The number of complete attempts the Learner has had on this Content

progress : Decimal

The percentage complete the Learner has achieved on the Content

score : Decimal

The score the Learner has achieved on the Content

scorePercent : Decimal

The score percent the Learner has achieved on the Content

lastAccessed : Datetime

The date and time when the Content was last accessed

status : ContentResultStatus

The current status of the Content

startAt : Int

The position in seconds to start playing the Video Content at, based on previous progress

Back to top

Viewer

The current Viewer in the LMS

id : ID

Viewer ID

firstName : String

Viewer first name

lastName : String

Viewer last name

emailAddress : String

Viewer email address

jobRole : String

Job role of the viewer

isCoordinator : Boolean

Flag indicating if the Viewer is a Coordinator

locale : String

Viewer locale

timeZoneName : String

Name of the timezone used by the Viewer

username : String

Viewer username

learnerWelcomed : Boolean

Flag indicating if the viewer has been shown the portal welcome message

company : String

Viewer company

customFieldValues : [ViewerCustomFieldValue]

Viewer custom field values

externalIdNames : [String]

Viewer external ID names

trainingPasses : [TrainingPass]

List of Training Passes assigned to the viewer

Back to top

ViewerCredentials

Identifying information for the sign in Credentials of the Viewer

id : ID

The ID of the Credentials

Back to top

ViewerCredentialsMutations

Mutations for Viewer Credentials

setPassword : ViewerCredentialsMutationsResponseType

Sets the password

Argument Type Description
input SetPasswordInputType

The input type with the values used to set the password
markLearnerWelcomed : ViewerCredentialsMutationsResponseType

Marks the Viewer as welcomed by the portal

Back to top

ViewerCredentialsMutationsResponseType

A response from mutating Viewer Credentials

errors : [FieldError]

The errors returned by the mutation

viewerCredentials : ViewerCredentials

The Credentials that was mutated

Back to top

ViewerCustomFieldValue

A value stored for a Custom Field

key : String

The identifier of the Custom Field

locator : String

The human readable definition locator of the Custom Field

value : String

Returns the related entity field value

Back to top

ViewerMutateResponseType

The Response from mutating a Viewer

viewer : Viewer

The mutated Viewer

errors : [FieldError]

Errors from the mutation

Back to top

ViewerMutations

Viewer Mutations

update : ViewerMutateResponseType

Update the current Viewer

Argument Type Description
input ViewerUpdateInput!
Back to top

ViewerUpdateInput

An Input to update the current logged in User

timeZoneName : String

The Time Zone Name

locale : String

The Locale

personalName : PersonalNameInputType

The Personal Name

jobRole : String

The Job Role

customFieldValues : [CustomFieldValueInputType]

Custom Field Values

Back to top

WebLinkApprovalPaymentProvider

Settings used by a WebLink Portal to handle approval payments

Related types: WebLinkPaymentProvider

approvalSignOffSteps : [OpportunityStep]

The list of Opportunity steps that this request must go through in order to be approved

approvalEntryStep : OpportunityStep

The Opportunity Step for a newly created approval request

requestApprovedStep : OpportunityStep

The Opportunity Step that indicates this request for approval was approved

requestRejectedStep : OpportunityStep

The Opportunity Step that indicates this request for approval was rejected

requestOnWaitlistStep : OpportunityStep

The Opportunity Step that indicates this request for approval is on a waitlist

paymentMethod : PaymentMethodType

The Payment Method Type that will be used to classify payments made using this Payment Provider on Invoices created via WebLink Orders

Back to top

WebLinkInvoicePaymentProvider

Settings used by a WebLink Portal to take payments by Invoice

Related types: WebLinkPaymentProvider

name : String

The Name of this Payment Provider

opportunityStep : OpportunityStep

The opportunity step at which this payment method becomes active

paymentMethod : PaymentMethodType

The Payment Method Type that will be used to classify payments made using this Payment Provider on Invoices created via WebLink Orders

Back to top

WebLinkPaymentProvider

Settings used to configure the payment settings for a Weblink Portal

Related types: WebLinkApprovalPaymentProvider WebLinkStripePaymentProvider WebLinkInvoicePaymentProvider WebLinkUnsupportedPaymentProvider

paymentMethod : PaymentMethodType

The Payment Method Type that will be used to classify payments made using this Payment Provider on Invoices created via WebLink Orders

Back to top

WebLinkPortal

A separate portal that Contacts can access to purchase or register onto training

id : ID

The ID of this Portal

url : String

The URL of this Portal

paymentProviders : [WebLinkPaymentProvider]

Configured Providers that can be used to take payment in this WebLink Portal

isSelfRegistrationPortal : Boolean!

Dictates if Self-Registration behaviours are enabled for this Portal

isBookingPortal : Boolean!

Dictates if Booking Portal behaviours are enabled for this Portal

showPrivateTraining : Boolean!

Whether the Portal will show any private training (such as Private Events) available to the User via their Account.

Back to top

WebLinkStripePaymentProvider

Settings used by a WebLink Portal to take payments with Stripe

Related types: WebLinkPaymentProvider

name : String

The Name of this Payment Provider

stripeSecretKey : String

The Secret Key provided by Stripe to make a charge

stripePublicKey : String

The Public Key provided by Stripe to make a charge

paymentMethod : PaymentMethodType

The Payment Method Type that will be used to classify payments made using this Payment Provider on Invoices created via WebLink Orders

Back to top

WebLinkUnsupportedPaymentProvider

Use the Payment Provider from the Linked WebLink Portal instead

Related types: WebLinkPaymentProvider

name : String

The Name of this Payment Provider

paymentMethod : PaymentMethodType

The Payment Method Type that will be used to classify payments made using this Payment Provider on Invoices created via WebLink Orders

Back to top

WelcomeMessage

A message to be displayed to Learners when first accessing the Portal

body : String

The body of the Welcome Message

buttonText : String

The dismiss button text

imageUrl : String

The URL of the image used in the Welcome Message

Back to top

Schema version: 48d414b4797b