Changelog for V2 API

This is a place to see any changes that are made to the V2 API. Entries here will include the date the changes were pushed to SCORM Cloud and a brief description of what changed.

Changelog

2025-08-27

• Changed minimum and maximum values allowed for the following configuration settings:
  • PlayerCommCommitFrequency - minimum of 5000 and maximum of 60000 milliseconds
  • PlayerCommMaxFailedSubmissions - minimum of 0 and maximum of 20 failed submissions

2025-01-22

• Added ability to set tags on imported courses in the following course service endpoints:
  • CreateUploadAndImportCourseJob
  • CreateNoUploadAndImportCourseJob
  • CreateFetchAndImportCourseJob
• Added optional isEnabled parameter to GetDispatches

2023-12-01

• Changed schemas returned from GetDestination and GetDestinations:
  • Changed DestinationSchema to DestinationInfoSchema
  • Changed DestinationIdSchema to DestinationInfoIdSchema
  • Changed DestinationListSchema to DestinationInfoListSchema
• Changed schema returned from CreateCredential from CredentialCreatedSchema to CredentialSchema
• Changed schema of launchLinkRequest in BuildCoursePreviewLaunchLink and BuildCoursePreviewLaunchLinkWithVersion from LaunchLinkRequestSchema to PreviewLaunchLinkRequestSchema

2023-11-27

• Added optional includeDispatchCount parameter to GetDestination and GetDestinations
• Added name_asc and name_desc options to the orderBy parameter in GetDestinations
• Added ability to set notes in CreateDestinations
• Added ability to remove notes in SetDestination
• Added validations for destination names to CreateDestinations and SetDestination

2023-07-24

• Changed realm behavior to prevent removal of the last secret key in its default application

2023-07-18

• Added duplicateRegistrationOption parameter to CreatePrivateInvitation

2023-06-02

• Fixed bug where the startSco parameter was not respected in BuildCoursePreviewLaunchLink
• Fixed error message in DeleteApplicationConfigurationSetting when the configuration setting is not set at that level

2023-05-05

• Fixed URL parameter validation in course import job methods that resulted in a 500 response

2023-04-12

• Fixed bug where the cssUrl parameter was not respected in BuildRegistrationLaunchLink
• Fixed 500 error thrown from GetRegistrations when filterBy = tags and includeTotalCount = true

2023-03-09

• Changed DeleteAllLearnerData to prevent users from initiating a delete request for themselves
• Fixed DeleteAllLearnerData to return a 403 or 404 HTTP error response code when appropriate (corrected from 500)
• Fixed bug that prevented sparse updating of Content Vault API settings
• Fixed bug that caused Content Vault settings to persist for a resource after it was deleted

2023-02-16

• Added additional configuration settings at the Application level:
  • ApiImportResultsPostbackUrl
  • AppLrsAuthCallBackUrl
  • PrivacyPolicyText
  • CloudPrivacyPolicyEnabled
  • CustomerPrivacyPolicyEnabled
• Added launchHistoryId to GetRegistrationLaunchHistory
• Added validations for the LaunchAuthType schema on all applicable endpoints
• Changed BuildRegistrationLaunchLink to prevent setting blank additionalvalues
• Fixed GetPrivateInvitationJobStatus to return an error message from a failed invitation job

2023-01-25

• Added created and updated date-time fields to GetCredentials and CreateCredential
• Fixed CreateCredential to return a 409 HTTP error response code when attempting to create a credential with a duplicate name (corrected from 400)

2023-01-10

• Fixed UpdateApplication to not return an error if updating an application to its current name

2022-11-08

• Added optional includeTotalCount parameter to several endpoints. This will include a header in the response with an estimated count of objects matching the provided filters

  • GetApplications
  • GetCourses
  • GetDispatches
  • GetDestinations
  • GetDestinationDispatches
  • GetAllInvitations
  • GetPublicInvitations
  • GetPublicUserInvitations
  • GetPrivateInvitations
  • GetPrivateUserInvitations
  • GetRegistrations
  • GetXapiCredentials

• Removed UNSECURED as an empty auth type for the GetLti13DispatchLaunch endpoint

