GraphQL API

Features

• We added lmsLoginEmailAddress to a Contact to return the email address which a user uses to log into the LMS Portal.

• We added the passAccessExpired filter to the Learners query, which allows you to filter learners based on if their access via a Training Pass has expired. If the learner was not registered with a Training Pass, the value will be false.

• We added the ability to associate TrainingTokenIssues with contacts:

  • A new field contacts has been added, this will eventually be used to track which Contacts receive Communications related to any lifecycle changes of said Token Issue.

  • A mutation was added to TokenIssues (setContacts) which sets the aforementioned Contacts.

• We added removePassType to TrainingPass, which allows you to delete a Training Pass Type if it is in draft status.

• We added the upsertByExternalId and upsertBatchByExternalId mutations to Account. upsertByExternalId allows you to create or update an Account identified by an External ID. upsertBatchByExternalId allows you to perform this action for up to 1000 Accounts.

• We added a mutation to update an ExternalLog with an ExternalLogOrigin which allows developers to capture where an ExternalLog is being sent from.

Deprecation notices

• The name, description, and instructions fields for LmsContent have been marked deprecated and will be removed on July 26, 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 login 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.