D2L Brightspace Developer Platform

https://docs.valence.desire2learn.com/
Admin
The D2L Brightspace developer platform provides APIs and tools for developers to create valuable,...
Tokens:720,523
Snippets:3,824
Trust Score:9.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example GET request to /d2l/api/lp/1.0/users/whoami

Source: https://docs.valence.desire2learn.com/basic/apicall.html

Makes an HTTP GET call to the specified URL to retrieve user information for the current user context. The service returns a JSON block with user details such as Identifier, FirstName, LastName, UniqueName, and ProfileIdentifier.

```http
https://devcop.brightspace.com/d2l/api/lp/1.0/users/whoami
```

--------------------------------

### GET /d2l/api/versions/

Source: https://docs.valence.desire2learn.com/res/apiprop.html

Retrieves all supported versions for all product components.

```APIDOC
## GET /d2l/api/versions/

### Description
Retrieve all supported versions for all product components.

### Method
GET

### Endpoint
/d2l/api/versions/

### Response
#### Success Response (200)
Version info returned for all product components supporting API access.

#### Response Example
Returns a JSON array of `ProductVersions` blocks.

### Status Codes
- 200 OK - Version info returned for all product components supporting API access.
- 403 Forbidden - Not authorized for this action.
- 429 Too Many Requests - API call-rate limit exceeded.

### API Versions
- **all** - Route supported in all versions.
```

--------------------------------

### POST /d2l/api/lp/(version)/sourceCourses/

Source: https://docs.valence.desire2learn.com/http-routingtable.html

Creates a new source course.

```APIDOC
## POST /d2l/api/lp/(version)/sourceCourses/

### Description
Creates a new source course.

### Method
POST

### Endpoint
/d2l/api/lp/(version)/sourceCourses/

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.

```

--------------------------------

### GET /d2l/api/lp/1.0/users/whoami

Source: https://docs.valence.desire2learn.com/basic/apicall.html

This snippet documents the GET /d2l/api/lp/1.0/users/whoami endpoint, which retrieves the current user's information.

```APIDOC
## GET /d2l/api/lp/1.0/users/whoami

### Description
Retrieves the user information for the current user context (i.e., the person your application is logged in to the LMS as).

### Method
GET

### Endpoint
https://_targethost_/d2l/api/lp/1.0/users/whoami

### Parameters
None

### Request Example
No request body required.

### Response
#### Success Response (200)
- **Identifier** (string) - The user's identifier.
- **FirstName** (string) - The user's first name.
- **LastName** (string) - The user's last name.
- **UniqueName** (string) - The user's unique name.
- **ProfileIdentifier** (string) - The user's profile identifier.

#### Response Example
{
  "Identifier": "2046",
  "FirstName": "Jodi",
  "LastName": "Singh",
  "UniqueName": "jodi.singh",
  "ProfileIdentifier": "ixCgsUKx1I"
}
```

--------------------------------

### POST /d2l/api/lp/(_version_)/coursetemplates/

Source: https://docs.valence.desire2learn.com/res/course.html

Creates a new course template with the provided properties.

```APIDOC
## POST /d2l/api/lp/(_version_)/coursetemplates/

### Description
Create a new course template.

### Method
POST

### Endpoint
/d2l/api/lp/(_version_)/coursetemplates/

### Parameters
#### Path Parameters
- **version** (D2LVERSION) - Required - API version.

#### Request Body
- **CreateCourseTemplate** (`Course.CreateCourseTemplate`) - Required - New course template properties.

### OAuth2 Scopes
- _orgunits:coursetemplate:create_

### Response
#### Success Response (200)
Action succeeded. Returns a `CourseTemplate` JSON block containing the data for the new course template.

#### Error Responses
- **400 Bad Request** - Invalid course template data provided, or could not create new course template.
- **403 Forbidden** - No permission to manage or create courses and templates.
- **404 Not Found** - Could not resolve org unit for created course template to a known org unit.
- **429 Too Many Requests** - API call-rate limit exceeded.

### API Versions
- **1.49+** - Route first appears in LMS v20.25.1.
- **1.46-1.48** - Deprecated as of LMS v20.26.1.
- **1.45-** - Obsolete as of LMS v20.26.1.
```

--------------------------------

### Settings.WidgetData escaped JSON example

Source: https://docs.valence.desire2learn.com/res/settings.html

Example of the Settings.WidgetData structure with escaped double quotes inside the JSON string.

```json
{  "Data": "{ \"key\": \"value\" }"  }
```

