D2lbrightspace

D2L Brightspace provides APIs for building custom integrations and add-ons for the D2L Brightspace platform.

Get Quiz

Retrieves a specific quiz from an org unit. returns a quizreaddata json block containing the quiz’s properties. requires oauth2 scope: - quizzing:quizzes:read available in api versions 1.75+ (lms v20.24.5+)

Get Users

Retrieves data for one or more users from d2l brightspace. requires oauth2 scope: - users:userdata:read available in api versions 1.46+ (lms v20.24.3+) notes: - all search parameters (orgdefinedid, username, externalemail) are optional - returns paginated results when using bookmark parameter

Get Quizzes

Retrieves all quizzes belonging to an org unit. returns an objectlistpage json block containing a list of quizreaddata blocks. requires oauth2 scope: - quizzing:quizzes:read available in api versions 1.75+ (lms v20.24.5+)

Update User

Updates an existing user entity in d2l brightspace. requires oauth2 scope: - users:userdata:update available in api versions 1.46+ (lms v20.24.3+) notes: - firstname and lastname update preferred names if set, otherwise update legal names - externalemail must be null or a valid email address - orgdefinedid must be unique across the organization if provided - pronouns: use empty string ("") to reset, null to keep existing value

Get Course Template Schema

Retrieves the list of parent org unit type constraints for course offerings built on this template. returns a json array of schemaelement blocks defining the allowed parent organizational unit types for course templates. available in api versions 1.46+ (lms v20.24.3+)

Get Course Template

Retrieves a course template from d2l brightspace. returns a coursetemplate json block with the template’s information. available in api versions 1.46+ (lms v20.24.3+)

Get Role by ID

Retrieves a particular user role from d2l brightspace by its id. requires oauth2 scope: - role:detail:read available in api versions 1.46+ (lms v20.24.3+)

Get Course Schema

Retrieves the list of parent org unit type constraints for course offerings. returns a json array of schemaelement blocks defining the allowed parent organizational unit types for courses. available in api versions 1.46+ (lms v20.24.3+)

Create Course Template

Creates a new course template in d2l brightspace. notes: - course template code limitations: max 50 chars, no special chars: \ : * ? ” < > | ’ # , % & - path: leave empty if path enforcement is enabled requires oauth2 scope: - orgunits:coursetemplate:create available in api versions 1.46+ (lms v20.24.3+)

Get Quiz Access

Retrieves a list of users with access to a specified quiz. returns an objectlistpage json block containing a list of useraccess blocks. can filter by specific user id or role id. requires oauth2 scope: - quizzing:access:read available in api versions 1.75+ (lms v20.24.5+)

Get User by ID

Retrieves data for a particular user from d2l brightspace. requires oauth2 scope: - users:userdata:read available in api versions 1.46+ (lms v20.24.3+)

Create Grade Object

Creates a new grade object for a particular org unit. the grade object can be one of four types: 1. numeric: for numeric grades with max points 2. passfail: for pass/fail assessments 3. selectbox: for predefined grade options 4. text: for text-only feedback returns a gradeobject json block containing the created grade object’s data, including its assigned id. requires oauth2 scope: - grades:gradeobjects:write available in api versions 1.75+ (lms v20.24.5+)

Get Quiz Attempt

Retrieves a specific quiz attempt. returns a quizattemptdata json block containing the attempt’s properties. requires oauth2 scope: - quizzing:attempts:read available in api versions 1.75+ (lms v20.24.5+)

Get Current User Information

Retrieves the current user context’s user information from d2l brightspace. requires one of these oauth2 scopes: - users:profile:read - users:own profile:read available in api versions 1.46+ (lms v20.24.3+)

Get Quiz Attempts

Retrieves a list of attempts for a quiz. can optionally filter attempts for a specific user. returns an objectlistpage json block containing a list of quizattemptdata blocks. requires oauth2 scope: - quizzing:attempts:read available in api versions 1.75+ (lms v20.24.5+)

Update Course Offering

Updates an existing course offering in d2l brightspace. notes: - course code limitations: max 50 chars, no special chars: \ : * ? ” < > | ’ # , % & - startdate/enddate: null values won’t overwrite existing dates - canselfregister: required for api v1.27+, not supported before v1.27 - description: ignored in api versions 1.25 and earlier requires oauth2 scope: - orgunits:course:update available in api versions 1.46+ (lms v20.24.3+)

