WebLink GraphQL API Reference

Retrieves a list of Events or Learning Paths that are available to book on this Portal.

Retrieves a specific Cart.

Retrieves a list of Courses or Learning Paths that are available to book on this Portal.

Retrieves a list of Categories for this Portal.

Retrieves a list of Countries for this Portal.

Retrieves a list of Courses for this Portal.

Retrieves a list of Events for this Portal.

Retrieves a Gift Voucher via the Gift Voucher code.

A test query to validate a correctly configured connection to the API.

The Events that can be selected to fulfill a Course Objective on a Learning Path.

Retrieves a list of Learning Paths for this Portal.

Retrieves a list of Learning Tags.

Retrieves a list of Locales for this Portal.

Retrieves a list of Locations for this Portal.

Retrieves a list of Accounts that a Coordinator is responsible for.

Retrieves a list of Contacts belonging to the Accounts that a Coordinator is responsible for.

Retrieves a list of fields, for this Portal, used to capture custom Learner information during the Checkout process.

Retrieves a list of Point of Sale Order Fields for this Portal.

Retrieves a list of Point of Sale Order Field Values for this Portal.

Retrieves a list of Custom Field Definitions for this Portal.

Retrieves a list of Training for Accounts that the logged in Contact is a member of.

Retrieves a list of Training for Accounts that the Coordinator is responsible for.

Retrieves the distinct Locations of Private Training for Accounts that the logged in Contact is a member of, including Locations typed directly into an Event.

Retrieves the distinct Locations of Private Training for Accounts that the Coordinator is responsible for, including Locations typed directly into an Event.

Retrieves a list of Regions.

Retrieves a list of Sessions for an Event.

Retrieves the configuration and details of this Portal.

Retrieves the list of Training Pass Types which are configured for this Portal.

The currently logged-in user.

Mutations that can be used to modify a Cart.

Creates a Payment Session. Used by Converge to create a valid Token for use with their API.

Mutations that can be used to interact with the MultiSafepay Payment Provider.

Mutations that can be used to modify Bookings.

Submits a request for training per the Training Request Workflow configured for the Portal.

Mutations that can be used to interact with the Stripe Payment Provider.

Mutations that can be used to interact with the Training Tokens payment method.

Mutations that can be used to interact with the Worldpay Payment Provider.

The unique identifier of the Account.

The name of the Account.

Whether the Account is an Individual Account representing a single Contact.

A list of accounts managed by this Account.

Whether the Account is trusted to pay by Invoice.

The unique identifier of the Account Association.

The Account in this Association.

The Account Association Type.

The unique identifier of the Account Association Type

The name of the Account Association Type

Whether the Account is trusted to pay by Invoice.

The unique identifier of the Account.

The name of the Account.

The unique identifier of the Cart.

The unique identifier of the Product Option.

The unique identifier of the Parent Item.

Quantity of the Item.

Amount of the Item.

The unique identifier of the Cart.

The unique identifier of the Product Option.

The Amount of the Gift voucher.

The unique identifier of the Cart.

The Line Item to add.

The unique identifier of the Product Option.

Quantity of the Line Item.

Learners who should be added to the Line Item.

Any Learning Objectives chosen for the Line Item when the Line Item is a Learning Path.

The unique identifier of the Price Level.

The unique identifer of the ancestor Account.

The name of the ancestor Account.

The unique identifier of the Cart.

The Code of the Gift Voucher to apply.

The unique identifier of the Cart.

The Payment Code to apply.

The unique identifier of the Cart.

The unique identifier of the Account.

The unique identifier of the Cart.

The Promotion Code to apply.

The unique definition key of the Custom Field.

The value of the Custom Field.

The unique identifier of the Payment Provider.

The Attribute Definitions linked to the Payment Provider.

The ID used to identify the account when submitting transaction requests.

The key used as an additional layer of authentication when submitting transaction requests.

Whether the Payment Provider is considered to be 'Live' i.e. will process real transactions for a production Authorize.net account.

