Developer Platform (November 2019)

Checklists (Checklists, Categories, Checklist Items)

«  Course updates for end users   ·  [   home  ·   reference  ·   community   ·  search   ·  index   ·  routing table   ·  scopes table   ]   ·  Release Conditions  »

Contents

A checklist can have many associated categories, and a category may have many associated checklist items.

Attributes

Checklist.ChecklistReadData

When you use actions that retrieve checklist information, the service provides a block like this:

{
   "Id": <number:D2LID>,
   "Name": <string>,
   "Description": { <composite:RichText> },
}
Checklist.ChecklistCategoryReadData

When you use actions that retrieve checklist category information, the service provides a block like this:

{
   "CategoryId": <number:D2LID>,
   "Name": <string>,
   "Description": { <composite:RichText> },
   "SortOrder": <number>
}
SortOrder

An integer that describes the order in which the category appears amongst the other categories in the checklist. Lower numbers appear earlier in the list. This property must have a value of 1 or greater.

Checklist.ChecklistItemReadData

When you use actions that retrieve checklist item information, the service provides a block like this:

{
   "ChecklistItemId": <number:D2LID>,
   "CategoryId": <number:D2LID>,
   "ChecklistId": <number:D2LID>,
   "Name": <string>,
   "Description": { <composite:RichText> },
   "SortOrder": <number>,
   "DueDate": <string:UTCDateTime>|null
}
SortOrder

An integer that describes the order in which the item appears in the given category. Lower numbers appear earlier in the list. This property must have a value of 1 or greater.

DueDate

If this property is present and not null, the checklist item has a due date for completion. If the property is present with a non-null value, it contains a UTCDateTime.

Checklist.ChecklistUpdateData

When you use actions that create or update checklist information, use a JSON structure like this:

{
   "Name": <string>,
   "Description": { <composite:RichTextInput> },
}
Checklist.ChecklistCategoryUpdateData

When you use actions that create or update checklist category information, use a JSON structure like this:

{
   "Name": <string>,
   "Description": { <composite:RichTextInput> },
   "SortOrder": <number>
}
SortOrder

An integer that describes the order in which the category appears amongst the other categories in the checklist. Lower numbers appear earlier in the list.

Checklist.ChecklistItemUpdateData

When you use actions that create or update checklist item information, use a JSON structure like this:

{
   "CategoryId": <number:D2LID>,
   "Name": <string>,
   "Description": { <composite:RichTextInput> },
   "SortOrder": <number>,
   "DueDate": <string:UTCDateTime>|null
}
SortOrder

An integer that describes the order in which the item appears in the given category. Lower numbers appear earlier in the list.

DueDate

If this property is provided and not null, the checklist item will have a due date for completion. If the property is provided with a non-null value, it contains a UTCDateTime.

Actions

DELETE /d2l/api/le/(version)/(orgUnitId)/checklists/(checklistId)

Delete an existing checklist in the specified org unit.

Parameters
  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • checklistId (D2LID) – Checklist ID.

Oauth2 Scopes

checklists:checklist:read checklists:checklist:write

Status Codes
  • 200 OK – Action succeeded.

  • 403 Forbidden – No permission to view checklists or write to checklists.

  • 404 Not Found – Org Unit not found, or checklist not found, or checklist already deleted.

API Versions
  • 1.38+ – Route first appears in LMS v20.19.11.

DELETE /d2l/api/le/(version)/(orgUnitId)/checklists/(checklistId)/categories/(categoryId)

Delete an existing checklist category in an existing checklist.

Parameters
  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • checklistId (D2LID) – Checklist ID.

  • categoryId (D2LID) – Category ID.

Oauth2 Scopes

checklists:checklist:read checklists:checklist:write

Status Codes
  • 200 OK – Action succeeded.

  • 403 Forbidden – No permission to view checklists or write to checklists.

  • 404 Not Found – Org Unit not found, or checklist not found, or checklist category not found, or checklist category already deleted.

API Versions
  • 1.38+ – Route first appears in LMS v20.19.11.

DELETE /d2l/api/le/(version)/(orgUnitId)/checklists/(checklistId)/items/(checklistItemId)

Delete an existing checklist item in an existing checklist.

Parameters
  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • checklistId (D2LID) – Checklist ID.

  • checklistItemId (D2LID) – Checklist Item ID.

Oauth2 Scopes

checklists:checklist:read checklists:checklist:write

Status Codes
  • 200 OK – Action succeeded.

  • 403 Forbidden – No permission to view checklists or write to checklists.

  • 404 Not Found – Org Unit not found, or checklist not found, or checklist item not found, or checklist item already deleted.

API Versions
  • 1.38+ – Route first appears in LMS v20.19.11.

GET /d2l/api/le/(version)/(orgUnitId)/checklists/

Retrieve all checklists belonging to an org unit.

Parameters
Oauth2 Scopes

checklists:checklist:read

Status Codes
API Versions
  • 1.38+ – Route first appears in LMS v20.19.11.

Return. This action returns an ObjectListPage JSON block containing a list of checklists belonging to the org unit.

GET /d2l/api/le/(version)/(orgUnitId)/checklists/(checklistId)/categories/

Retrieve all categories belonging to a checklist.

Parameters
  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • checklistId (D2LID) – Checklist ID.

Oauth2 Scopes

checklists:checklist:read

Status Codes
API Versions
  • 1.38+ – Route first appears in LMS v20.19.11.

Return. This action returns an ObjectListPage JSON block containing a list of checklist categories belonging to the checklist.

GET /d2l/api/le/(version)/(orgUnitId)/checklists/(checklistId)/items/

Retrieve all items belonging to a checklist.

Parameters
  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • checklistId (D2LID) – Checklist ID.

