Brightspace October 2024¶

Our Brightspace ILP in continuous delivery provides these no features and changes since the release of September 2024.

Brightspace September 2024¶

Our Brightspace ILP in continuous delivery provides these new features and changes since the release of August 2024:

Learning Environment. Version 20.24.9 of the Learning Environment includes these change:

• We’ve added a list of links to the dropbox JSON structure to let you retrieve feedback file and link information along with the regular dropbox properties.

• We’ve added a new action to retrieve links to dropbox feedback.

Brightspace August 2024¶

Our Brightspace ILP in continuous delivery provides these new features and changes since the release of July 2024:

Learning Environment. Version 20.24.8 of the Learning Environment includes these changes:

• We’ve added a new action to request the current user's submissions.

• We’ve included support for specifying paging type in quizzes.

• We’ve included support for course completion tracking as a target to retrieve and replace the conditions on a target in an org unit.

Brightspace July 2024¶

Our Brightspace ILP in continuous delivery provides these new features and changes since the release of June 2024:

Learning Environment. Version 20.24.7 of the Learning Environment includes these changes:

• We’ve added a Color property to the content module JSON structure.

• We have removed support for user notification by notification number attributes and actions as they no longer have a supporting product feature in the back-end service.

Brightspace June 2024¶

Our Brightspace ILP in continuous delivery provides these new features and changes since the release of May 2024:

Learning Environment. Version 20.24.6 of the Learning Environment includes these changes:

• We have added the specific OAuth2 scope dropbox:folders:read to the action to retrieve a dropbox submission file.

Brightspace May 2024¶

Our Brightspace ILP in continuous delivery provides these new features and changes since the release of April 2024:

Learning Environment. Version 20.24.5 of the Learning Environment includes these changes with version v1.75 of the LE API:

• We’ve added IsStartDateShown and SortOrder properties to the NewsItem object and to the NewsItemData object.

• We’ve also added OAuth2 scopes to many of the news routes. When building new applications that use these actions you should use these new specific scopes.

Learning Platform. Version 20.24.5 of the Learning Platform includes these changes:

• We’ve added a new optional paged list version of the action to list the Advanced Data Set export jobs that you've started and removed the page parameter from that action.

Awards Service. Version 20.24.5 of the Awards Service includes these changes:

• As of this release, issued certificates that have been revoked will return a 410 status code in the action to retrieve a certificate.

Brightspace April 2024¶

Our Brightspace ILP in continuous delivery provides these new features and changes since the release of March 2024:

Learning Environment. Version 20.24.4 of the Learning Environment includes these changes:

• We’ve added new actions to support adding domain name mappings to enable coalescing multiple legacy LTI tool domains into a single registered LTI Advantage tool domain.

Learning Platform. Version 20.24.4 of the Learning Platform includes these changes:

• We’ve added a new file management action (and attributes) to let you retrieve the contents of a file location in an org unit’s file storage.

Awards Service. Version 20.24.4 of the Awards Service includes these changes:

• With BAS v1.3 and forward, we’ve added an action to let you retrieve a certificate by its Id. As of LMS v20.24.4, all issued certificate awards will have such a Certificate Id; otherwise, issued awards will have a null Certificate Id value.

• As of LMS v20.24.4, we’ve added the CertificateId to the issued award attribute; it will be null in certificate awards issued prior to LMS v20.24.4, and in all badge awards.

Brightspace March 2024¶

Our Brightspace ILP in continuous delivery provides no new features or changes since the release of February 2024.

Brightspace February 2024¶

Our Brightspace ILP in continuous delivery provides no new features and changes since the release of January 2024.

Brightspace January 2024¶

Our Brightspace ILP in continuous delivery provides no new features and changes since the release of December 2023.

Brightspace December 2023¶

Our Brightspace ILP in continuous delivery provides the following feature new features since the release of November 2023.

Learning Platform. Version 20.13.12 of the Learning Platform includes this change:

• We’ve added a new action to terminate both a user’s active web sessions and active API access for that user.

Brightspace November 2023¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of October 2023.

Learning Environment. Version 20.23.11 of the Learning Environment includes these changes:

• We’ve included support for negative marking schemes in quizzes by adding a DeductionPercentage property to the QuizReadData, QuizData, and QuizQuizAttemptData JSON structures.

Learning Platform. Version 20.23.11 of the Learning Platform includes these changes:

• We’ve added a new action to create new users in a batch.

• We’ve added a new action to create or update enrollments for users in a batch.

• We’ve added new actions to support management of local authentication security overrides.

Brightspace October 2023¶

Our Brightspace ILP in continuous delivery provides no new features and changes since the release of September 2023.

Brightspace September 2023¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of August 2023.

Awards Service. Version 20.23.9 of the Awards Service includes these changes:

• We’ve added a new query parameter (useIssueDateToCalcExpiry) for version 1.1 and forward of the action to issue an award to control whether to use the issued award’s issue date or the action’s execution date to calculate the issued award’s expiry date.

Learning Environment. Version 20.23.9 of the Learning Environment includes these changes:

• We’ve added a new action to delete a dropbox folder.

• We have removed support for the ISBN/Book Management attributes and actions as they no longer have a supporting product feature in the back-end service.

• We’ve added an IsSynchronous property to the QuizReadData and QuizData JSON structures, which indicates if a quiz is synchronous or asynchronous.

• We’ve added an AttemptIsSynchronous property to the QuizAttemptData JSON structure, which indicates if a quiz attempt was taken synchronously or asynchronously.

Brightspace August 2023¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of July 2023.

Learning Environment. Version 20.23.8 of the Learning Environment includes this change:

• We’ve added an IsBroken property to the ContentObject JSON structures.

• We’ve added an IsPinned property to the NewsItem and NewsItemData JSON structures.

Brightspace July 2023¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of June 2023.

Awards Service. Version 20.23.7 of the Awards Service includes these changes:

• We’ve added a new version (v1.2) for the Awards Service, to allow for a new Criteria property on Awards structures.

Learning Environment. Version 20.23.7 of the Learning Environment includes these changes:

• As of LE API v1.71, we’ve simplified the configuration of a quiz's late submission type: via the API you can no longer specify the “use late limit” option (or specify the late-limit minutes value); if you try to configure a quiz with the “use late limit” option, Brightspace will instead use the “auto submit attempt” option.

Learning Platform. Version 20.23.7 of the Learning Platform includes these changes:

• New structures and actions to support managing a course’s collection of files.

Brightspace June 2023¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of May 2023.

Learning Platform. Version 20.23.6 of the Learning Platform includes these changes:

• We have removed use of the legacy BDS data export actions with LP API v1.44 and forward. Their use with LP API versions 1.35 through 1.43 are still supported by not recommended; applications should avoid use of the legacy actions and use their replacement actions instead.

Brightspace May 2023¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of April 2023.

Learning Platform. Version 20.23.5 of the Learning Platform includes these improvements:

• With LP API v1.43, we’ve added new routes for Data Hub to list the Brightspace Data Sets schemas and plugins, the extracts for a schema, the extracts for a plugin, and to download an extract.

• With LP API v1.43, we’ve moved all older Data Hub routes regarding Brightspace Data Sets to a legacy documentation section. You should by preference use the newer Brightspace Data Sets routes introduced in LP API v1.43.

Brightspace April 2023¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of March 2023.

Learning Environment. Version 20.23.4 of the Learning Environment includes these improvements:

• With LE API v1.70 we’ve enhanced the handling of date fields in ContentObjectData JSON blocks on input; now if you provide null for those fields it will remove any prior-set value instead of leaving prior-set values unaffected.

