Developer Platform (May 2017)

Previous release changes

«  Managing Learning Service user authentication   ·  [   home  ·   reference  ·   community   ·  search   ·  index   ·  routing table   ·  scopes table   ]

Contents

Previous releases of Brightspace have introduced these extensibility features and changes.

Brightspace Jan 2017

Our Brightspace ILP in continuous delivery provides the following features and changes as of January 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.

  Code Deprecated API contracts or services Obsolete API contracts or services
Learning Platform lp 1.4 1.3 and older
Learning Environment le 1.4 1.3 and older
Learning Repository lr   1.1 and older
ePortfolio ep 2.4 2.3 and older
D2L Web Services (SOAP) d2lws all versions  

Warning

We are also serving notice that the API contracts introduced with the Learning Suite v10.3.0 will be obsolete in late 2016, and after April of 2016, support for those API contracts will be by priority given only to those clients who have signed a support extension agreement for v10.3.0.

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:

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

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.

  Code Deprecated API contracts or services Obsolete API contracts or services
Learning Platform lp 1.4 1.3 and older
Learning Environment le 1.4 1.3 and older
Learning Repository lr   1.1 and older
ePortfolio ep 2.4 2.3 and older
D2L Web Services (SOAP) d2lws all versions  

Warning

We are also serving notice that the API contracts introduced with the Learning Suite v10.3.0 will be obsolete in late 2016, and after April of 2016, support for those API contracts will be by priority given only to those clients who have signed a support extension agreement for v10.3.0.

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

  Code Deprecated API contracts or services Obsolete API contracts or services
Learning Platform lp 1.4 1.3 and older
Learning Environment le 1.4 1.3 and older
Learning Repository lr   1.1 and older
ePortfolio ep 2.4 2.3 and older
D2L Web Services (SOAP) d2lws all versions  

Warning

We are also serving notice that the API contracts introduced with the Learning Suite v10.3.0 will be obsolete in late 2016, and after April of 2016, support for those API contracts will be by priority given only to those clients who have signed a support extension agreement for v10.3.0.

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 auth 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 drobpox 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.

  Code Deprecated API contracts or services
Learning Platform lp 1.4
Learning Environment le 1.4
ePortfolio ep 2.4
D2L Web Services (SOAP) d2lws all versions

Warning

We are also serving notice that the API contracts introduced with the Learning Suite v10.3.0 will be obsolete in late 2016, and after April of 2016, support for those API contracts will be by priority given only to those clients who have signed a support extension agreement for v10.3.0.

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.

  Code Obsolete API contracts
Learning Platform lp 1.0, 1.1, 1.2, 1.3
Learning Environment le 1.0, 1.1, 1.2, 1.3
ePortfolio ep 2.0, 2.1, 2.2, 2.3
Learning Repository lr 1.0, 1.1

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.

  Code Deprecated versions
D2L Web Services (SOAP) d2lws all versions

Warning

We are also serving notice that the API contracts introduced with Learning Suite v10.3.0 will be deprecated late in the year 2015.

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.

  Code Obsolete versions
Learning Platform lp 1.0, 1.1, 1.2, 1.3
Learning Environment le 1.0, 1.1, 1.2, 1.3
ePortfolio ep 2.0, 2.1, 2.2, 2.3
Learning Repository lr 1.0, 1.1

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

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

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

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.

  Code Deprecated versions
D2L Web Services (SOAP) d2lws all versions

Warning

We are also serving notice that the API contracts introduced with Learning Suite v10.3.0 will be deprecated late in the year 2015.

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.

  Code Obsolete versions
Learning Platform lp 1.0, 1.1, 1.2, 1.3
Learning Environment le 1.0, 1.1, 1.2, 1.3
ePortfolio ep 2.0, 2.1, 2.2, 2.3
Learning Repository lr 1.0, 1.1

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.

  • Add a password property to the QuizData structure to convey the quiz password, if set.

    Note that this added property was also introduced into LE v10.3.0 with service pack 2015/04.

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

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.

  Code Deprecated versions
