Attributes¶

LOCKERITEM_T¶

The types of items that can appear in a user’s locker are organized into a discrete list. We use the term LOCKERITEM_T to stand in for an appropriate integer value.

Locker item type	Value
Folder	0
File	1

Locker.Folder¶

{
    "Name": <string>,
    "Contents": [ <Locker.LockerItem>, ... ]
}

Locker.GroupLocker¶

{
    "HasLocker": <boolean>
}

Locker.LockerItem¶

{
    "Name": <string>,
    "Description": <string>|null,
    "Type": <number:LOCKERITEM_T>,
    "Size": <number:long>|null,
    "LastModified": <string:UTCDateTime>|null
}

Actions¶

DELETE /d2l/api/le/(version)/locker/myLocker/(path)¶

Delete a file or folder from the current user’s locker.

Parameters:

• version (D2LVERSION) – API version.

• path (string) – Locker path below the root folder.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid path provided or attempt to delete root folder.

• 403 Forbidden – Not permitted to modify locker, or not permitted to delete a child object contained in provided folder.

• 404 Not Found – No such file or folder exists in locker.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions:

• 1.67+ – Route first appears in LMS v20.23.1.

• 1.61-66 – Deprecated as of LMS v20.24.1.

• 1.60- – Obsolete as of LMS v20.24.1.

Input. Provide a locker path at the end of your action’s route. If the path ends in a trailing slash (/), this action seeks to delete the folder named before the slash. If the path ends in a name, this action seeks to delete the named file.

DELETE /d2l/api/le/(version)/locker/user/(userId)/(path)¶

Delete a file or folder from the provided user’s locker.

Parameters:

• version (D2LVERSION) – API version.

• userId (D2LID) – User ID.

• path (string) – Locker path below the root folder.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid path provided or attempt to delete root folder.

• 403 Forbidden – Not permitted to modify locker, or not permitted to delete a child object contained in provided folder.

• 404 Not Found – No such file or folder exists in locker, or no such user.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions:

• 1.67+ – Route first appears in LMS v20.23.1.

• 1.61-66 – Deprecated as of LMS v20.24.1.

• 1.60- – Obsolete as of LMS v20.24.1.

Input. Provide a locker path at the end of your action’s route. If the path ends in a trailing slash (/), this action seeks to delete the folder named before the slash. If the path ends in a name, this action seeks to delete the named file.

Note

The calling user context may not use this route to modify another user’s locker. The provided userId in the route must be the calling user’s user ID.

GET /d2l/api/le/(version)/locker/myLocker/(path)¶

Retrieve a specific object from the current user’s locker.

Parameters:

• version (D2LVERSION) – API version.

• path (string) – Locker path below the root folder.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid path.

• 403 Forbidden – Not permitted to examine locker for current user context.

• 404 Not Found – No locker found for current user, or no such path in locker.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions:

• 1.67+ – Route first appears in LMS v20.23.1.

• 1.61-66 – Deprecated as of LMS v20.24.1.

• 1.60- – Obsolete as of LMS v20.24.1.

Input. Provide a locker path at the end of your action’s route. If your locker path ends in a trailing slash character (/), the service assumes you want to retrieve a locker folder; otherwise, it assumes you want to retrieve a file stored in a locker folder.

Return. If the action retrieves a folder, it returns a Folder JSON block. If the action retrieves a file, it returns a file stream.

GET /d2l/api/le/(version)/locker/user/(userId)/(path)¶

Retrieve a specific object from a provided user’s locker.

Parameters:

• version (D2LVERSION) – API version.

• userId (D2LID) – User ID for the owner of the locker.

• path (string) – Locker path below the root folder.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid path.

• 403 Forbidden – Not permitted to examine locker for provided user.

• 404 Not Found – No locker found for provided user, or no such path in locker.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions:

• 1.67+ – Route first appears in LMS v20.23.1.

• 1.61-66 – Deprecated as of LMS v20.24.1.

• 1.60- – Obsolete as of LMS v20.24.1.

Input. Provide a locker path at the end of your action’s route. If your locker path ends in a trailing slash character (/), the service assumes you want to retrieve a locker folder; otherwise, it assumes you want to retrieve a file stored in a locker folder.

Return. If the action retrieves a folder, it returns a Folder JSON block. If the action retrieves a file, it returns a file stream.

POST /d2l/api/le/(version)/locker/myLocker/(path)¶

Add a new file or folder to the current user’s locker.

Parameters:

• version (D2LVERSION) – API version.

• path (string) – Path below the root folder to a locker folder.