• As of the 20.23.4 release, we have added new OAuth2 scopes to content actions; actions that create or update content topics and modules now can be done with a manage scope (content:topics:manage for topics and content:modules:manage for modules). Additionally, we’ve added a readonly scope for applications that only want to have read access to content topics and modules.

  While these actions still can be used with the older content:topics:read and content:modules:read scopes, we’ve now deprecated those scopes and will remove access to them in the future.

• As of the 20.23.4 release, we have added new OAuth2 scopes to discussion actions; actions that create or update discussion forums, topics, and posts now can be done with a manage scope (discussions:forums:manage for forums; discussions:topics:manage for topics; discussions:posts:manage for posts). Additionally, we’ve added a readonly scope for applications that only want to have read access to discussion forums, topics, and posts.

  While these actions can still be used with the older discussions:forums:read, discussions:topics:read, and discussions:posts:read scopes, we’ve now deprecated those scopes and will remove access to them in the future.

Brightspace March 2023¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of February 2023.

Learning Environment. Version 20.23.3 of the Learning Environment includes these improvements:

• We’ve added a new route for LTI Advantage to view the status of all migration jobs.

Learning Platform. Version 20.23.3 of the Learning Platform includes these improvements:

• We have removed the obsolete action /d2l/api/lp/(version)/dataExport/schema/bds (previously only available in an unstable version) from the public API.

Brightspace February 2023¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of January 2023.

Learning Environment. Version 20.23.2 of the Learning Environment includes these improvements:

• We’ve added the AutoCreateGrade field to LTI.CreateDeploymentData and LTI.DeploymentData to allow users to set the Auto Create Grade Items toggle for LTI Advantage deployments.

Learning Platform. Version 20.23.2 of the Learning Platform includes these improvements:

• We have added specific OAuth2 scopes to a variety of actions around user data.

• We have added a UserName field to the User.User user structure.

Brightspace January 2023¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of December 2022.

Learning Environment. Version 20.23.1 of the Learning Environment includes these improvements:

• As of version 1.67 of the LE APIs, we have added support for an ignoreDateRestrictions query parameter to the action to retrieve the content table of contents to ignore date restrictions on both content topics and modules.

  Additionally, with the same version (1.67) we ignore any use of the ignoreModuleDateRestrictions query parameter on the same action.

• We’ve added the AutoMigrateLinks field to LTI.CreateDeploymentData and LTI.DeploymentData to allow users to set the Auto Migrate Links toggle for LTI Advantage deployments.

Brightspace December 2022¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of November 2022.

Learning Environment. Version 20.22.12 of the Learning Environment includes these improvements:

• We’ve added Paused and Cancelled as statuses for LTI Advantage migration jobs.

• You can now sort retrieved grade object values and final grade values by last modified date.

Brightspace November 2022¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of October 2022.

Learning Environment. Version 20.22.11 of the Learning Environment includes this improvement:

• We’ve added new routes for LTI Advantage to create an LTI migration job and view the status of a migration job.

• As of LP API version 1.42 the Groups.GroupCategoryData JSON block now has a new field to indicate the show/hide status of group descriptions for enrolled users. When using actions to update the settings for group categories in a course, with LP API version 1.42 and forward you should include this new field.

Brightspace October 2022¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of September 2022.

Learning Environment. Version 20.22.10 of the Learning Environment includes this improvement:

• We’ve added support for date availability types (StartDateAvailabilityType and EndDateAvailabilityType fields) to Dropbox folders (see DropboxFolder and DropboxFolderUpdateData JSON blocks).

Learning Platform. Version 20.22.10 of the Learning Platform includes this improvement:

• We’ve added intelligent agents as a target type for release conditions.

Brightspace September 2022¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of August 2022.

Learning Environment. Version 20.22.9 of the Learning Environment includes these improvements:

• As of the Brightspace 20.22.9 release, we have made generally available a new route to let you modify the order of content objects such as modules and topics.

Brightspace August 2022¶

Our Brightspace ILP in continuous delivery provides no new features or changes since the release of July 2022.

Brightspace July 2022¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of June 2022.

Learning Platform. Version 20.22.7 of the Learning Environment includes these improvements:

• We’ve added an action to let you fetch the section properties for sections in which you’re enrolled.

• We have changed the routes involved in initializing sections and updating their settings to let you decide to show or hide section descriptions from enrolled users. This introduces backwards-incompatible changes to the API as of LP version 1.39.

  1. The pre-existing route to initialize all section settings for a course has become deprecated as of LP API version 1.38, not supported in version 1.39, and will not be carried forward in future LP API contracts.

  2. As of LP API version 1.39, we’ve added a new route you should now use instead to initialize the settings for all sections in a course.

  3. As of LP API version 1.39, we’ve added a new route you use to update the settings for all sections in a course.

  4. As of LP API version 1.39, the Section.SectionSettingsData JSON block now has a new field to indicate the show/hide status of section descriptions for enrolled users. When using actions to update the settings for all sections in a course, with LP API version 1.39 and forward you should include this new field.

     (Note that this JSON block used to be called SectionPropertyData in previous documentation releases; for clarity, we are now calling this structure SectionSettingsData. This is a documentation-only change.)

Brightspace June 2022¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of May 2022.

Learning Environment. Version 20.22.6 of the Learning Environment includes these improvements:

• We have added specific OAuth2 scopes to grades routes for categories, exemptions, schemes, setup, statistics, and values.

• Note that, with this release, we have made changes to the group category creation process to require creating group categories asynchronously. This results in backwards incompatible changes to the action used to create group categories.

  We have also added a new route to let you retrieve the creation-job status for a group category; see the reference documentation for creation group categories for details.

Brightspace May 2022¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of April 2022.

Learning Environment. Version 20.22.5 of the Learning Environment includes these improvements:

• We’ve added support for vendor-specific grade types to IPSIS-related structures.

Brightspace April 2022¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of March 2022.

Learning Platform. Version 20.22.4 of the Learning Platform includes these improvements:

• We’ve added scopes to the actions to clear, reset, and update a particular user’s password.

Brightspace March 2022¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of February 2022.

Learning Framework APIs. With the introduction of LTI Advantage support, use of Remote Plugins has become deprecated and is no longer a fully supported way to consider extending the Brightspace user interface. For those interested in LTI link placements in areas other than course content, consider using quicklinks wrapped around LTI links instead. Existing Remote Plugins will continue to function; however, we’ve now removed information about the legacy Remote Plugin technology from the reference.

Learning Platform. Version 20.22.3 of the Learning Platform includes these improvements:

• We’ve added actions to let you get user attribute schemas and to let you get, delete, and update user attribute values.

Brightspace February 2022¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of January 2022.

Learning Environment. Version 20.22.2 of the Learning Environment includes these improvements:

• We’ve added a new route for LTI Advantage to list all link summaries under a deployment that includes a new LtiAdvantageLinkDataSummary attribute.

Learning Platform. Version 20.22.2 of the Learning Platform includes these improvements:

• We’ve added scopes to the list Brightspace Data Sets plugins and download Brightspace Data Sets plugin routes.

Brightspace January 2022¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of December 2021.

Learning Framework APIs. Version 20.22.1 of the Brightspace Learning Framework API reference has removed documentation for the D2L Client SDKs that provide support for the legacy ID-Key authentication system. New application development using the Brightspace Learning Framework APIs should choose OAuth 2 as the preferred authentication mechanism. The legacy D2L Client SDK code is still available from the Brightspace Github organization.

Learning Platform. Version 20.22.1 of the Learning Platform includes these improvements:

• User Alerts now have a FeedMessageSubjectId field. See Alerts.Alert for more information.