Learning Repository lr 1.1
D2L Web Services (SOAP) d2lws all versions

Warning

We are also serving notice that the API contracts introduced with Learning Suite v10.3.0 will be deprecated late in the year 2015.

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.

  Code Obsolete versions
Learning Platform lp 1.0, 1.1, 1.2, 1.3
Learning Environment le 1.0, 1.1, 1.2, 1.3
ePortfolio ep 2.0, 2.1, 2.2, 2.3
Learning Repository lr 1.0

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

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.

  Code Deprecated versions
Learning Platform lp 1.2, 1.3
Learning Environment le 1.2, 1.3
ePortfolio ep 2.2, 2.3
Learning Repository lr 1.1
D2L Web Services (SOAP) d2lws all versions

Warning

We are also serving notice that the API contracts introduced with Learning Suite v10.3.0 will be deprecated late in the year 2015.

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.

  Code Obsolete versions
Learning Platform lp 1.0, 1.1
Learning Environment le 1.0, 1.1
ePortfolio ep 2.0, 2.1
Learning Repository lr 1.0

Warning

We are also serving notice that the API contracts introduced with Learning Suites v10.1.0 and v10.2.0 will be declared obsolete as of January 4, 2015 and eligible for complete removal from all in-market Learning Suites.

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.

  Code Deprecated versions
Learning Platform lp 1.0, 1.1
Learning Environment le 1.0, 1.1
ePortfolio ep 2.0, 2.1
Learning Repository lr 1.0
D2L Web Services (SOAP) d2lws all versions

Warning

We are also serving notice that the API contracts introduced with Learning Suite v10.1.0 and v10.2.0 will be deprecated late in the 2014 summer.

A that time, the API contracts introduced with Learning Suite v9.4.1 and v10.0.0 (the ones currently deprecated) will become obsolete and eligible for complete removal from all in-market Learning Suites.

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

ePortfolio. Version 10.4.0 of the EP product component includes:

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.

  Code Deprecated version
Learning Platform lp 1.0
Learning Environment le 1.0
ePortfolio ep 2.0
D2L Web Services (SOAP) d2lws all versions

Warning

We are also serving notice that the API contracts introduced with Learning Suite v10.0.0 will be deprecated early in the 2014 new year; the API contracts introduced with Learning Suite v10.1.0 and Learning Suite v10.2.0 will be deprecated mid-way through 2014.

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:

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 colour 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:

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

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

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

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

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.. title:: Previous release changes

Previous releases of Brightspace have introduced these extensibility features and changes.

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.

  Code Deprecated API contracts or services Obsolete API contracts or services
Learning Platform lp 1.4 1.3 and older
Learning Environment le 1.4 1.3 and older
Learning Repository lr   1.1 and older
ePortfolio ep 2.4 2.3 and older
D2L Web Services (SOAP) d2lws all versions  

Warning

We are also serving notice that the API contracts introduced with the Learning Suite v10.3.0 will be obsolete in late 2016, and after April of 2016, support for those API contracts will be by priority given only to those clients who have signed a support extension agreement for v10.3.0.

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 auth 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 drobpox 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.

  Code Deprecated API contracts or services
Learning Platform lp 1.4
Learning Environment le 1.4
ePortfolio ep 2.4
D2L Web Services (SOAP) d2lws all versions

Warning

We are also serving notice that the API contracts introduced with the Learning Suite v10.3.0 will be obsolete in late 2016, and after April of 2016, support for those API contracts will be by priority given only to those clients who have signed a support extension agreement for v10.3.0.

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.

  Code Obsolete API contracts
Learning Platform lp 1.0, 1.1, 1.2, 1.3
Learning Environment le 1.0, 1.1, 1.2, 1.3
ePortfolio ep 2.0, 2.1, 2.2, 2.3
Learning Repository lr 1.0, 1.1

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.

  Code Deprecated versions