--------------------------------

### POST /d2l/api/le/1.0/eportfolio/import/feedback/

Source: https://docs.valence.desire2learn.com/res/eport.html

Starts an import task with immediate feedback, including a list of target users.

```APIDOC
## POST /d2l/api/le/1.0/eportfolio/import/feedback/

### Description
Starts an import task with immediate feedback, primarily useful for starting an import with a list of target users.

### Method
POST

### Endpoint
/d2l/api/le/1.0/eportfolio/import/feedback/

### Parameters
#### Request Body
- **file** (binary) - Required - The package file to import.
- **targetUserIds** (array of D2LID) - Optional - List of target user IDs.

### Response
#### Success Response (200)
- **ImportJobResultType** (string) - The type of import job result.
- **SuccessfulJobIds** (array of number) - List of import task IDs.
- **FailedUserIds** (array of number) - List of user IDs for which import failed.
- **ErrorMessages** (array of string) - Error messages for failed imports.

#### Response Example
{
  "ImportJobResultType": "success",
  "SuccessfulJobIds": [123, 456],
  "FailedUserIds": [789],
  "ErrorMessages": ["User not found"]
}
```

--------------------------------

### GET /d2l/api/le/1.0/eportfolio/import/status/

Source: https://docs.valence.desire2learn.com/res/eport.html

Retrieves the status of an import job.

```APIDOC
## GET /d2l/api/le/1.0/eportfolio/import/status/

### Description
Checks the status of an import job.

### Method
GET

### Endpoint
/d2l/api/le/1.0/eportfolio/import/status/

### Parameters
#### Query Parameters
- **jobId** (number) - Required - The ID of the import job.

### Response
#### Success Response (200)
- **JobStatus** (number) - The current status of the job (0=Queued, 1=Aborted, 2=Complete, 3=CompleteWithErrors, 4=Processing).

#### Response Example
{
  "JobStatus": 2
}
```

--------------------------------

### POST /d2l/api/lp/(version)/users/batch/

Source: https://docs.valence.desire2learn.com/http-routingtable.html

Creates multiple users in a batch.

```APIDOC
## POST /d2l/api/lp/(version)/users/batch/

### Description
Creates multiple users in a batch.

### Method
POST

### Endpoint
/d2l/api/lp/(version)/users/batch/

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.

```

--------------------------------

### GET /d2l/api/le/1.0/eportfolio/export/package/

Source: https://docs.valence.desire2learn.com/res/eport.html

Downloads the completed export package.

```APIDOC
## GET /d2l/api/le/1.0/eportfolio/export/package/

### Description
Fetches the completed export job as a package.

### Method
GET

### Endpoint
/d2l/api/le/1.0/eportfolio/export/package/

### Parameters
#### Query Parameters
- **jobId** (number) - Required - The ID of the export job.

### Response
#### Success Response (200)
- **file** (binary) - The exported package file.

#### Response Example
(binary file content)
```

--------------------------------

### GET /d2l/api/le/1.0/eportfolio/export/status/

Source: https://docs.valence.desire2learn.com/res/eport.html

Retrieves the status of an export job.

```APIDOC
## GET /d2l/api/le/1.0/eportfolio/export/status/

### Description
Checks the status of an export job.

### Method
GET

### Endpoint
/d2l/api/le/1.0/eportfolio/export/status/

### Parameters
#### Query Parameters
- **jobId** (number) - Required - The ID of the export job.

### Response
#### Success Response (200)
- **JobStatus** (number) - The current status of the job (0=Queued, 1=Aborted, 2=Complete, 3=CompleteWithErrors, 4=Processing).

#### Response Example
{
  "JobStatus": 2
}
```

--------------------------------

### Example JSON body for removing an auditee (DELETE /d2l/api/le/(_version_)/auditing/auditors/(_auditorId_)/auditees/)

Source: https://docs.valence.desire2learn.com/res/enroll.html

The request body must be a single JSON number representing the AuditeeId. This example removes user with ID 1234 from an auditor's list of auditees.

```json
1234
```

--------------------------------

### POST /d2l/api/le/1.0/eportfolio/import/

Source: https://docs.valence.desire2learn.com/res/eport.html

Starts a plain import task for ePortfolio data.