• We have added actions to manage the custom widget data for a specific user identified by their user ID.

Brightspace December 2021¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of November 2021.

Learning Environment. Version 20.21.12 of the Learning Environment includes these improvements:

• As of version 1.60 of the API, sorting for grade result APIs respects the user’s SortLastName if it is set. See User.LegalPreferredNames for more information.

Learning Platform. Version 20.21.12 of the Learning Platform includes these improvements:

• We’ve added the IncludeInFinalGrade field to LTI.CreateDeploymentData and LTI.DeploymentData to allow users to set the Grades created by LTI will be included in Final Grade checkbox for deployments.

• Clients using OAuth2 authentication can now use more granular scopes when calling the Enrollments, Groups and Sections routes. We’ve also modified routes that used the enrollments:own_enrollment:read scope to now use the enrollment:own_enrollment:read scope.

• We’ve added scopes to the update course offering, get course offering, and delete course offering routes.

• We’ve added the SortLastName field to the User.LegalPreferredNames structure. Version 1.34 (and later) API users must include the new SortLastName property when updating names, and will receive it when retrieving them.

• We’ve added a new route for retrieving semester and department information for requested courses.

Brightspace November 2021¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of October 2021.

Learning Platform. Version 20.21.11 of the Learning Platform includes these improvements:

• We’ve clarified that, with the action to retrieve the list of Data Set plugins, the optional pageSize parameter does not guarantee that a response cannot include fewer entries; if you use this action, you must be able to handle paginated results.

Brightspace October 2021¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of September 2021.

Learning Platform. Version 20.21.10 of the Learning Platform includes these improvements:

• Clients using OAuth2 authentication can now use more granular scopes when calling the LTI Advantage routes.

Brightspace September 2021¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of August 2021.

Learning Environment. Version 20.21.9 of the Learning Environment includes these improvements:

• We’ve added a new route to let you generate a signed URL usable for uploading a batch-data file to IPSIS.

• We have added a new action to retrieve assignment submissions using paging. Callers should use this new route by preference, especially for folders with many submissions.

Learning Platform. Version 20.21.9 of the Learning Platform includes these improvements:

• Clients using OAuth2 authentication can now use more granular scopes when calling the organization Structure routes, color schemes routes, and the recycle bin routes

• We’ve added structures and actions to let the current user set their pronouns and pronoun visibility preferences. This also includes adding support for pronoun choices to the relevant user (for getting, creating, and updating user record data) and whoami structures.

  Note that, if an organization decides to support user pronouns, then the User Information Privacy settings required for API actions that require seeing all user fields will also include the ability to see user pronouns.

Brightspace August 2021¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of July 2021.

Learning Environment. Version 20.21.8 of the Learning Environment includes these improvements:

• We’ve added the Code field to the Group.GroupData fetch structure.

• We’ve added StartDateAvailabilityType, EndDateAvailabilityType fields to ToC.TableOfContents, Discussions.Forum, Discussions.ForumData, Discussions.CreateTopicData, Discussions.Topic.

Brightspace July 2021¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of June 2021.

Learning Environment. Version 20.21.7 of the Learning Environment includes these improvements:

• We’ve added AttemptDueDate, AttemptEnforceTimeLimit, AttemptSubmissionTimeLimit, AttemptSubmissionGraceLimit, AttemptSubmissionLateTypeId, AttemptSubmissionLateData fields to Quiz.QuizAttemptData.

• We’ve added the LastAccessed field to MyOrgUnitInfo.

Brightspace June 2021¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of May 2021.

Learning Environment. Version 20.21.6 of the Learning Environment includes these improvements:

• We’ve added routes to let you retrieve accommodations in an org unit for a specific user and the current user, and to update accommodations in an org unit for a specific user.

• We’ve added routes that let you add a presenter and remove a presenter for a calendar event.

• We’ve added the DisplayName, Display Role, Duration and Visibility fields to the Calendar.PresenterInfo structure.

Learning Platform. Version 20.21.6 of the Learning Platform includes these improvements:

• We’ve added routes to let you download course files.

Brightspace May 2021¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of April 2021.

Learning Environment. Version 20.21.5 of the Learning Environmnet includes these improvements:

• We’ve added routes to let you get and update Ipsis related details for grades and grade categories.

Brightspace April 2021¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of March 2021.

Learning Environment. Version 20.21.4 of the Learning Environment includes these improvements:

• We’ve added two new optional Query Parameters, moduleId and title, to allow filtering based on module ID or title when using the action to retrieve the table of contents in content.

Learning Platform. Version 20.21.4 of the Learning Platform includes these improvements:

• We have added a new action to retrieve a user’s enrollment details for parent org units of a particular org unit.

Brightspace March 2021¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of February 2021.

Learning Environment. Version 20.21.3 of the Learning Environmnet includes these improvements:

• We’ve added routes to let you download an archive of the all the files submitted to user and group dropboxes.

• We’e added support for associating language-specific captions files with content topics.

Brightspace February 2021¶

Our Brightspace ILP in continuous delivery provides no new features and changes since the release of January 2021.

Brightspace January 2021¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of December 2020.

Learning Platform. Version 20.21.1 of the Learning Platform includes these improvements:

• We’ve added the CurrentlyAvailable field to the BrightspaceDataSetReportInfo structure.

• We’ve added the SendSectionCode field to the CreateLtiLinkData, LtiLinkData, CreateLtiProviderData, and LtiToolProviderData structures to allow users to set the Send course section information to tool provider checkbox for links and tool providers.

• We’ve added the IsHidden field to the GradeObject structures for all Grade Object Types.

Brigthspace December 2020¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of November 2020.

Learning Environment. Version 20.20.12 of the Learning Environment includes these improvements:

• We’ve added the IsRetakeIncorrectOnly field to QuizReadData, QuizData and Quiz.QuizAttemptData.

Learning Repository. Version 20.20.12 of the Learning Repository includes these improvements:

• We’ve added actions to support resumable file uploads for publishing SCORM packages in Learning Repositories, letting you: initiate a resumable upload, publish a package as a new object, and publish a package to overwrite an existing object.

Brightspace November 2020¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of October 2020.

Learning Environment. Version 20.20.11 of the Learning Environment includes these improvements:

• We’ve added the OpenAsExternal field to LTI.CreateDeploymentData and LTI.DeploymentData to allow users to set the Open As External Resource checkbox for all links created under that deployment.

Learning Platform. Version 20.20.11 of the Learning Platform includes these improvements:

• We’ve added an action to retrieve information about Data Sets versions available from the back-end service.

Brightspace October 2020¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of September 2020..

Learning Environment. Version 20.20.10 of the Learning Environment includes these improvements:

• With the LE 1.47 API we added new routes to manage exemptions to content for users, which we’re making publicly available with this release: remove and create exemptions for a user on specific content topics; or, create exemptions for content topics that match a filter.

Brightspace September 2020¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of August 2020.

Learning Environment. Version 20.20.9 of the Learning Environment includes these improvements:

• We’ve added the AllowOnlyUsersWithSpecialAccess field to DropboxFolder and DropboxFolderUpdateData to allow only users with special access to see the dropbox folder.

• We’ve added new routes to remove, retrieve, create, and update special access rules for a survey.

• We’ve added new routes to remove, retrieve, create, and update special access rules for a quiz.

• We’ve added new routes to remove, retrieve, create, and update special access rules for a dropbox.

Brightspace August 2020¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of July 2020.

Learning Environment. Version 20.20.8 of the Learning Environment includes these improvements:

• We’ve added fields to track the number of words and attachments in a discussion post.