2022-10-11

• Added new AppManagement API endpoint for getting a paginated list of applications: GetApplications
  • Deprecated GetApplicationList
• Fixed issue with CreateFetchAndImportCourseJob where large courses would cause a timeout
• Update the HTTP error response code for invalid characters passed in on some course API calls to 400 (corrected from 403)

2022-09-15

• Added admin:connector to the list of valid scopes so that the content connector endpoints can be used with OAuth tokens
• Added write:dispatch as a valid scope OAuth for changing dispatch and destination registration count with resetDestinationDispatchRegistrationCount and resetDispatchRegistrationCount
• Fixed issue with read and read:dispatch OAuth scopes when calling GetLti13Dispatch and GetLti13ToolConfigurationSchema

2022-08-02

• Registration postbacks for registrations created from a dispatch package will now contain the dispatchId
• Public invitation response objects will now contain the email template information, if present
• Destination response objects now contain the updated and created timestamps

2022-07-05

• Various bug fixes around validation errors in API parameters
• Added support for 4 new languages to be set as the culture code on launch links: Czech, Romanian, Slovak, and Ukrainian

2022-06-22

• Added LTI 1.3 Platform support. The following API endpoints were added:
  • GetLti13ToolConfigurationSchema
  • GetLti13Dispatch
• Fixed a bug with course import postbacks which didn’t report import failures

2022-03-04

• Various bug fixes for LTI 1.3 Dispatch API
  • CreateDestinations now appropriately handles invalid lti13Data
  • Fix error handling when trying to access identifiers that don’t exist

2022-02-22

• Added GetCourseZip method for downloading course zip files
• Added LTI 1.3 Tool support via Dispatch. The follow API endpoints were added:
  • GetLti13DispatchLaunch
• Added support for YouTube videos and generic URLs as course import contentTypes.

2021-12-16

• Changed the learningStandard parameter values for GetApplicationConfiguration, SetApplicationConfiguration, and DeleteApplicationConfigurationSetting to reflect the accepted values

2021-11-01

• Added additional application management service endpoints

  • GetApplicationInfo - Retrieve detailed information about the application
  • UpdateApplication - Update information about the application
    

• Added additional course service endpoints

  • GetCourseAsset - Downloads an asset file from a course
  • GetCourseVersionAsset - Downloads an asset file from a specific course version
  • GetCourseFileList - Gets the file structure of a course
  • GetCourseVersionFileList - Gets the file structure of a specific course version
  • DeleteCourseAsset - Deletes an asset file from a course
  • DeleteCourseVersionAsset - Deletes an asset file from a specific course version
    

• Added additional dispatch service endpoints

  • UpdateDispatches - Updates a group of dispatches simultaneously
  • DeleteDispatches - Deletes a group of dispatches simultaneously
    

• Standardized parameter list for several endpoints. This involved adding additional parameters to several endpoints as well as reordering the parameters

  • GetCourses
  • GetDispatches
  • GetDestinations
  • GetDestinationDispatches
  • GetAllInvitations
  • GetPublicInvitations
  • GetPublicUserInvitations
  • GetPrivateInvitations
  • GetPrivateUserInvitations
  • GetRegistrations
  • GetXapiCredentials
    

• Removed cssUrl parameter from BuildCoursePreviewLaunchLink. The cssUrl in the LaunchLinkRequestSchema remains unchanged

• Changed the schema for the CreateApplication, UpdatePublicInvitation, and UpdatePrivateInvitation endpoints to only include the values that can be modified

2021-05-27

• Added additional course service endpoints
  • UploadCourseAssetFile - Upload an asset file from your local file system into a course
  • ImportCourseAssetFile - Import an asset file via public url into a course
  • UploadCourseVersionAssetFile - Upload an asset file from your local file system into a specific course version
  • ImportCourseVersionAssetFile - Import an asset file via public url into a specific course version

2020-06-22

• Changed successful response for CreateXapiCredential from 204 to 200

2020-06-17

• Changed successful response for CreateDestinations and ResetDestinationDispatchRegistrationCount from 200 to 204