```APIDOC
## POST /d2l/api/le/1.0/eportfolio/import/

### Description
Starts a plain import task.

### Method
POST

### Endpoint
/d2l/api/le/1.0/eportfolio/import/

### Parameters
#### Request Body
- **file** (binary) - Required - The package file to import.

### Response
#### Success Response (200)
- **ImportJobId** (number) - The ID of the created import job.

#### Response Example
{
  "ImportJobId": 67890
}
```

--------------------------------

### POST /d2l/api/lp/(version)/users/

Source: https://docs.valence.desire2learn.com/http-routingtable.html

Creates a new user.

```APIDOC
## POST /d2l/api/lp/(version)/users/

### Description
Creates a new user.

### Method
POST

### Endpoint
/d2l/api/lp/(version)/users/

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.

```

--------------------------------

### GET /d2l/api/le/(_version_)/cpd/question/(_questionId_)

Source: https://docs.valence.desire2learn.com/res/cpd.html

Retrieves a question.

```APIDOC
## GET /d2l/api/le/(_version_)/cpd/question/(_questionId_)

### Description
Retrieve a question.

### Method
GET

### Endpoint
/d2l/api/le/(_version_)/cpd/question/(_questionId_)

### Parameters
#### Path Parameters
- **version** (D2LVERSION) - Required - API version.
- **questionId** (D2LID) - Required - Question ID.

### OAuth2 Scopes
- _cpd:fields:read_

### Status Codes
- 200 OK - Action succeeded.
- 403 Forbidden - Insufficient scope.
- 404 Not Found - Question not found or insufficient permissions.
- 429 Too Many Requests - Api call-rate limit exceeded.

### API Versions
- 1.84+ - Route first appears in LMS v20.25.5.

### Response
Returns a `Question` JSON data block.
```

--------------------------------

### POST /d2l/api/le/(_version_)/(_orgUnitId_)/checklists/

Source: https://docs.valence.desire2learn.com/res/checklist.html

Create a checklist in the specified org unit.

```APIDOC
## POST /d2l/api/le/(_version_)/(_orgUnitId_)/checklists/

### Description
Create a checklist in the specified org unit.

### Method
POST

### Endpoint
/d2l/api/le/(_version_)/(_orgUnitId_)/checklists/

### Parameters
#### Path Parameters
- **version** (D2LVERSION) - Required - API version.
- **orgUnitId** (D2LID) - Required - Org unit ID.

#### Request Body
- **ChecklistData** (`Checklist.ChecklistUpdateData`) - Required - Checklist data for a new checklist.

### Request Example
(No example provided)

### Response
#### Success Response (200)
- Returns a `Checklist.ChecklistReadData` JSON block containing the properties of your created checklist.

#### Response Example
(No example provided)

### Error Handling
- 400 Bad Request - Invalid action body provided.
- 403 Forbidden - No permission to view checklists or write to checklists.
- 404 Not Found - Org Unit not found.
- 429 Too Many Requests - API call-rate limit exceeded.

### Authentication
OAuth2 Scopes: _checklists:checklist:read checklists:checklist:write_

### API Versions
- 1.82+ - Route first appears in LMS v20.25.1.
- 1.75-81 - Deprecated as of LMS v20.26.1.
- 1.74- - Obsolete as of LMS v20.26.1.
```

--------------------------------

### GET /d2l/api/le/(_version_)/cpd/method/(_methodId_)

Source: https://docs.valence.desire2learn.com/res/cpd.html

Retrieves a method.

```APIDOC
## GET /d2l/api/le/(_version_)/cpd/method/(_methodId_)

### Description
Retrieve a method.

### Method
GET

### Endpoint
/d2l/api/le/(_version_)/cpd/method/(_methodId_)

### Parameters
#### Path Parameters
- **version** (D2LVERSION) - Required - API version.
- **methodId** (D2LID) - Required - Method ID.

### OAuth2 Scopes
- _cpd:fields:read_

### Status Codes
- 200 OK - Action succeeded.
- 403 Forbidden - Insufficient scope.
- 404 Not Found - Method not found or insufficient permissions.
- 429 Too Many Requests - Api call-rate limit exceeded.

### API Versions
- 1.84+ - Route first appears in LMS v20.25.5.

### Response
Returns a `Method` JSON data block.
```

--------------------------------

### POST /d2l/api/lp/(version)/sourceCourses/(orgUnitId)/deploy

Source: https://docs.valence.desire2learn.com/http-routingtable.html

Deploys the specified source course.