• We’ve added the AllowOnlyUsersWithSpecialAccess field to SurveyReadData and SurveyWriteData to allow only users with special access to see the survey.

• We’ve added the AllowOnlyUsersWithSpecialAccess field to QuizReadData and QuizData to allow only users with special access to see the quiz.

• We’ve added the EnableAttachments field to the LongAnswer.

Learning Platform. Version 20.20.8 of the Learning Platform includes these improvements:

• We’ve added support to retrieve all the defined languages available in the back-end service.

Brightspace July 2020¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of June 2020.

Learning Environment. Version 20.20.7 of the Learning Environment includes these improvements:

• We’ve added support for lists of Custom Parameters in LTI® Tool registrations and deployments. Note that, as of LE API v1.46, CustomParameters is a required field here, unsupported in prior versions.

• We’ve added support for the migration of LTI links from legacy versions of LTI (prior to LTI 1.3) up to LTI Advantage (LTI 1.3 and later).

• We’ve added routes to discern whether a user has access to these activities:

  • Calendar event

  • Content module

  • Content topic

  • Discussion forum

  • Discussion topic

  • Assignment

  • Grade item

  • News item

  • Quiz

  • Survey

Brightspace June 2020¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of May 2020.

Learning Environment. Version 20.20.6 of the Learning Environment includes these improvements:

• We’ve added support for retrieving survey attempts (in batches and one at a time) and quiz attempts (in batches and one at a time).

• We’ve added a new route to allow a user to retrieve Content Scheduled Items for a given user.

• We’ve added a new route to retrieve alerts for a given user.

Learning Platform. Version 20.20.6 of the Learning Platform includes these improvements:

• We’ve added surveys as a target type for release conditions.

• As of LP API version 1.28, we’ve added the CanSelfRegister field to the CreateCourseOffering structure for use when creating course offerings. As of version 1.28, this is a mandatory property to provide when creating course offerings.

Brightspace May 2020¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of April 2020.

Learning Environment. Version 20.20.5 of the Learning Environment includes these improvements:

• We’ve added support for retrieving quiz attempts.

Learning Platform. Version 20.20.5 of the Learning Platform includes these improvements:

• We’ve added added new routes and structures to support management of user notification channels.

• As of LP API version 1.27, we’ve added the ability to update the self-registration property on course offerings. As of version 1.27, this is a mandatory property to provide when updating a course offering.

Brightspace April 2020¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of March 2020.

Learning Environment. Version 20.20.4 of the Learning Environment includes these improvements:

• We’ve added new routes to get survey questions.

• We’ve added new properties for shuffling questions and to prevent moving backwards in both quizzes and surveys.

Brightspace March 2020¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of February 2020.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Environment. Version 20.20.3 of the Learning Environment includes these improvements:

• We’ve added new routes to create, delete and update a survey.

• We’ve added new routes to get and delete survey categories.

• We’ve added support for tracking author information to news items.

• We’ve added new routes to get quiz questions.

• We’ve added support for retrieving and setting/updating course offering descriptions.

Brightspace February 2020¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of January 2020.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Environment. Version 20.20.2 of the Learning Environment includes these improvements:

• We’ve added new routes to get all surveys and to get a single survey.

Brightspace January 2020¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of December 2019.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Brightspace December 2019¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of November 2019 .

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Environment. Version 20.19.12 of the Learning Environment includes these improvements:

• We’ve added new routes to create and delete quizzes.

• We’ve added new routes to create, delete, get and update quiz categories.

• We’ve added new properties to the quiz read structure and quiz data structure.

• We’ve added new routes and structures to manage LTI deployments and links for LTI Advantage (LTI 1.3+).

• We’ve added new routes and structures to manage custom widget data for custom widgets in org units.

Brightspace November 2019¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of October 2019.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Environment. Version 20.19.11 of the Learning Environment includes these improvements:

• We’ve added new routes and structures to manage checklists, checklist categories, and checklist items.

• We’ve added new routes and structures to manage the sharing of LTI links and tool providers to org units.

Learning Platform. Version 20.19.11 of the Learning Platform includes these improvements:

• We’ve added a route to terminate all sessions for a user.

• We’ve added new routes and structures to manage release conditions.

Brightspace October 2019¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of September 2019.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Brightspace September 2019¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of August 2019.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Brightspace August 2019¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of July 2019.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Awards Service. Version 20.19.8 of the Awards Service includes these improvements:

• New route to support updating of an updating an issued award.

Learing Platform. Version 20.19.8 of the Learning Platform includes these improvements:

• New structure and routes to manage global user map identifiers for users in Brightspace consortia.

Brightspace July 2019¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of June 2019.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Platform. Version 20.19.7 of the Learning Platform includes these improvements:

• New route to support the Tools Management API to allow fetching localized tool names for tools within an orgUnit.

• New routes to support pinning and unpinning enrollments for a specific user.

Brightspace June 2019¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of May 2019.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Environment. Version 20.19.6 of the Learning Environment includes these improvements:

• We’ve added a new action around dropbox folder categories, to delete a single category for a specific org unit.

• We’ve added a new action to let you replace the content file for a content topic.

• The content management API adds new fields for ToolId, ToolItemId, ActivityType and GradeItemId when fetching content topics through a single topic or from the Table of Contents. These fields will help in the retrieval of more information about the content topic’s underlying activity and their grade item.

• The content user progress API fields userIdsCSV and orgUnitIdsCSV now accept 100 IDs, increased from a previous limit of 50 IDs.

Brightspace May 2019¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of April 2019.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Environment. Version 20.19.5 of the Learning Environment includes these improvements:

• We’ve added new actions for fectching learner progress through content to track the progress of a single user in many courses, and the progress of many users in a single course.

• We’ve added new actions around news items, to retrieve a list of news items from an org unit for a specific user, and to retrieve a list of news items for specific a user.

Brightspace April 2019¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of March 2019.

Brightspace release versioning change. Note that, with this release, Brightspace’s release version numbering scheme has changed. Prior to the change, this release would have been identified as “10.9.0”.

However, under the new numbering scheme that aligns with the release calendar, the release version is “20.19.4”. (Note that the first production release under this scheme does not end with a 0, but with a 4.)

This does not affect the API version numbering scheme. It does, however, affect how we refer to release versions in this documentation going forward.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Brightspace March 2019¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of February 2019.

Brightspace release versioning change. Note that, with the upcoming release targeted for April 2019, Brightspace’s release version numbering scheme will be changing. Prior to the change, that release would have been identified as “10.9.0”.

However, under the new numbering scheme that aligns with the release calendar, the release version will be “20.19.4”. (Note that the first production release under this scheme will be not end with a 0, but with a 4.)

This does not affect the API version numbering scheme. It will, however, affect how we refer to release versions in this documentation going forward.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Environment. Version 10.8.11 of the Learning Environment includes these improvements:

• New route to support the updating of a quiz.

Brightspace Februrary 2019¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of January 2019.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Platform. Version 10.8.10 of the Learning Platform includes these improvements:

• New routes to support the fetching and updating of a user’s preferred first or last name.

Brightspace January 2019¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of December 2018.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Brightspace December 2018¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of November 2018.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Environment. Version 10.8.8 of the Learning Environment includes these improvements:

• Three new properties added to the dropbox folder and dropbox folder update data structures that allow getting, setting, and changing the associated dropbox folder’s dropbox type, submission type, and completion type.

• A new property added to the dropbox entity structure that returns the completion date value.

• A new route added to manually set completion for observational assessments

Brightspace November 2018¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of October 2018.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Environment. Version 10.8.7 of the Learning Environment includes these improvements:

• A new property added to the dropbox folder update structure that lets callers update the IsAnonymous state associated with a dropbox folder.

• A new property added to the dropbox folder structure that returns the associated dropbox folder’s current Anonymous state.

Brightspace October 2018¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of September 2018.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Environment. Version 10.8.6 of the Learning Environment includes these improvements:

• A new property added to the dropbox folder update structure that lets callers update the denominator score for the assessment score associated with a dropbox folder.

Learning Platform. Version 10.8.6 of the Learning Platform includes these improvements:

• A new myenrollments action that retrieves abbreviated information about a user’s enrollment in an org unit (leaving out most of the details about the org unit itself).

Brightspace September 2018¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of August 2018.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Platform. Version 10.8.5 of the Learning Environment includes these improvements:

• The Data Export reporting framework has added a new User filter type for data sets.

• The Tools management API adds an optional namesOnly parameter to orgUnit routes, which allows non-privileged users to retrieve localized tool names.

• The Course Copy API adds the optional DaysToOffsetDates, HoursToOffsetDates, and OffsetByStartDateDifference parameters, which control automatic offsetting of dates in a course during copying.

Brightspace August 2018¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of July 2018.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Platform. Version 10.8.4 of the Learning Environment includes these improvements:

• Available to the v1.20 contract and forward, we’ve added an action to retrieve the root URL for the back end service. You can use this action anonymously (as with the actions to retrieve the API contract versions available in the back end service).

Brightspace July 2018¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of June 2018.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Brightspace June 2018¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of May 2018.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Brightspace May 2018¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of April 2018.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Brightspace April 2018¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of March 2018.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Environment. Version 10.8.0 of the Learning Environment includes these improvements:

• Available to the v1.28 contract and forward, we’ve added an action to retrieve all quizzes in an org unit, as well as an action to retrieve a quiz by its id.

• Available to the v1.28 contract and forward, we’ve added actions and structures to support the retrieval and updating of content completion tracking for users at the content topic level.

Brightspace March 2018¶

Our Brightspace ILP in continuous delivery provides the following features and changes since the release of February 2018.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Brightspace February 2018¶

Our Brightspace ILP in continuous delivery provides the following features and changes as of Febrary 2018.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Environment. Version 10.7.10 of the Learning Environment includes these improvements:

• As of the v1.27 API contract, the route to view a course’s table of course content supports a new userId query parameter, allowing callers to view the table of contents as it would be seen by another user.

• As of the v1.27 API contract, we provide a new route to fetch the classlist for an org unit in a paged manner. Callers should use this new route by preference, especially for large classlists.

Brightspace January 2018¶

Our Brightspace ILP in continuous delivery provides the following features and changes as of January 2018.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Environment. Version 10.7.7 of the Learning Environment includes these improvements:

• Available to the v1.26 API contract and forward, we’ve added an action to retrieve all final grade values for all users enrolled in an org unit.

Version 10.7.6 of the Learning Environment includes these improvements:

• Available to the v1.25 API contract and forward, we’ve added several fields to the table of contents structure to indicate:

  • Ordering of Content topics and modules

  • Start and end dates for topics and modules

  • Lock status of topics and modules

  • Underlying activityId and isBroken status for topics

  • Pacing dates for modules

• The following pacing routes have been added to allow fetching and modifying pacing dates for content:

  • Fetch pacing dates for the course

  • Set pacing dates for the course

  • Set pacing dates for a module

Version 10.7.5 of the Learning Environment includes these improvements:

• As of the v1.26 API contract, dropbox folders now return the LinkAttachments for the dropbox folder when retrieving - the list of folders for a dropbox - the details for an individual folder

Learning Platform. Version 10.7.7 of the Learning Platform includes these

improvements:

• As of LP API v1.20, the following routes have been added to allow for fetching and modification of notification numbers.

  • GET /d2l/api/lp/(version)/notifications/instant/users/(userId)/number action to retrieve the user’s notification number.

  • GET /d2l/api/lp/(version)/notifications/instant/numbers/(notificationNumber)/users action to retrieve the userids for users who have the provided number.

  • PUT /d2l/api/lp/(version)/notifications/instant/users/(userId)/number action to update the user’s notification number.

  • DELETE /d2l/api/lp/(version)/notifications/instant/users/(userId)/number action to remove the users’s notification number.

  • DELETE /d2l/api/lp/(version)/notifications/instant/numbers/(notificationNumber) action to remove the notification number for all users with the provided number.

  • DELETE /d2l/api/lp/(version)/notifications/instant/numbers/(notificationNumber)/users/(userId) action to remove the provided number for the provided user.

• As of the v1.20 API contract, group categories now support the RestrictedByOrgUnitId field for the following:

  • GET /d2l/api/lp/(version)/(orgUnitId)/groupcategories/

  • GET /d2l/api/lp/(version)/(orgUnitId)/groupcategories/(groupCategoryId)

  • POST /d2l/api/lp/(version)/(orgUnitId)/groupcategories/

  • PUT /d2l/api/lp/(version)/(orgUnitId)/groupcategories/(groupCategoryId) (not supported for update to send to service, but sent back in structure returned after update)

• Available to the LP API v1.16 and forward, you can now use the GET /d2l/api/lp/(version)/users/ action to search for users with an exact match on external email address.

• As of the LP API v1.13 and forward, the LogMessageId property in the Logging.Message and Logging.MessageGroupSummary structures changes to a <string> value from a <number:D2LID> value. This breaking change occured because of requirements imposed by improvements to the back-end logging service architecture in Brightspace. In some cases, when using an older version of the LP API (v1.12 and older), LogMessageId properties may be represented as -1: in order to get a usable, differentiated log message ID (as a string), clients should use a newer version of the API.

Brightspace Jan-Aug 2017¶

Our Brightspace ILP in continuous delivery provides the following features and changes as of August 2017.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Environment. Version 10.7.3 of the Learning Environment includes these improvements:

• As of the v1.25 API contract, content topics and modules described in the table of contents structure now use an IsHidden property to indicate their visibility to the calling user.

• As of the v1.25 API contract, learning activities can be exempt from being graded, and this status appears in the APIs and structures around content topics.

Learning Platform. Version 10.7.4 of the Learning Platform includes these improvements:

• As of LP API v1.18, the route to retrieve group category data for an org unit, by group category ID, no longer erroneously includes section property data as it previously did.

• As of LP API v1.18, the routes to list and download data sets have been promoted to a stable version and the report info structure has been modified to include data set version information.

Version 10.7.3 of the Learning Platform includes these improvements:

• You can now use the GET /d2l/api/lp/(version)/organization/info action anonymously find a new TimeZone added to the Org.Organization structure returned from the call to indicate the configured local time zone of the Brightspace service.

• You can now use the GET /d2l/api/lp/(version)/timezones/ action to retrieve a list of all the available time zones the back-end service will recognize.

Brightspace Sept-Dec 2016¶

Our Brightspace ILP in continuous delivery provides the following features and changes as of December 2016.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Enviornment. Version 10.6.11 of the Learning Environment includes

these improvements:

• Clients using OAuth2 authentication must have the content:toc:read scope associated with their token when accessing Table of contents routes

Version 10.6.10 of the Learning Environment includes these improvements:

• Added base64 query parameter to let callers signal when they provide base64 file-type content topic data.

Version 10.6.9 of the Learning Environment includes these improvements:

• Added NotificationEmail property to DropboxFolder structures to contain a list of email addresses to notify when a user submits to a dropbox.

Version 10.6.8 of the Learning Environment includes these improvements:

• Added routes to support Grade exemptions.