D2L Web Services (SOAP) d2lws all versions

Warning

We are also serving notice that the API contracts introduced with Learning Suite v10.3.0 will be deprecated late in the year 2015.

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.

  Code Obsolete versions
Learning Platform lp 1.0, 1.1, 1.2, 1.3
Learning Environment le 1.0, 1.1, 1.2, 1.3
ePortfolio ep 2.0, 2.1, 2.2, 2.3
Learning Repository lr 1.0, 1.1

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

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

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

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.

  Code Deprecated versions
D2L Web Services (SOAP) d2lws all versions

Warning

We are also serving notice that the API contracts introduced with Learning Suite v10.3.0 will be deprecated late in the year 2015.

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.

  Code Obsolete versions
Learning Platform lp 1.0, 1.1, 1.2, 1.3
Learning Environment le 1.0, 1.1, 1.2, 1.3
ePortfolio ep 2.0, 2.1, 2.2, 2.3
Learning Repository lr 1.0, 1.1

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.

  • Add a password property to the QuizData structure to convey the quiz password, if set.

    Note that this added property was also introduced into LE v10.3.0 with service pack 2015/04.

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

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.

  Code Deprecated versions
Learning Repository lr 1.1
D2L Web Services (SOAP) d2lws all versions

Warning

We are also serving notice that the API contracts introduced with Learning Suite v10.3.0 will be deprecated late in the year 2015.

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.

  Code Obsolete versions
Learning Platform lp 1.0, 1.1, 1.2, 1.3
Learning Environment le 1.0, 1.1, 1.2, 1.3
ePortfolio ep 2.0, 2.1, 2.2, 2.3
Learning Repository lr 1.0

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

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.

  Code Deprecated versions
Learning Platform lp 1.2, 1.3
Learning Environment le 1.2, 1.3
ePortfolio ep 2.2, 2.3
Learning Repository lr 1.1
D2L Web Services (SOAP) d2lws all versions

Warning

We are also serving notice that the API contracts introduced with Learning Suite v10.3.0 will be deprecated late in the year 2015.

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.

  Code Obsolete versions
Learning Platform lp 1.0, 1.1
Learning Environment le 1.0, 1.1
ePortfolio ep 2.0, 2.1
Learning Repository lr 1.0

Warning

We are also serving notice that the API contracts introduced with Learning Suites v10.1.0 and v10.2.0 will be declared obsolete as of January 4, 2015 and eligible for complete removal from all in-market Learning Suites.

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.

  Code Deprecated versions
Learning Platform lp 1.0, 1.1
Learning Environment le 1.0, 1.1
ePortfolio ep 2.0, 2.1
Learning Repository lr 1.0
D2L Web Services (SOAP) d2lws all versions

Warning

We are also serving notice that the API contracts introduced with Learning Suite v10.1.0 and v10.2.0 will be deprecated late in the 2014 summer.

A that time, the API contracts introduced with Learning Suite v9.4.1 and v10.0.0 (the ones currently deprecated) will become obsolete and eligible for complete removal from all in-market Learning Suites.

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

ePortfolio. Version 10.4.0 of the EP product component includes:

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.

  Code Deprecated version
Learning Platform lp 1.0
Learning Environment le 1.0
ePortfolio ep 2.0
D2L Web Services (SOAP) d2lws all versions

Warning

We are also serving notice that the API contracts introduced with Learning Suite v10.0.0 will be deprecated early in the 2014 new year; the API contracts introduced with Learning Suite v10.1.0 and Learning Suite v10.2.0 will be deprecated mid-way through 2014.

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:

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 colour 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:

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

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

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

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

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.

«  Managing Learning Service user authentication   ·  [   home  ·   reference  ·   community   ·  search   ·  index   ·  routing table   ·  scopes table   ]