```APIDOC
## POST /d2l/api/lp/(version)/sourceCourses/(orgUnitId)/deploy

### Description
Deploys the specified source course.

### Method
POST

### Endpoint
/d2l/api/lp/(version)/sourceCourses/(orgUnitId)/deploy

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.
- **orgUnitId** (string) - Required - The unique identifier of the source course.

```

--------------------------------

### GET /d2l/api/le/(_version_)/cpd/category/(_categoryId_)

Source: https://docs.valence.desire2learn.com/res/cpd.html

Retrieves a category.

```APIDOC
## GET /d2l/api/le/(_version_)/cpd/category/(_categoryId_)

### Description
Retrieve a category.

### Method
GET

### Endpoint
/d2l/api/le/(_version_)/cpd/category/(_categoryId_)

### Parameters
#### Path Parameters
- **version** (D2LVERSION) - Required - API version.
- **categoryId** (D2LID) - Required - Category ID.

### OAuth2 Scopes
- _cpd:fields:read_

### Status Codes
- 200 OK - Action succeeded.
- 403 Forbidden - Insufficient scope.
- 404 Not Found - Category not found or insufficient permissions.
- 429 Too Many Requests - Api call-rate limit exceeded.

### API Versions
- 1.84+ - Route first appears in LMS v20.25.5.

### Response
Returns a `Category` JSON data block.
```

--------------------------------

### GET /d2l/api/lp/(version)/users/statistics

Source: https://docs.valence.desire2learn.com/http-routingtable.html

Retrieves statistics about users.

```APIDOC
## GET /d2l/api/lp/(version)/users/statistics

### Description
Retrieves statistics about users.

### Method
GET

### Endpoint
/d2l/api/lp/(version)/users/statistics

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.

```

--------------------------------

### POST /d2l/api/eP/(_version_)/presentations/new

Source: https://docs.valence.desire2learn.com/res/presentation.html

Creates a new presentation. Requires permission to create presentations.

```APIDOC
## POST /d2l/api/eP/(_version_)/presentations/new

### Description
Create a new presentation.

### Method
POST

### Endpoint
/d2l/api/eP/(_version_)/presentations/new

### Parameters
#### Path Parameters
- **version** (D2LVERSION) - Required - API version.

#### Request Body
- **Presentation** - Data for new presentation.

### Response
#### Success Response (200)
Action succeeded. Returns a `Presentation` JSON data block, in the Fetch form, for the newly created presentation.

#### Error Responses
- **400 Bad Request** - Invalid presentation data provided.
- **403 Forbidden** - No permission to create presentation.
- **429 Too Many Requests** - API call-rate limit exceeded.

### API Versions
- **2.5+** - Route first appears in LMS v10.4.0.
- **2.4-** - Obsolete as of LMS v10.7.0.
```

--------------------------------

### GET /d2l/api/lp/(version)/users/

Source: https://docs.valence.desire2learn.com/http-routingtable.html

Retrieves the list of users.

```APIDOC
## GET /d2l/api/lp/(version)/users/

### Description
Retrieves the list of users.

### Method
GET

### Endpoint
/d2l/api/lp/(version)/users/

### Parameters
#### Path Parameters
- **version** (string) - Required - The API version.

```

--------------------------------

### POST /d2l/api/eP/(_version_)/import/newwithdetails

Source: https://docs.valence.desire2learn.com/res/eport.html

Prepares an import of an EP export package with immediate feedback on the request.

```APIDOC
## POST /d2l/api/eP/(_version_)/import/newwithdetails

### Description
Prepare to import an export EP package into this service with immediate feedback on the request.

### Method
POST

### Endpoint
/d2l/api/eP/(_version_)/import/newwithdetails

### Parameters
#### Path Parameters
- **version** (D2LVERSION) - Required - API version.

#### Request Body
Multipart/form-data file upload. The file form data part's content disposition header should have a name property of `file`. Optionally, include separate form-data parts for each target user ID value.

### Response
#### Success Response (200)
Action succeeded. Returns an `EpImportJobResponse` JSON block containing:
- A list of import task IDs for import tasks that can proceed
- A list of any user IDs for which the import task cannot proceed
- A list of error messages matching the list of user IDs, one for one

#### Error Responses
- **400 Bad Request** - No EP package file provided.
- **403 Forbidden** - No permission to import EP objects.
- **404 Not Found** - Could not create a valid import task ID.
- **429 Too Many Requests** - API call-rate limit exceeded.

### API Versions
- **2.5+** - Route first appears in LMS v10.4.0.
- **2.4-** - Obsolete as of LMS v10.7.0.
```
Tokens:
Raw