• In the unstable contract, added ActivityId properties to content topics and topics in the content table of contents, to indicate the underlying actvity behind a topic in content.

• In the unstable contract, added the ordinal sort order of topics and modules in the content table of contents, as well as start and end date information, to facilitate better presentation of the table of contents tree.

Version 10.6.7 of the Learning Environment includes these improvements:

• The route in the User Progress family of API route which allow a user to retrieves the aggregate count of completed and required content topics in an org unit for a particular orgUnit has been promoted out of the unstable contract into the LE 1.19 API Contract.

• The route in the Grades family of API routes which allow a user to retrieve a list of final grade valudes for the current user for a list of orgUnits have been promoted out of the unstable contract into the LE 1.19 API Contract.

Version 10.6.6 of the Learning Environment includes these improvements:

• The routes in the myUpdates family of API routes which allow a user to query how many actionable items the users has for a particular orgUnit or a list of orgUnits. have been promoted out of the unstable contract into the LE 1.18 API Contract.

• The routes in the myEvents family of API routes allow a user to query what calendar events they have for a certain time range, either for a particular orgUnit or a list of orgUnits have been promoted out of the unstable contract into the LE 1.18 API Contract.

Version 10.6.5 of the Learning Environment includes these improvements:

• When you fetch a content topic, its descriptive properties now point at the properties of the underlying, referred-to object (i.e. the title of the content topic will reflect the title of the underlying, referred-to object). This applies when you fetch content topics both by module structure and by topic ID.

  This also applies when you update or create a topic; the properties you set will get set on the underlying, referred-to object (if that object supports those properties).

Learning Platform. Version 10.7.2 of the Learning Platform includes these

improvements:

• Added support for exact matching against the codes and names of org units as a more performant way of retrieving the org unit properties for org units where the caller already knows the exact org unit code or name (but perhaps not the D2LID for the org unit).

  Note

  Support for these parameters was added in 10.7.2, but made retroactively available in all LP API contracts available in the 10.7.2 release platform. However, note that clients should still be using, or migrating to, LP contract version 1.9 or forward, as contracts 1.8 and prior are deprecated (or obsolete).

Version 10.6.7 of the Learning Platform product component includes these improvements:

• The Code property has been added to the “fetch” form of the SectionData in the suite of Enrollment APIs.

• The ShowInGrades property has been added to the “fetch” form of the Role in the suite of User APIs.

Version 10.6.6 of the Learning Platform product component includes these improvements:

• The properties HomeUrl and ImageUrl in the Enrollment.OrgUnitInfo structure have been promoted into the LP 1.14 API contract.

Version 10.6.5 of the Learning Platform product component includes these improvements:

• Added routes and structures to support Data Export from LP 1.13 API contract.

Brightspace Jan-Aug 2016¶

Our Brightspace ILP in continuous delivery provides the following features and changes as of August 2016.

API deprecation and obsolescence. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Brightspace API properties. With version 10.5 of Brightspace, we have enhanced the ID-key authentication system to allow web and native applications to pass session state through the request for user tokens on to the callback trusted URI using a new x_state parameter.

This can help maintain state between the token request and the token callback; D2L recommends that, if you use this parameter, you use it for something akin to a single-use, time-limited unguessable string as a “session key”; your application’s back-end can store state associated with this session key and use it to (for example), help mitigate the risk of cross-site request forgery attacks on the x_target callback URL.

If you make use of this parameter, you should realize that the user agent can see and manipulate it. Therefore, you should:

• Take care that the value is unguessable and opaque

• Minimize the lifespan of the value to reduce the possible impact of having this value escape outside one particular authentication workflow

• Always validate that the value passed back to the trusted URL matches an expected value

Learning Environment. Version 10.6.4 of the Learning Environment includes these improvements:

• The action to retrieve dropbox folders can now exclude unenrolled students and deleted groups.

Version 10.6.3 of the Learning Environment includes these improvements:

• In the unstable contract, added routes and structures to support retrieving simple counts of things that an end user might think of as a notable update to their view of work to do within a course (quizzes to attempt, discussions to read, feedback to provide on assignments, completed content topics, and so forth).

• In the unstable contract, added a route to support retrieving the final grade values for the calling user contexts for a list of provided org units.

• With the LE v1.13 API contract, we’ve added support for adding comments (visible to user graded) and private comments (visible to the user grading) to outgoing GradeValue JSON blocks sent by Brightspace and incoming IncomingGradeValue JSON blocks Brightspace expects from API callers.

Version 10.6.2 of the Learning Environment includes these improvements:

• In the unstable contract, added routes to support adding and removing pins from a user’s enrollments (pinned routes appear sorted to the top of the list of a user’s enrollments in the web UI).

• Added a route to find all enrolled roles in an org unit.

• New structures and routes to give more flexible access to a user’s list of calendar events, especially when those events have associated activities.

• New structures and routes to manage scheduled items within course content (those content topics with start, end, and/or due dates) – note that scheduled items includes and expands upon the concept of overdue item actions introduced with LMS v10.5.6

Version 10.6.0 of the Learning Environment product component includes these improvements:

• New structure and routes to provide reporting on users’ progress through course content.

• New routes to get and update grades configuration for org units.

• Some users can now retrieve the table of contents for course content while ignoring date restrictions on module visibility, so that they retrieve the entire overall structure of the content.

• Added DisplayInCalendar and DisplayUnlockDatesInCalendar properties in the structure to create or update a forum topic, controlling the display of topic dates in user calendars.

Version 10.5.7 of the Learning Environment product component includes these improvements:

• The Title property in ContentObject structures for topic type content objects now properly contains the topic title string for all types of content topics.

• All grade types now include an AssociatedTool property to indicate the tool object associated with a grade object.

• Added fields in Discussion forum structures to indicate whether forum availability and posting dates should be included in a user’s calendar schedule or not.

• New routes to create and update dropbox folders; new routes to create and update dropbox categories.

• Added DisplayInCalendar property in DropoxFolder to control display of dropbox dates in user calendars.

• Added DisplayIn Calendar and DisplayPostDatesInCalendar properties in discussion Forum structures to control display of discussion forums and posts in user calendars.

• Added a route to retrieve logs for course copying jobs.

Learning Platform. Version 10.6.2 of the Learning Platform product component includes these improvements:

• In the unstable contract, new routes and structures to add and remove pins to a user’s enrollments, indicating which org units should appear sorted to the top of a list of enrollments.

Version 10.6.1 of the Learning Platform product component includes these improvements:

• The actions to retrieve and update the course image have been promoted out of the unstable contract into the LP 1.9 API contract.

• In the v1.9 API contract, accept an isActive query parameter to filter on active and inactive course offerings when searching for a user's own enrollments.

• The properties HomeUrl and ImageUrl were added to the Enrollment.OrgUnitInfo structure in the unstable LP contract to provide easier access to the course home page and course image.

Brightspace December 2015¶

Our Brightspace ILP in continuous delivery provides the following features and changes as of December 2015.

API deprecation. With this release, the versions of our product component API contracts introduced with the following specific product components become (or remain) deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

API obsolescence. With this release, the versions of our product component API contracts introduced with all Learning Suites prior to v10.3.0 are now obsolete. While the routes in these contracts might still exist in your back-end service, they may be removed at any time, and you should not use them. If you have any client code making use of these routes you should immediately update it to use more modern API contracts.

Learning Environment. Version 10.5.7 of the Learning Environment product component includes these improvements:

• The Title property in ContentObject structures for topic type content objects now properly contains the topic title string for all types of content topics.

Version 10.5.6 of the Learning Environment product component includes these improvements:

• The ContentObject structure now includes the module or topic’s Description, as well as reference to the containing parent module.

  Also, the ContentObjectData structure now lets you specify the Description for a module or topic.

• The discussion Post structure now includes the PostingUserDisplayName string property.

Version 10.5.5 of the Learning Environment product component includes these improvements:

• The actions for OverdueItems have been promoted out of the unstable contract into the LE v1.9 API contract.

• The GradeSchemeUrl property in the relevant GradeObject structures have been promoted from the unstable contract into the LE v1.9 API contract.

  The ActivityEntryUrl property in the Numeric GradeObject remains in the unstable contract.

• In the v1.9 API contract, a route to retrieve statistics for a specific grade item.

• In the v1.9 API contract, added a new optional stream query parameter to the route to retrieve the content topic file for a content topic as a file stream instead of as a browser download.

Version 10.5.4 of the Learning Environment product component introduces these improvements:

• The MyOrgUnitInfo structure now includes a ClasslistRoleName property to show an end user the classlist-display name for their enrolled role, if available, and an LISRoles list to show what their equivalent LTI-launch role list values would be.

• The route to fetch all users' grades for a grade object has been promoted from the unstable version to the supported v1.8 API contract.

Learning Platform. Version 10.5.5 of the Learning Platform product component includes these improvements:

• A route in the unstable version to retrieve the effective value for a configuration value within an org unit context (after all overrides have been resolved).

• In the v1.8 API contract, a route letting an end-user API caller get access to the org unit info to only one of their enrolled org units (rather than a list of all their enrolled org units).

Version 10.5.4 of the Learning Platform product component introduces these improvements:

• In the v1.7 API contract, accept lists of org unit type IDs (rather than just a single value) to filter down the lists of enrollments when searching for the enrollments for the calling user context or for a particular user.

Learning Repository. Version 10.5.6 of the Learning Suite’s Learning Repository component includes these improvements:

• In the unstable API contract, the LRWSPublishResult structure adds an ActivityId property that can include an opaque identifier for the LR object represented as an Activity.

Brightspace September 2015¶

Our Brightspace ILP in continuous delivery provides the following features and changes as of September 2015.

API deprecation. With this release, the versions of our product component API contracts introduced with the following specific product components remain deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

API obsolescence. With this release, the versions of our product component API contracts introduced with all Learning Suites prior to v10.3.0 are now obsolete. While the routes in these contracts might still exist in your back-end service, they may be removed at any time, and you should not use them. If you have any client code making use of these routes you should immediately update it to use more modern API contracts.

Learning Environment. Version 10.5.3 of the Learning Environment product component provides routes to

• Retrieve all the values recorded for users against a particular grade object.

• In the v1.7 API contract, add first name and last name to the Enrollment.ClasslistUser user information structure.

• Add ability to sort result set retrieved by the myEnrollments action.

• Retrieve the structure of course competencies and objectives has been promoted out of the unstable contract into the LE 1.7 API contract.

Version 10.5.2 of the Learning Environment product component provides routes to

• Retrieve information about rubrics and the assessments that use them.

• List deleted news items and restore them.

• In the v1.6 API contract, show an OpenAsExternalResource property in ContentObjectData blocks for content topics to specify whether a content topic should be opened as if it were an external resource (for example, in a new window or tab).

Version 10.5.0 of the Learning Environment product component provides routes to

• Retrieve lists of overdue items for users in an org unit.

Learning Platform. Version 10.5.3 of the Learning Platform component provides routes to

• In the v1.6 API contract, show a DisplayName property for tool information blocks at the organization and org unit level.

Version 10.5.2 of the Learning Platform component provides routes to

• Get and update the course image for a course offering.

Version 10.5.1 of the Learning Platform product component provides routes to

• Get and set the current mappings between D2L roles and LIS roles for use in LTI launches.

Version 10.4.12 of the Learning Platform product component provides routes to

• Get and set a configuration resolution strategy for configuration variables to adjust the way the back-end service determines the value of a specified configuration variable.

• In the unstable contract, provide access to an expanded Role structure with more role properties available.

Brightspace May 2015¶

Our Brightspace ILP in continuous delivery provides the following features and changes as of May 2015.

API deprecation. With this release, the versions of our product component API contracts introduced with the following specific product components remain deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

API obsolescence. With this release, the versions of our product component API contracts introduced with all Learning Suites prior to v10.3.0 are now obsolete. While the routes in these contracts might still exist in your back-end service, they may be removed at any time, and you should not use them. If you have any client code making use of these routes you should immediately update it to use more modern API contracts.

Learning Environment. Version 10.4.11 of the Learning Environment product component of the Learning Environment product component adds these features

• Enhance the security features for LTI link and tool provider management; you can now set the various LTI Send* security settings (controlling various additional user data sent on LTI launch) at the Tool Provider level, and have those settings apply to all associated LTI Links, and have each LTI Link override this and provide their own specific values for these various security settings. The various LTI management structures and APIs account for this in the LE unstable contract version as of LE v10.4.11.

Version 10.4.10 of the Learning Environment product component provides routes and structures to

• Give access to the logs created by course import jobs.

Learning Platform. Version 10.4.11 of the Learning Platform product component provides routes to

• Update the settings of configuration variables, at the system and org level, as well as updating overrides for the org and orgunit levels.

Version 10.4.10 of the Learning Platform product component provides routes to

• Get, grant, and revoke user role capabilities for tools.

