Product documentation

2022-11-07 Developer notes

  1. GraphQL API
  2. WebLink API
  3. WebLink Widgets

GraphQL API

Features

Fixes

Deprecation notices

  • PostalAddress.provinceCode is being removed on November 10, 2022, it has been replaced with a new PostalAddress.province field. This fixes the previous antipattern and introduces the appropriate nested object.
  • Deprecated includedInTrainingPasses on CatalogItems (CourseTemplate and LearningPath) in favor of includedInPassTypeIds for better API performance. It will be removed on November 11, 2022.
  • The fields instructions and description for the createLmsResource mutation and updateLmsResource mutation have been deprecated. These values can now be set using displayName and htmlDescription matching the LmsContent fields. These deprecated fields will be removed on December 5, 2022.
  • The WebLinkPortal.updateAccountForExistingContacts field is being removed December 10, 2022. This setting had no effect.
  • A validation to prevent archived token types being used in the trainingTokenIssues.create mutation will be introduced on January 17, 2022. If an archived training token type is used, an error will be returned. As this is a change in behavior, we are treating it as a deprecation of functionality.

WebLink API

Features

  • (Preview) The WebLink API has a new mutation WorldpayMutations.startCheckout which will be used in the future to begin a checkout using Worldpay as the Payment Provider. This feature is still under development and should not be used.

WebLink Widgets

Features

  • The EventList widget for WebLink Widgets has been updated to allow “End Date” and “Date and Time” columns to be displayed. These are hidden by default, but can be configured to provide other options for viewing event dates and times.