Get Quiz Categories

Retrieves all quiz categories belonging to an org unit. returns an objectlistpage json block containing a list of quizcategoryreaddata blocks. requires oauth2 scope: - quizzing:quizzes:read available in api versions 1.75+ (lms v20.24.5+)

Copy Role

Creates a new role copied from an existing role in d2l brightspace. notes: - the new role will not have any capabilities upon the old role from which it was created - some capabilities will be copied for the new role (e.g., if old role users could impersonate other old role users, new role users will be able to impersonate other new role users) - additional capabilities must be manually created after copying requires oauth2 scope: - role:detail:create available in api versions unstable (lms v10.4.10+)

Update Course Template

Updates an existing course template in d2l brightspace. notes: - this action completely replaces the template’s data with the provided values - course template code limitations: max 50 chars, no special chars: \ : * ? ” < > | ’ # , % & available in api versions 1.46+ (lms v20.24.3+)

Update Grade Object

Updates a specific grade object. the grade object can be one of four types: 1. numeric: for numeric grades with max points 2. passfail: for pass/fail assessments 3. selectbox: for predefined grade options 4. text: for text-only feedback note: the provided data completely replaces the existing grade object’s data. returns a gradeobject json block containing the updated grade object’s data. requires oauth2 scope: - grades:gradeobjects:write available in api versions 1.75+ (lms v20.24.5+)

Get Enrolled Roles

Retrieves a list of all enrolled user roles the calling user can view in an org unit. returns a json array of role data blocks containing the properties of all user roles that the calling user context has permission to view and that are currently enrolled in the provided org unit. requires oauth2 scope: - role:detail:read available in api versions 1.46+ (lms v20.24.3+)

Get Quiz Category

Retrieves a specific quiz category from an org unit. returns a quizcategoryreaddata json block containing the category’s properties. requires oauth2 scope: - quizzing:quizzes:read available in api versions 1.75+ (lms v20.24.5+)

Create Quiz

Creates a new quiz in d2l brightspace. notes: - numberofattemptsallowed must be between 1 and 10 (inclusive) or null for unlimited - password must not be empty or whitespace if provided - notificationemail must be a valid email address if provided - timelimitvalue: 0 for no limit (with isenforced false), or 1-9999 for enforced limit - deductionpercentage must be between 0 and 100 if provided - as of le api v1.71: - latelimitminutes is ignored - latesubmissionoption 1 is treated as 2 (autosubmitattempt) - submissiongraceperiod is not used - pagingtypeid added in le api v1.78 - date fields should be in utc format requires oauth2 scopes: - quizzing:quizzes:read - quizzing:quizzes:create available in api versions 1.75+ (lms v20.24.5+)

Get Quiz Questions

Retrieves all questions in a quiz. returns an objectlistpage json block containing a list of questiondata blocks. requires oauth2 scope: - quizzing:quizzes:read available in api versions 1.75+ (lms v20.24.5+)

Get Grade Access

Retrieves a list of users with access to a specified grade. returns an objectlistpage containing useraccess blocks. can optionally filter by specific user id or role id. requires oauth2 scope: - grades:access:read available in api versions 1.75+ (lms v20.24.5+)

Get Roles

Retrieves a list of all known user roles in d2l brightspace. returns a list of role data blocks containing the properties of all user roles that the calling user context has permission to manage. requires oauth2 scope: - role:detail:read available in api versions 1.46+ (lms v20.24.3+)

Create User

Creates a new user entity in d2l brightspace. requires oauth2 scope: - users:userdata:create available in api versions 1.46+ (lms v20.24.3+) notes: - firstname and lastname are used as legal names - externalemail must be null or a valid email address - orgdefinedid must be unique across the organization if provided - preferred names must be set separately after user creation

Update Grade Setup

Updates the grades configuration for an org unit. expects a gradesetupinfo json block containing: - gradingsystem: the grading system type - isnullgradezero: whether null grades should be treated as zero - defaultgradeschemeid: id of the default grade scheme returns the updated gradesetupinfo json block. requires oauth2 scope: - grades:gradesettings:write available in api versions 1.75+ (lms v20.24.5+)

Get Grade Object