• A route to let you create a new user role, using an existing role as a template (for permissions and so on

Version 10.4.9 of the Learning Platform product component augments the route to fetch information about org-level tools to let you include restricted tool information in the result set.

Other components. Version 10.4.11 of the Brightspace learning suite also provides these other new platform features:

• Google Apps user integration to link Brightspace users to their Google Apps user identities; for beta use only.

Brightspace January 2015¶

Our Brightspace ILP in continuous delivery provides the following features and changes as of January 2015.

API deprecation. With this release, the versions of our product component API contracts introduced with the following specific product components remain deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

API obsolescence. With this release, the versions of our product component API contracts introduced with all Learning Suites prior to v10.3.0 are now obsolete. While the routes in these contracts might still exist in your back-end service, they may be removed at any time, and you should not use them. If you have any client code making use of these routes you should immediately update it to use more modern API contracts.

Learning Platform. Version 10.4.7 of the Learning Platform product component provides routes to

• Retrieve information about locales supported by the back-end service for user account settings.

• Manage the preferred locale account setting for users.

Brightspace September 2014¶

Our Brightspace ILP in continuous delivery provided the following features and changes as of September 2014.

API deprecation. With this release, the versions of our product component API contracts introduced with Learning Suite v10.0.0 are now deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

API obsolescence. With this release, the versions of our product component API contracts introduced with Learning Suites v9.4.1 and v10.0.0 are now obsolete. While the routes in these contracts might still exist in your back-end service, they may be removed at any time, and you should not use them. If you have any client code making use of these routes you should immediately update it to use more modern API contracts.

Learning Environment. Version 10.4.3 of the Learning Environment product component provides routes to create new course import job requests and inquire about their status.

Limited apps can be registered in the LMS. With 10.3 Service Pack 13, LMS administrators can register new apps to obtain Application ID-key pairs through the Manage Extensibility tool in the LMS. Previously, limited apps had to be registered through the Keytool.

Learning Suite v10.4.0¶

Note that, with the May 2014 release of the Integrated Learning Platform, the various D2L product components have all harmonized their product component version on 10.4.0.

API deprecation. With this release, the versions of our product component API contracts introduced with Learning Suite v10.0.0 are now deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the new API contracts available on your back-end service with due priority.

Learning Environment. Version 10.4.0 of the Learning Environment product component includes:

• Routes to support retrieval of the course offering overview and attachment:

  • GET /d2l/api/le/(version)/(orgUnitId)/overview

  • GET /d2l/api/le/(version)/(orgUnitId)/overview/attachment

• Routes and structures to support the creation and verification of course offering copy tasks:

  • POST /d2l/api/le/(version)/import/(orgUnitId)/copy/

  • GET /d2l/api/le/(version)/import/(orgUnitId)/copy/(jobToken)

• Route and structures to support inspection of the course competencies/objectives structure:

  • GET /d2l/api/le/(version)/(orgUnitId)/competencies/structure

• As of the v1.5 LE API contract, the value of the isHidden property on course news events has no bearing on whether the news event record gets retrieved with

  • GET /d2l/api/le/(version)/(orgUnitId)/news/

ePortfolio. Version 10.4.0 of the EP product component includes:

• Augmentations to the routes around share targets to support the OrgUnit profile sharing type:

  • GET /d2l/api/eP/(version)/object/sharetargets

  • GET /d2l/api/eP/(version)/object/(objectId)/shares/

  • POST /d2l/api/eP/(version)/object/(objectId)/share/delete

  • POST /d2l/api/eP/(version)/object/(objectId)/share/new

• New routes to support access to the EP activity newsfeed (replacing the older “dashboard” routes for EP activity):

  • GET /d2l/api/eP/(version)/newsfeed/

  • GET /d2l/api/eP/(version)/newsfeed/filters/

  With the addition of the newsfeed routes in EP API v2.5, these dashboard routes become deprecated:

  • GET /d2l/api/eP/(version)/dashboard/

  • GET /d2l/api/eP/(version)/dashboard/filters/

Learning Suite v10.3.0¶

API deprecation. With this release, the initial versions of our product component API contracts (those introduced with Learning Suite v9.4.1) are now deprecated. While you can still call the routes in these contracts on the Learning Suites that have historically supported them, you should plan to migrate to the newer API contracts available on your back-end service with due priority.

ePortfolio. Version 4.3.0 of the ePortfolio product component includes new routes to support examining and modifying an eP user’s ignored-users list.

• As of Nov 2013 service packs on EP v4.2.0 and later (EP APIs 2.3 and later), the date activity query filter property is no longer supported. While the service will still parse and accept query filter expressions that include the date property, it will not be actively used when filtering results.

Learning Environment. Version 10.3.0 of the Learning Environment product component includes:

• Structures and routes to add support for voting to discussion posts:

  • A voting type property to associated with discussion topics.

  • Routes to let users attach a vote to a post, see their own votes on a post, and see others' votes on a post.

• Added optional pageSize and pageNumber query parameters to the route to fetch all discussion posts in a topic to allow for data paging, and fetching posts past the first thousand.

Learning Platform. Version 10.3.0 of the Learning Platform product component includes:

• Structures and routes to support configuration of the availability of LMS Tool components to the back-end learning service.

• Structures and routes to support reading of the configuration variables that direct the behaviour of the back-end learning service.

• Structures and routes to permit examination of the back-end service’s system logs.

• Structures and routes added to the unstable namespace to support examination and modification of the back-end service’s role permissions.

• Structures and routes to support expanded modification and examination of the org unit structure:

  • Routes to examine and modify an org unit’s color scheme.

  • Routes to search for childless and parentless org units in the org unit structure graph.

  • Routes to examine the org unit recycle bin’s contents, as well as send org units to it, and recover files from it.

  • A route to more efficiently search for org units through the org unit structure.

Remote Plugin Service. Version 10.3.0 of the Remote Plugin Service product component includes:

• Three new build types to enhance UI integration with third-party services:

  • Insert Stuff plugins to let services add to the Insert Stuff object list.

  • Quicklink plugins to let third parties easily build a quicklink to their external learning tool service.

  • Navbar plugins to let third parties easily create navbar links to their external learning tool services.

Learning Suite v10.2.0¶

ePortfolio. Version 4.2 of the ePortfolio product component includes a new route and data structure to support starting an import task with some immediate feedback.

Learning Environment. Version 10.2.0 of the Learning Environment product component includes:

• A new DueDate property on dropbox folders to indicate the due date for submission folders.

• A new route to support marking a file submitted to a dropbox as read.

• New activeOnly query parameter provided for the route to retrieve a dropbox folder's submissions to support fetching only active submissions

• A new route to support directly retrieving a file content topic's file.

• New ModuleDueDate and DueDate properties added to the ContentObject and ContentObjectData module and topic derived structures (respectively), to support definition of and retrieving of due date information on course content objects.

• New properties added to the Module and Topic blocks inside the TableOfContents JSON block for course content: ModuleId and TopicId provide D2LID identifiers for their associated module and topic nodes; Url provides the URL property for its associated topic node.

• New IsRequired property added to the IsbnAssociation and IsbnAssociationData JSON blocks for ISBN associations in course content, to support distinguishing between ISBN-identified resources that are required for the course, and not required.

Learning Tools Interoperability. Version 10.2.0 of the Learning Environment product component includes API support for LTI actions, to let you manage LTI tool providers and links available within the Learning Environment.

Learning Platform. Version 10.2.0 of the Learning Platform product component includes:

• A new group category type, PeoplePerNumberOfGroupsSelfEnrollment, available to the v1.3+ LP API, along with two new properties for the GroupCategoryData structure, to support a new way of creating group categories.

• A new OrgUnitCreateData JSON block, and routes to let you create a new custom org unit, and retrieve an org unit's properties by ID.

Learning Repository. Version 6.0 of the Learning Repository product component includes:

• Structures and routes to describe and find learning object repositories by type and the trust/permissions they support.

• A new route to support direct downloading of the file content in a learning repository object in its most recent version, as well as past versions of the file content.

Learning Suite v10.1.0¶

ePortfolio. Version 4.1 of the ePortfolio product component includes

• New routes to support access to the activites shown on the user dashboard.

• A new Permissions property on EP objects to indicate the permissions on the object granted to users to whom the object gets shared.

Learning Environment. Version 10.1.0 of the Learning Environment product component includes

• A new GroupTypeId property on dropbox folders to indicate the group type for group-submission folders (individual-submission folders will either not present this property, or will present it with a null value).

• An update to the route that creates news items so that it now returns the newly created news item.

Learning Platform. Version 10.1.0 of the Learning Platform product component includes new routes to support

• User demographics data.

• Management of user notifications.

• Retrieving lists of children and descendants org units in paged result sets.

• Removing a user from a group.

Remote Plugins. Version 10.1.0 introduces a new product component: the Remote Plugin service supports a simple-to-use UI integration point based on the LTI standard.

Learning Suite v10.0.0¶

ePortfolio improvements. Version 4.0.0 of the ePortfolio product component includes new routes to support

• User and object subscriptions.

• Integration in eP of learning objectives.

• Preset filters for use with the get activity route.

• Removing an association between a reflection and another eP object.

• Simple file upload introduced for eP artifacts.

Learning Environment improvements. Version 10.0.0 of the Learning Environment product component includes new routes to support

• Calendar interaction.

• ISBN associations with course content.

• Course completion interaction with grades.

Learning Platform. Version 10.0.0 of the Learning Platform product component lets callers specify a desired profile image size to prompt the service to thumbnail profile images before sending them back.

It also provides a way for callers to retrieve a SOAP services authentication token through the Brightspace API.

Learning Repository. Version 5.6 of the Learning Repository product component provides new routes to support access to learning objects.