Whether the Bookable is an Event or Learning Path.

When the Bookable starts.

When the Bookable ends.

The Delivery Method of the Bookable, Classroom, LMS, or Both.

How many places remain until the Bookable is fully booked.

The unique identifier for the Location of the Bookable.

The unique identifier for the Course of the Bookable.

The language of the Bookable.

An Event

A Learning Path

Cancels a Learner on an Event.

Cancels a Learner on a Path.

Registers Learners onto a Private Event.

Transfers a Learner from one Event to another Event.

The first name of the Buyer.

The last name of the Buyer.

The e-mail address of the Buyer.

The Company of the Buyer.

The Postal Address of the Buyer.

The Email Address used to send any Invoice to

Any Custom Fields associated with the Buyer, and their values.

The unique identifier of the Cart.

Any Items in the Cart.

The details of the Cart owner.

The Price of the Cart.

The Invoice ID of the Cart, populated during Checkout.

The state of the Cart.

Any Promotional Code which has been applied to the Cart.

Any Gift Vouchers which have been applied to the Cart.

Any Payment Codes which have been applied to the Cart.

The Registration for the Cart, populated during Checkout.

If the cart has been claimed by a user.

The Region of the Cart.

The Currency of the Cart.

The Token Type assigned to the Cart. Overriding and acting as the 'Currency' of the Cart if set.

Whether the cart contains any items that require a review from an administrator before purchase.

When the Items in the Cart are reserved until. After this time elapses, the Items are free to be Booked elsewhere.

The Price Level of the Cart.

Whether the Cart is locked to a specific Region/Currency pair.

The unique identifier of the Line Item.

The number of Line Items to be sold.

The price charged for a single Line Item.

The tax exclusive price charged for all Items of this Line.

The total tax amount charged for all Items of this Line.

The tax inclusive price charged for all Items of this Line.

The Tax Type applicable to this Line Item.

The underlying Product (Event) for this Line Item.

A list of Learner details for this Line Item.

The Pricing Agreement Price applied to this Line Item.

The Line Items that are children of this Line Item.

Whether the Line Item can be reserved.

Whether the Line Item reservation has expired.

Whether the Line Item is reserved.

The Price Level applied to this Line Item.

Attribute definitions that can be provided with each Learner

The updated Cart.

A list of Cart Line Items which were removed from the Cart because they don't support the specified Financial Unit.

A list of errors encountered while running the mutation.

The Cart that was modified.

A list of errors encountered while running the mutation.

Adds a Child Item to a Cart.

Adds a Gift Voucher to the Cart.

Adds an Line Item to a Cart.

Applies a Gift Voucher to a Cart.

Applies a Payment Code to a Cart.

Applies any Pricing Agreements tied to a specific Account to the Cart.

Applies a Promotion Code to a Cart.

Allows a logged in User to claim an existing Cart if the correct guest Portal Token is provided.

Allows a Guest User to claim a Cart via a Recovery Token in order to operate on it.

Creates a new Cart.

Moves the Cart into a pending state. Used when starting a checkout via Multisafepay or Worldpay.

Moves the Cart to the Entry Step. Useful when you need to modify a Pending Cart if the checkout fails.

Complete the checkout for a Cart and create a Registration and Invoice.

Moves the cart to the Review Step if applicable.

Extends Reservations for Items and removes Items from the Cart where the Reservation has expired.

Removes a Line Item from a Cart.

Removes a previously applied Promotion Code from a Cart.

Submits a Cart to be reviewed and progressed by an Administrator in the TMS.

Switch the Payment Region for a Cart

Removes an applied Gift Voucher from a Cart.

Updates a Cart.

Updates the Financial Unit of a Cart.

Updates an Event which is present in the Cart.

Updates a Gift Voucher which is present in the Cart.

Updates a Learning Path which is present in the Cart.

The subtotal of the Cart.

The grand total of the Cart.

The total of any the Discounts applied to the Cart.

The total of any Gift Vouchers applied to the Cart.

