GraphQL API

Features

• The Learning Path addPrice and updatePrice mutations now accepts an optional tokenTypeId (exclusive with currencyCode) parameter which allows pricing the Path in Training Tokens rather than a Currency.

• We have added a new includeInvoice field to the WeblinkOrderConfirmation type. This field denotes whether the Invoice for the WebLink order should be included in the email sent to the buyer. The value of this field can be updated using the create or update Portal mutations.

• 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. The deprecated fields will continue to be available until 2022-12-05, at which point they will be removed.

• We have deprecated the WebLinkPortal.updateAccountForExistingContacts field. This setting had no effect. It will be completely removed in 90 days time.

• courseTemplateCount and learningPathCount are now available from a TrainingPassType. These provide the total number of Course Templates and Learning Paths that are included in the Training Pass Type.

• You can now update an Opportunities FinancialUnit with the OpportunityMutations updateFinancialUnit mutation. Only updating to a Token Financial Unit is currently supported. A new Opportunity will be created with the previous Opportunity details and any Interests with a Price in that Token Financial Unit added.

Fixes

• When merging two accounts with the Account merge mutations, the credit notes from the account you are merging from will now also be transferred to the account you are merging into.

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.