GraphQL API

Features

• We have added fields isPremium and includedInPassTypeIds to LmsContent for Events and Course Templates to identify content that is Premium and what Training Pass Type they require to be accessed.

• (Preview) Renamed ExternalCalendar to Activity. This will hold time periods when Instructors are busy.

• (Preview) added support for multiple sessions per event in Planner Event Needs. In particular, exposes mutations to the SessionNeed entity, which captures the details of each of the (one or more) sessions associated with an event, including session start time, instructor, and resources. New mutations added are:

• • updateSessionNeed updates Session Need details; this currently includes only the Session start time. We also added an associated GraphQL Input type, PlanSessionNeedUpdateInput to support this mutation.

  • setSessionNeedInstructors sets the Instructors for a session using the GraphQL Input type, PlanSessionNeedInstructorUpdateInput. Currently, only a single instructor can be assigned to a session, but the input type reflects our plan to allow multiple instructors in the future.

  • setSessionNeedResources sets the Resources required by the Session; it uses the new PlanSessionNeedResourceUpdateInput GraphQL Input type. We currently support Sessions with up to eight Resources. Note that Sessions with no resources are also meaningful and supported.

Deprecation notices

• The name, description, and instructions fields for LmsContent have been marked deprecated and will be removed on October 5, 2022. These values are available in new fields displayName and htmlDescription mapped according to Content Type.

• Two LearningOutcomeMutations, recordDocumentDownload and recordUrlVisit, are being removed on October 20, 2022. These Learning Path mutations have been replaced with LearnerMutations recordResourceDownload and recordExternalContentAccessed.

• URLObjectives and DocumentObjectives and their outcomes are being removed from Learning Paths on October 20, 2022. These are Learning Path Objectives that were supported in an older version of the API, and were never configurable through GraphQL. There is very limited usage of these by Administrate Users.

• ContactCredentialsMutations (resetPassword, requestPasswordResetTokenForUsername, signIn and signInViaSingleSignOn) are being removed on October 21, 2022. These were used by an older version of the Administrate LMS which is being decommissioned.

• LMSConfiguration.loginViaIDP is being removed on October 21, 2022, as all LMS portals should now log in via the Administrate identity service or configure a BrandIdentityProviderConfiguration.

• isContactCredentialsPasswordResetTokenValid is being removed on October 21, 2022, as all password resets should be handled by the identity provider, not the GraphQL API.

• PostalAddress.provinceCode is being removed on November 10, 2022, it has been replaced with a new PostalAddress.province field. This fixes the previous anti-pattern 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