The total amount payable of the Cart.

The taxes applied to the Cart.

Cart is initialized, not paid yet.

Cart is already paid.

Cart payment is pending.

Cart is pre-existing and payment can proceed, without modifying items.

Cart is awaiting review and cannot be modified.

Cart cannot be edited or progressed to a different state

The total amount of Tax.

The type of Tax.

The unique identifier of the Catalog Item.

The name of the Catalog Item.

The unique identifier of the Category.

The type of Catalog Item.

Whether the Catalog Item is associated with a specific Account e.g. Partner/Sponsor.

Whether the Catalog Item is associated with a specific Account indirectly by an Association Type

The unique identifier of the Location.

The first Session Start Time.

The last Session End Time.

When the Catalog Item starts.

When the Catalog Item ends.

How many bookable places remain on the Catalog Item.

Which day of week the Catalog Item runs on.

If the Catalog Item (Learning Path) contains only Event and External Objectives. If 'true' is provided, Course Templates are not returned.

If the Catalog Item has a valid Price in a specific Region.

If the Catalog Item is included in a specified Training Pass Type.

The unique identifier of the Learning Tag.

A Course.

A Learning Path.

The unique identifier of this Category.

The name of this Category.

The description of the Category.

The child categories associated with this Category.

The parent of this Category if it is a child Category.

Products associated with this Category.

The unique identifier of the Category.

The name of the Category.

The unique identifier of the Parent Category.

The unique identifier of the Payment Provider.

The address where the Check should be mailed to.

The Attribute Definitions linked to the Payment Provider

The unique identifier of the Cart.

The guest Portal Token.

The Recovery Token.

The unique identifier of the Contact.

The first name of the Contact.

The last name of the Contact.

The primary email address of the Contact.

The Account the Contact belongs to.

The custom field values for the Contact.

The Job Role of the Contact.

The Department in which the Contact works.

The Locale for the Contact.

The timezone for the Contact.

Whether the Contact is a Coordinator for any Account.

The Personal Name of the Contact.

The Postal Address of the Contact.

The Fax number of the Contact.

The Home phone number of the Contact.

The Mobile phone number of the Contact.

The Office phone number of the Contact.

The unique identifier of the Contact.

The primary email address of the Contact.

The name of the Contact.

The unique identifier of the Payment Provider.

The Attribute Definitions linked to the Payment Provider.

Whether this Payment Provider is considered to be 'Live' i.e. will process real transactions for a production Converge account.

The unique identifier for the Transaction received from Converge.

The latitude of the Coordinate.

The longitude of the Coordinate.

The unique identifier of the Country.

The name of the Country.

The ISO designated Country Code.

Provinces which are associated with this Country.

The unique identifier of the Course.

The name of the Course.

The Code referring to the Course.

The Learning Category of the Course.

The Learning Categories of this Course.

The Price Range of the Course.

The Events for the Course.

A short description of what is included in the Course.

A longer description of what is included in the Course.

A description of anything that must be completed before attending the Course.

Which Topics will be covered during the Course.

Frequently asked questions about the Course.

A description of the Learning Outcomes associated with the Course.

The header image URL for the Course.

The Image Gallery URLs for the Course.

The Delivery Method of the Course.

The Custom Field Values associated with the Course.

Whether the Course is Featured i.e. sorted to the top of the Catalog.

Published Training Pass Type Identifiers that grant access to the Course.

The Learning Tags for this Course.

The Accounts associated with this Course.

The unique identifier of the Course.

The Code of the Course.

The name of the Course.

The unique identifier of the Course.

The Code referring to the Course.

The name of the Course.

The unique identifier of the Course Category.

The unique identifier of the Price Level.

The unique identifier of the Course Objective.

Details about the specific Course.

The unique identifier of the Course Outcome.

The Event which will be completed.

The first name of the Cart owner.

The last name of the Cart owner.

The e-mail of the Cart owner.

The Region the Cart belongs to.