Oauth2 Scopes

checklists:checklist:read

Status Codes
API Versions
  • 1.38+ – Route first appears in LMS v20.19.11.

Return. This action returns an ObjectListPage JSON block containing a list of checklist items belonging to the checklist.

GET /d2l/api/le/(version)/(orgUnitId)/checklists/(checklistId)

Retrieve a checklist belonging to an org unit.

Parameters
  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • checklistId (D2LID) – Checklist ID.

Oauth2 Scopes

checklists:checklist:read

Status Codes
API Versions
  • 1.38+ – Route first appears in LMS v20.19.11.

Return. This action returns a Checklist.ChecklistReadData JSON block containing the properties of your identified checklist category.

GET /d2l/api/le/(version)/(orgUnitId)/checklists/(checklistId)/categories/(categoryId)

Retrieve a category belonging to a checklist.

Parameters
  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • checklistId (D2LID) – Checklist ID.

  • categoryId (D2LID) – CategoryId ID.

Oauth2 Scopes

checklists:checklist:read

Status Codes
  • 200 OK – Action succeeded.

  • 403 Forbidden – No permission to view checklists.

  • 404 Not Found – Org unit not found, or checklist not found, or category not found.

API Versions
  • 1.38+ – Route first appears in LMS v20.19.11.

Return. This action returns a Checklist.ChecklistCategoryReadData JSON block containing the properties of your identified checklist category.

GET /d2l/api/le/(version)/(orgUnitId)/checklists/(checklistId)/items/(checklistItemId)

Retrieve an item belonging to a checklist.

Parameters
  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • checklistId (D2LID) – Checklist ID.

  • checklistItemId (D2LID) – Checklist item ID.

Oauth2 Scopes

checklists:checklist:read

Status Codes
  • 200 OK – Action succeeded.

  • 403 Forbidden – No permission to view checklists.

  • 404 Not Found – Org unit not found, or checklist not found, or checklist item not found.

API Versions
  • 1.38+ – Route first appears in LMS v20.19.11.

Return. This action returns a Checklist.ChecklistItemReadData JSON block containing the properties of your identified checklist item.

POST /d2l/api/le/(version)/(orgUnitId)/checklists/

Create a checklist in the specified org unit.

Parameters
JSON Parameters
Oauth2 Scopes

checklists:checklist:read checklists:checklist:write

Status Codes
API Versions
  • 1.38+ – Route first appears in LMS v20.19.11.

Return. This action returns a Checklist.ChecklistReadData JSON block containing the properties of your created checklist.

POST /d2l/api/le/(version)/(orgUnitId)/checklists/(checklistId)/categories/

Create a checklist category in the specified checklist.

Parameters
  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • checklistId (D2LID) – Checklist ID.

JSON Parameters
Oauth2 Scopes

checklists:checklist:read checklists:checklist:write

Status Codes
API Versions
  • 1.38+ – Route first appears in LMS v20.19.11.

Return. This action returns a Checklist.ChecklistCategoryReadData JSON block containing the properties of your created checklist category.

POST /d2l/api/le/(version)/(orgUnitId)/checklists/(checklistId)/items/

Create a checklist item in the specified checklist.

Parameters
  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • checklistId (D2LID) – Checklist ID.

JSON Parameters
Oauth2 Scopes

checklists:checklist:read checklists:checklist:write

Status Codes
  • 200 OK – Action succeeded.

  • 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, or checklist not found, or checklist category not found.

API Versions
  • 1.38+ – Route first appears in LMS v20.19.11.

Return. This action returns a Checklist.ChecklistItemReadData JSON block containing the properties of your created checklist item.

PUT /d2l/api/le/(version)/(orgUnitId)/checklists/(checklistId)

Update an existing checklist in the specified org unit.

Parameters
  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • checklistId (D2LID) – Checklist ID.

JSON Parameters
Oauth2 Scopes

checklists:checklist:read checklists:checklist:write

Status Codes
API Versions
  • 1.38+ – Route first appears in LMS v20.19.11.

Return. This action returns a Checklist.ChecklistReadData JSON block containing the properties of the updated checklist.

PUT /d2l/api/le/(version)/(orgUnitId)/checklists/(checklistId)/categories/(categoryId)

Update an existing checklist category in an existing checklist.

Parameters
  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • checklistId (D2LID) – Checklist ID.

  • categoryId (D2LID) – Category ID.

JSON Parameters
Oauth2 Scopes

checklists:checklist:read checklists:checklist:write

Status Codes
  • 200 OK – Action succeeded.

  • 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, or checklist not found, or checklist category not found.

API Versions
  • 1.38+ – Route first appears in LMS v20.19.11.

Return. This action returns a Checklist.ChecklistCategoryReadData JSON block containing the properties of the updated checklist category.

PUT /d2l/api/le/(version)/(orgUnitId)/checklists/(checklistId)/items/(checklistItemId)

Update an existing checklist item in an existing checklist.

Parameters
  • version (D2LVERSION) – API version.

  • orgUnitId (D2LID) – Org unit ID.

  • checklistId (D2LID) – Checklist ID.

  • checklistItemId (D2LID) – Checklist Item ID.

JSON Parameters
Oauth2 Scopes

checklists:checklist:read checklists:checklist:write

Status Codes
  • 200 OK – Action succeeded.

  • 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, or checklist not found, or checklist category not found, or checklist item not found.

API Versions
  • 1.38+ – Route first appears in LMS v20.19.11.

Return. This action returns a Checklist.ChecklistItemReadData JSON block containing the properties of the updated checklist item.

«  Course updates for end users   ·  [   home  ·   reference  ·   community   ·  search   ·  index   ·  routing table   ·  scopes table   ]   ·  Release Conditions  »