Retrieves a specific grade object for a particular org unit. returns a gradeobject json block containing the grade object’s properties. requires oauth2 scope: - grades:gradeobjects:read available in api versions 1.75+ (lms v20.24.5+)

Get Grade Objects

Retrieves all current grade objects for a particular org unit. returns an array of grade objects. requires oauth2 scope: - grades:gradeobjects:read available in api versions 1.75+ (lms v20.24.5+)

Delete Course Template

Deletes a course template from d2l brightspace. requires oauth2 scope: - orgunits:course:delete available in api versions 1.46+ (lms v20.24.3+)

Get Course Offering

Retrieves a specific course offering from d2l brightspace. returns a courseoffering json block with the course’s information. requires oauth2 scope: - orgunits:course:read available in api versions 1.46+ (lms v20.24.3+)

Update Quiz Category

Updates an existing quiz category in d2l brightspace. returns a quizcategoryreaddata json block containing: - categoryid: the id of the category - name: the name of the category - sortorder: the sort order value requires oauth2 scopes: - quizzing:quizzes:read - quizzing:quizzes:write available in api versions 1.75+ (lms v20.24.5+)

Delete User

Deletes a user entity from d2l brightspace. requires oauth2 scope: - users:userdata:delete available in api versions 1.46+ (lms v20.24.3+)

Delete User Demographics

Deletes one or more of a particular user’s associated demographics entries. notes: - if entry ids are provided, only those specific entries will be deleted - if entry ids are not provided, all demographics entries for the user will be deleted requires oauth2 scope: - demographics:user:delete available in api versions 1.46+ (lms v20.24.3+)

Get Grade Statistics

Retrieves statistics for a specified grade item. returns a gradestatisticsinfo json block containing statistical data about the grade item. requires oauth2 scope: - grades:gradestatistics:read available in api versions 1.75+ (lms v20.24.5+)

Get Grade Setup

Retrieves the grades configuration for an org unit. returns a gradesetupinfo json block containing the grades setup information. requires oauth2 scope: - grades:gradesettings:read available in api versions 1.75+ (lms v20.24.5+)

Delete Grade Object

Deletes a specific grade object from an org unit. requires oauth2 scope: - grades:gradeobjects:delete available in api versions 1.75+ (lms v20.24.5+)

Delete Course

Deletes a course offering from d2l brightspace. requires oauth2 scope: - orgunits:course:delete available in api versions 1.46+ (lms v20.24.3+)

Delete Quiz

Deletes a quiz from d2l brightspace. requires oauth2 scope: - quizzing:quizzes:delete available in api versions 1.75+ (lms v20.24.5+)

Get Org Unit Demographics

Retrieves all demographics entries for users enrolled in a particular org unit. notes: - filters are applied cumulatively (all conditions must match) - when using id lists in filters, matching any id in the list satisfies that filter - for example: with roleids=[1,2], userids=[3,4], search=“value”: * users must have role 1 or 2 (either role matches) * and must have id 3 or 4 (either id matches) * and must have a field matching “value” - results are paged; use bookmark parameter for subsequent pages requires oauth2 scope: - demographics:orgunit:read available in api versions 1.46+ (lms v20.24.3+)

Delete Quiz Category

Deletes a quiz category from d2l brightspace. requires oauth2 scope: - quizzing:quizzes:delete available in api versions 1.75+ (lms v20.24.5+)

Update Quiz

Updates an existing quiz in d2l brightspace. notes: - this action updates only the provided quiz properties - numberofattemptsallowed must be between 1 and 10 (inclusive) or null for unlimited - password must not be empty or whitespace if provided - notificationemail must be a valid email address if provided - timelimitvalue: 0 for no limit (with isenforced false), or 1-9999 for enforced limit - deductionpercentage must be between 0 and 100 if provided - cannot restrict shared quizzes for special access - cannot set auto-submit for quizzes with mandatory questions - as of le api v1.71: - latelimitminutes is ignored - latesubmissionoption 1 is treated as 2 (autosubmitattempt) - submissiongraceperiod is not used - pagingtypeid added in le api v1.78 - date fields should be in utc format requires oauth2 scopes: - quizzing:quizzes:read - quizzing:quizzes:write available in api versions 1.75+ (lms v20.24.5+)

Get Started

Documentation

Changelog

Legal