The Currency Code the Cart belongs to.

The unique identifier of the Cart.

The Stripe Details.

The Payment Intent that was created.

The Cart the Payment Intent is for.

A list of errors encountered while running the mutation.

The Code of the Currency.

The name of the Currency.

The symbol of the Currency.

The Key of the Custom Field

The label of the Custom Field

The type of the Custom Field

A description explaining the use of the Custom Field

The list of options of the choice or multichoice Custom Field

The unique identifier of the Custom Field Filter.

The label of the Custom Field Filter.

The type of Custom Field Filter.

The Custom Fields mapped to the Custom Field Filter. Will use these Custom Fields to apply the Filter to.

A unique key for the Custom Field Filter.

The Label of the Custom Field Filter.

The type of Custom Field Filter.

Field must be equal to value.

Field must be like value.

Field must be in provided values.

Field must have all provided values.

The label of the Custom Field Option

The value of the Custom Field Option

A true or false boolean.

Can pick a single option from a list.

The code of a Country available in the options list.

A calendar day.

A local date, and time.

A reference to a document stored in the Document Management System (DMS).

An e-mail address.

Formatted text stored as HTML.

A whole number, including sign if negative.

A Language available in the options list.

Can pick multiple options from a list. When storing a value use a pipe (|) separated list of values.

A number with optional decimal point.

Short unformatted text input, suitable for a one-line input field.

Unformatted text input, suitable for a multi-line input field.

A local time.

A web address.

The unique identifier key for the Custom Field.

The value for the Custom Field.

Online via LMS.

In a Classroom setting.

Both Online and in a Classroom setting.

The unique identifier of the Document Objective.

The unique identifier of the Document Outcome.

The unique identifier of the Event.

The code of the Event

The name of the Event.

The Price of the Event.

The Tax of the Event.

The Delivery Method of the Event.

The Location of the Event.

The Venue of the Event.

The start of the Event.

The end of the Event.

The Time Zone of the Event.

How many places remain until the Event is fully booked.

The Course the Event was created from.

The number of days this Event is accessible for. Only applicable for self-paced Events.

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

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

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

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

The total amount of places available on the Event.

The Prices applicable to the Event.

The Price Levels applicable to the Event.

The locale of the Event.

When Students can begin to Register to the Event.

Whether the Registration for the Event is open yet.

The Categories for this Event

The number of Sessions that make up this Event

The header image URL for the Course for the Event.

The Instructors for the Event

The unique identifier of the Event Booking.

The name of the Event.

The Location of the Event.

The start of the Event.

The end of the Event.

The header image URL for the Course for the Event.

The total amount of Students who have booked onto the Event.

The total amount of places available on the Event.

The total amount of places remaining on the Event.

The Course the Event was created from.

The Price of the Event.

The Type of the Event Booking.

The total amount of Unnamed Learners on this Event.

The total amount of Named Learners on this Event.

The Learners managed by the current Coordinator

The Instructors for the Event

Open to the Public.

Private.

The unique identifier of the Event.

The Code of the Event.

The name of the Event.

The start of the Event.

The end of the Event.

How many places remain until the Event is fully booked.

The Location of the Event.

The Learning Mode of the Event.

The unique identifier of the Event.

The name of the Event.

The name of the Location for the Event.

The Delivery Method of the Event.

The code of the Course the Event was created from.

The start of the Event in the event's local time (requires a datetime without offset)

The end of the Event in the event's local time (requires a datetime without offset)

The start of the Event (requires a time-zone aware datetime).

The end of the Event (requires a time-zone aware datetime).

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

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

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

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

A Learning Category associated with the Course for this Event.

The type of Event.

How many places remain until the Event is fully booked.

The code of the Region for the Event.

The unique identifier for the Location of the Event.

The first Session Start Time.

The last Session End Time.

Which day of the week the Event runs on.

The Locale of the Event.

Whether the Event is Active and can be Booked or not.

The unique identifier for the Event Learner.

Whether the Event Learner is cancelled or not.

