GraphQL API

Features

• We added isActive field to the Event type, which is true when the Event is published (i.e. not cancelled or draft) and has an end date that has not yet passed.

• A new field has been added to WebLink Portals named trainingTokens - this shows the Training Token Types for which TokenIssue Payment Codes can be used during checkout.

• (Preview) You can now update an Opportunity Financial Unit with the OpportunityMutations.updateFinancialUnit mutation. Only updating to a Token Financial Unit is currently supported. A new Opportunity will be created with the previous details and any Event Interests with a Price in that Token Financial Unit added. Course and Learning Path Interests will be supported later.

• (Preview) Added applyPaymentCode to OpportunityMutations. This allows opportunities to be paid by applying a paymentCode attached to a TokenIssue, provided the account tied to the Opportunity also owns the tokens.

• An Opportunity type attribute field now allows an optional boolean parameter ownPortalOnly (default: false) – if set to true, it will only return OpportunityAttributes that are mapped as the opportunity’s portal point of sale order fields, which is an upcoming weblink and LMS feature.

Fixes

• We have fixed an issue in the Opportunity update mutation, where updating attributes mapped to an Account or a Contact field would not cause the related Account or Contact to update as well.

• We have fixed an issue in the OpportunityAttribute type which would sometimes return incorrect options for non-mapped multichoice attributes.

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

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