JSON Parameters:

• FolderName (string) – Optional. Name of folder to create (see input description).

• FileDescription (JSON composite) – Optional. File description block for new file (see input description).

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid path, or file or folder already exists, or provided file is too large.

• 403 Forbidden – Not permitted to see or modify locker for current user context.

• 404 Not Found – Current user has no locker.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions:

• 1.67+ – Route first appears in LMS v20.23.1.

• 1.61-66 – Deprecated as of LMS v20.24.1.

• 1.60- – Obsolete as of LMS v20.24.1.

Input. You can use this action to add a new file or folder to the current user’s locker. The locker path you provide must be the name of a folder inside the current user’s locker, and thus your path parameter must end in a trailing slash (/).

Adding a folder. Your post body contents should contain a JSON block containing a simple string declaring the new folder’s name (no trailing slash is needed):

"NewFolderName"

Adding a new file. Your action should have a multipart post body containing file data and a file description JSON block:

{
    "Description": <string>,
    "IsPublic": <boolean>
}

You cannot use this action to replace an existing file with the same name; you may only provide files with names not yet contained in the locker.

This action limits the size of each individual file uploaded, and also respects the maximum locker size.

POST /d2l/api/le/(version)/locker/user/(userId)/(path)¶

Add a new file or folder to the provided user’s locker.

Parameters:

• version (D2LVERSION) – API version.

• userId (D2LID) – User ID for owner of locker.

• path (string) – Path below the root folder to a locker folder.

JSON Parameters:

• FolderName (string) – Optional. Name of folder to create (see input description).

• FileDescription (JSON composite) – Optional. File description block for new file (see input description).

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid path, or file or folder already exists, or provided file is too large.

• 403 Forbidden – Not permitted to see or modify locker for provided user.

• 404 Not Found – User has no locker.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions:

• 1.67+ – Route first appears in LMS v20.23.1.

• 1.61-66 – Deprecated as of LMS v20.24.1.

• 1.60- – Obsolete as of LMS v20.24.1.

Input. You can use this action to add a new file or folder to the identified user’s locker. The locker path you provide must be the name of a folder inside the user’s locker, and thus your path parameter must end in a trailing slash (/).

Adding a folder. Your post body contents should contain a JSON block containing a simple string declaring the new folder’s name (no trailing slash is needed):

"NewFolderName"

Adding a new file. Your action should have a multipart post body containing file data and a file description JSON block:

{
    "Description": <string>,
    "IsPublic": <boolean>
}

You cannot use this action to replace an existing file with the same name; you may only provide files with names not yet contained in the locker.

This action limits the size of each individual file uploaded, and also respects the maximum locker size.

Note

The calling user context may not use this route to modify another user’s locker. The provided userId in the route must be the calling user’s user ID.

PUT /d2l/api/le/(version)/locker/myLocker/(path)¶

Rename a folder in the current user’s locker.

Parameters:

• version (D2LVERSION) – API version.

• path (string) – Path below the root folder to the locker folder to rename.

JSON Parameters:

• FolderName (string) – New name for the folder.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid path, or invalid folder name, or attempt to rename root folder, or folder name already exists in parent folder.

• 403 Forbidden – No permission to modify locker for current user context.

• 404 Not Found – No such locker folder exists.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions:

• 1.67+ – Route first appears in LMS v20.23.1.

• 1.61-66 – Deprecated as of LMS v20.24.1.

• 1.60- – Obsolete as of LMS v20.24.1.

Input. This action’s route must contain a path to a folder–the path must have a trailing slash (/).

PUT /d2l/api/le/(version)/locker/user/(userId)/(path)¶

Rename a folder in the provided user’s locker.

Parameters:

• version (D2LVERSION) – API version.

• userId (D2LID) – User ID for owner of locker.

• path (string) – Path below the root folder to the locker folder to rename.

JSON Parameters:

• FolderName (string) – New name for the folder.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid path, or invalid folder name, or attempt to rename root folder, or folder name already exists in parent folder.

• 403 Forbidden – No permission to modify locker for provided user.

• 404 Not Found – No such locker folder exists.

• 429 Too Many Requests – API call-rate limit exceeded.

API Versions:

• 1.67+ – Route first appears in LMS v20.23.1.

• 1.61-66 – Deprecated as of LMS v20.24.1.

• 1.60- – Obsolete as of LMS v20.24.1.

Input. This action’s route must contain a path to a folder–the path must have a trailing slash (/).

Note

The calling user context may not use this route to modify another user’s locker. The provided userId in the route must be the calling user’s user ID.