The Contact record for the Event Learner.

The Registration for the Event Learner.

The quantity of Event Learners if the Event Learner is unnamed.

Whether the Event Learner is linked to a Contact or not.

The Event Learner Custom Field Values.

The Learning Path of the Event Learner.

The unique identifier of the Learner to be cancelled.

The Learner that was cancelled.

A list of errors encountered while running the mutation.

The unique identifier of the Line Item.

The number of Line Items to be sold.

The price charged for a single Line Item.

The tax exclusive price charged for all Items of this Line.

The total tax amount charged for all Items of this Line.

The tax inclusive price charged for all Items of this Line.

The Tax Type applicable to this Line Item.

The underlying Product (Event) for this Line Item.

A list of Learner details for this Line Item.

The Pricing Agreement Price applied to this Line Item.

The Line Items that are children of this Line Item.

Whether the Line Item can be reserved.

Whether the Line Item reservation has expired.

Whether the Line Item is reserved.

The Price Level applied to this Line Item.

Attribute definitions that can be provided with each Learner

The unique identifier of the Event Objective.

Details about the specific Event.

Whether the ability to Request Events or not is enabled.

When a Request has been sent, this message will be displayed.

The unique identifier of the Event Option.

The Event chosen.

The Code of the Course the Event was created from.

The Code of Region of the Event.

How many places remain until the Event is fully booked.

The Location name of the Event.

The unique identifier of the Location.

The start of the Event.

The end of the Event.

The unique identifier of the underlying Contact for the Learner.

The Learner Custom Field Values.

The unique identifier of the External Objective.

The name of the External Objective.

The unique identifier of the External Outcome.

Attribute the error relates to.

Value that triggered the error.

Error message and resolution hint.

Field must be equal to value.

Field must be greater than or equal to value.

Field must be greater than value.

Field must be null.

Field must be less than or equal to value.

Field must be like value.

Field must be less than value.

Field must be in provided values.

Field must not be in provided values.

Field must not equal value.

Field must not be null.

The name of the Financial Unit.

The symbol of the Financial Unit.

The Code of the Financial Unit.

The unique identifier of the Gift Voucher.

The Gift Voucher code.

Which Currency the Gift Voucher is for.

The balance of the Gift Voucher.

When the Gift Voucher is valid until.

The amount that the Application represents.

The Gift Voucher that was applied.

The unique identifier of the Gift Voucher Configuration.

The code of the Configuration

The name of the Configuration.

The Code of the Currency for the Configuration.

The Price of the Configuration.

A Linked Item for the Configuration.

The description of the Configuration.

The Category of this Gift Voucher Configuration

The header image URL for the Gift Voucher.

The unique identifier of the Communication Template.

The name of the Communication Template.

The unique identifier of the Communication Template.

The name of the Communication Template.

The type of Delivery Method the Communication Template is intended to be used with.

The unique identifier of the Line Item.

The number of Line Items to be sold.

The price charged for a single Line Item.

The tax exclusive price charged for all Items of this Line.

The total tax amount charged for all Items of this Line.

The tax inclusive price charged for all Items of this Line.

The Tax Type applicable to this Line Item.

The underlying Product (Gift Voucher) for this Line Item.

A list of Learner details for this Line Item.

Details of the recipient of the Gift Voucher for this Line Item.

The Pricing Agreement Price applied to this Line Item.

The Line Items that are children of this Line Item.

Whether the Line Item can be reserved.

Whether the Line Item reservation has expired.

Whether the Line Item is reserved.

The Price Level applied to this Line Item.

Attribute definitions that can be provided with each Learner

The name of the Recipient.

The e-mail of the Recipient.

The first line of the Recipient Postal Address.

The second line of the Recipient Postal Address.

The Town of the Recipient Postal Address.

The postcode of the Recipient Postal Address.

The Country of the Recipient Postal Address.

The name of the Gift Voucher Recipient.

The email address of the Gift Voucher Recipient.

