GraphQL API

Features

• The includedInPassTypeIds field when querying Courses and Learning Paths now includes draft TrainingPassTypes as well as published.

• We added two fields to EmailAccount to allow enabling and disabling of CRM and Enquiry Integrations

• The Email Folders of an Email Account can now be managed via GraphQL:

  • The Email Folders of an Email Account can be queried via the Email Account query

  • Which Email Folders of an Email Account are selected can be updated via the Email Account update mutation

  • The Email Folders of an Email Account can be updated with those at the provider via the Email Account updateEmailFoldersFromProvider mutation

• We are introducing the concept of “Order point of sale fields”, which will allow capturing additional booker information for WebLink and LMS orders (similar to Point of Sale Fields for learners). We have now introduced a new root query orderPointOfSaleFields  that will return the configuration of these fields. It will be followed by mutations to create or update these configurations, and updates to the Weblink and LMS interfaces to surface the functionality.

Fixes

• We fixed an issue where we were not returning OpportunityAttributes mapped values for opportunities with a contact, account or invoice. Querying for opportunities will now return the Account, Contact or Invoice field value for Attributes mapped to these entities in the new field mappedValue on CustomFieldValue.

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 LearnerMutationsrecordResourceDownload 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

• 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 12, 2022.

• The WebLinkPortal.updateAccountForExistingContacts field is being removed December 10, 2022. This setting had no effect.