The Postal Address of the Gift Voucher Recipient.

The personalized message to be sent to the Recipient with the Gift Voucher.

The unique identifier of the Email Configuration to send to the Recipient.

The first line of the Gift Voucher Recipient's Postal Address.

The second line of the Gift Voucher Recipient's Postal Address.

The town of the Gift Voucher Recipient's Postal Address.

The postcode of the Gift Voucher Recipient's Postal Address.

The unique identifier of the Country of the Gift Voucher Recipient's Postal Address.

The Brand from the Host Lookup Service for your Portal.

The Client ID from the Host Lookup Service for your Portal.

The Domain from the Host Lookup Service for your Portal.

The staff identifier of the Instructor.

The name of the Instructor.

The unique identifier of the Invoice Payment Provider.

The Attribute Definitions linked to the Payment Provider.

The Billing Account to attribute the Payment to.

The Billing e-mail to send the Invoice to.

The unique identifier for the Learner.

Whether the Learner is cancelled or not.

The Contact record for the Learner.

The Registration for the Learner.

The Learner Custom Field Values.

The Learning Path of the Learner.

The unique identifier key for the Learner Custom Field.

The Learner Custom Field value.

The first name of the Learner.

The last name of the Learner.

The e-mail of the Learner.

The Learner Attributes beloning to the Learner.

Learners without an Administrate Contact.

Learners with an existing Administrate Contact.

Learners that will not be associated with a Contact for the time being, usually because their identity will be known at a later stage.

The unique identifier of the Learner.

The underlying Contact Name of the Learner.

Whether the Learner is cancelled or not.

Whether the Learner is unnamed or not.

Classroom based Event

Self-paced Event

Classroom and Self-paced Event

The unique identifier of the Learning Objective.

The unique identifier of the Learning Outcome.

The unique identifier of the Learning Path.

The code of the Learning Path

The name of the Learning Path.

The Learning Category of the Learning Path.

The Price of the Learning Path.

The start of the Learning Path.

The end of the Learning Path.

How many places remain until the Learning Path is fully booked.

When Registration closes for the Learning Path and no more Learners can be Registered.

Whether a Learner must fulfill all the Course Objectives with concrete Event Objectives to be Registered on this Learning Path.

The header image URL for the Learning Path.

The Image Gallery URLs for the Learning Path.

A description of what is included in the Learning Path.

The current state of the Learning Path (active, archived, cancelled, draft).

The Custom Field values associated with the Learning Path.

The Prices applicable to the Learning Path.

The Price Levels applicable to the Learning Path.

The Locale of the Learning Path.

Whether the Learning Path contains only Event and External Objectives.

Whether the Learning Path is Featured i.e. sorted to the top of the Catalog.

The Learning Objectives that make up the Learning Path. These can be completed by the Learner.

Published Training Pass Type Identifiers that grant access to the Learning Path.

The Categories of this Learning Path

The Learning Tags for this Learning Path.

The Accounts associated with this Learning Path.

The unique identifier of the Learning Path Booking.

The name of the Learning Path.

The Learning Category of the Learning Path.

The Price of the Learning Path.

The start of the Learning Path.

The end of the Learning Path.

A description of what is included in the Learning Path.

The header image URL for the Learning Path.

The Custom Field values associated with the Learning Path.

Any Learners registered to the Learning Path.

The unique identifier of the Learning Path.

The name of the Learning Path.

Whether a Learner must fulfill all the Course Objectives with concrete Event Objectives to be Registered on this Learning Path.

Details about the nested Learning Objectives.

The unique identifier of the Learning Path.

The name of the Learning Path.

The current state of the Learning Path (active, archived, cancelled, draft).

The start of the Learning Path.

The end of the Learning Path.

When Registration closes for the Learning Path and no more Learners can be Registered.

Whether the Learning Path contains only Event and External Objectives.

The Location of an Event Objective on the Learning Path.

The Region Code of an Event Objective on the Learning Path.

The unique identifier of the Locale of the Learning Path.