Content overview¶

Each course offering org unit can have a content overview consisting of a rich text description and an optional attachment.

Overview.Overview¶

{
    "Description": <composite:RichText>,
    "HasAttachment": <boolean>
}

Scheduled items¶

Content.ScheduledItem¶

A scheduled item describes an activity in an org unit that was added to the content tool with start date, end date, or due date.

{
    "UserId": <string:D2LID>,
    "OrgUnitId": <string:D2LID>,
    "ItemId": <number:D2LID>,
    "ItemName": <string>,
    "ItemType": <number:CONTENT_T>,
    "ItemUrl": <string>|null,
    "StartDate": <string:UTCDateTime>|null,
    "EndDate": <string:UTCDateTime>|null,
    "DueDate": <string:UTCDateTime>|null,
    "CompletionType": <number:CONTENT_COMPLETIONTYPE_T>,
    "DateCompleted": <string:UTCDateTime>|null,
    "ActivityType": <number:ACTIVITYTYPE_T>,
    "IsExempt": <boolean>
}

DueDate

If this property is present and not null, and IsExempt is false, then the content topic has a due date.

CompletionType

Completion type of the content topic. This value is set to 3 (completion type None) when the item is exempt or optional.

IsExempt

If true, the user is exempt from the topic; otherwise, false. This property is only present if item exemptions are supported.

An activity is considered scheduled for a particular user when it is accessible to that user:

• The user is enrolled in the org unit with a role that can have content assigned to them

• The item is a content topic in the org unit’s content

• The item is accessible to the user, considering a variety of factors:

  • Start and end dates of the org unit

  • Scheduled dates for the item itself

  • Publication status of the item

  • Any special access status for the item

  • Applicable release conditions

Content.ScheduledItemCount¶

The count of content items with a start, end, or due date, for the provided org unit context.

{
   "OrgUnitId": <string:D2LID>,
   "UserId": <string:D2LID>,
   "ItemCount": <number>
}

Content.OverdueItem¶

An overdue item describes an activity in an org unit that was added to the content tool with a due date and that is now overdue for a particular user.

{
   "UserId": <number:D2LID>,
   "OrgUnitId": <number:D2LID>,
   "ItemId": <number:D2LID>,
   "ItemName": <string>,
   "DueDate": <string:UTCDateTime>
}

An activity is considered overdue for a particular user when these considerations are met:

• The item is a content topic in the org unit’s content

• The item is accessible to the user, considering a variety of factors:

  • Start and end dates of the org unit

  • Scheduled dates for the item itself

  • The item has a due date scheduled and that date is in the past

  • The user hasn’t yet completed the item

  • The item has not been exempted for the user

Table of contents¶

ToC.TableOfContents¶

This is a nested structure. The TableOfContent comprises a list of Module blocks. Each Module block can contain a list of Topic blocks, and can contain a list of child Module blocks. Thus, each module can have a child that’s a topic, or another module, but topics are “leaf nodes”.

{
   "Modules": [ // Array of Module blocks
        {
            "ModuleId": <number:D2LID>,
            "Title": <string>,
            "Modules": [ // Array of child Module blocks
                {
                    "ModuleId": <number:D2LID>,
                    "Title": <string>,
                    "SortOrder": <number>,
                    "StartDateTime": <string:UTCDateTime>|null,
                    "EndDateTime": <string:UTCDateTime>|null,
                    "Modules": [ { <composite:ToC.Module> }, ... ],
                    "Topics": [ { <composite:ToC.Topic> }, ... ],
                    "IsHidden": <boolean>,
                    "IsLocked": <boolean>,
                    "PacingStartDate": <string:ISODate>|null,
                    "PacingEndDate": <string:ISODate>|null,
                    "DefaultPath": <string>,
                    "LastModifiedDate": <string:UTCDateTime>|null
                },
                { <composite:Module> }, ... ],
            "Topics": [ // Array of Topic blocks
                {
                    "TopicId": <number:D2LID>,
                    "Identifier": <string:D2LID>,
                    "TypeIdentifier": <string>,
                    "Title": <string>,
                    "Bookmarked": <boolean>,
                    "Unread": <boolean>,
                    "Url": <string>,
                    "SortOrder": <number>,
                    "StartDateTime": <string:UTCDateTime>|null,
                    "EndDateTime": <string:UTCDateTime>|null,
                    "ActivityId": <string>|null,
                    "CompletionType": <number:CONTENT_COMPLETIONTYPE_T>,
                    "IsExempt": <boolean>,
                    "IsHidden": <boolean>,
                    "IsLocked": <boolean>,
                    "IsBroken": <boolean>,
                    "ToolId": <number:D2LID>|null,
                    "ToolItemId":  <number:D2LID>|null,
                    "ActivityType": <number:ACTIVITYTYPE_T>,
                    "GradeItemId": <number:D2LID>|null,
                    "LastModifiedDate": <string:UTCDateTime>|null,
                    "StartDateAvailabilityType": <AVAILABILITY_T>|null,  // Available in LE's unstable contract
                    "EndDateAvailabilityType": <AVAILABILITY_T>|null  // Available in LE's unstable contract
                },
                { <composite:Topic> }, ... ]
        },
        { <composite:Module> }, ... ]
}

ModuleId

Contains a D2LID for the module.

TopicId

Contains a D2LID for the topic. Note that this property contains the same identifier as the Identifier property, but formatted as a JSON number rather than as a string.

Url

Carries the same value as appears in a ContentObjectData block: for link content topics, it’s the content link; for file content topics, it’s the path in the course content space for the file data.

SortOrder

A non-negative integer describing the intended, ascending, order of the topics within a given module (or of modules within a given module).

ActivityId

Carries the same value as appears in a ContentObject block.

CompletionType

Completion type of the content topic.

IsExempt

If true, the user is exempt from the topic; otherwise, false.

IsLocked

Carries the same value as appears in a ContentObject block.

PacingStartDate

If this property is present and not null, the content module has a pacing start date. If the property is present with a non-null value, it contains a ISODate.

<string:ISODate>|null

PacingEndDate

If this property is present and not null, the content module has a pacing end date. If the property is present with a non-null value, it contains a ISODate.

<string:ISODate>|null

IsBroken

If true, the activity for the topic can’t be found; otherwise, false.

DefaultPath

The suggested default file path for topics within this module.

ToolId

If not null, identifies the underlying activity’s tool id for this content topic.

ToolItemId

If not null, identifies the underlying activity’s id within it’s tool domain.

ActivityType

Identifies the ACTIVITYTYPE_T of this topic, or the underlying activity’s type.

GradeItemId

If not null, identifies the underlying activity’s grade item id.

StartDateAvailabilityType, EndDateAvailabilityType

Identifies the availability type (AVAILABILITY_T) for the start and end date values for the content object.

User Progress¶

ContentCompletions.ContentTopicCompletion¶

When the client uses an action to retrieve a content topic’s completion,

{
   "UserId": <number:D2LID>,
   "OrgUnitId": <number:D2LID>,
   "TopicId": <number:D2LID>,
   "CompletionType": <number:CONTENT_COMPLETIONTYPE_T>,
   "CompletionDate": <string:UTCDateTime>|null
}

UserId

User the content topic completion belongs to.

OrgUnitId

OrgUnit of the content topic.

TopicId

ID of the content topic.

CompletionType

Completion type of the content topic.

CompletionDate

Date content topic was completed, or null if the topic has not been completed.

ContentCompletions.ContentTopicCompletionUpdate¶

When the client uses an action to update a content topic’s completion,

{
   "CompletedDate": <string:UTCDateTime>|null
}

CompletedDate

Date content topic was completed, or null to indicate that the topic has not been completed.

ContentCompletions.ContentAggregateCompletion¶

When the client uses an action to retrieve content aggregate completion,

{
   "UserId": <string:D2LID>,
   "OrgUnitId": <string:D2LID>,
   "ObjectId": <number:D2LID>,
   "Title": <string>,
   "RequiredItems": <number>,
   "CompletedItems": <number>
}

UserId

ID of the user for whom the completion data is reported.

OrgUnitId

ID of the org unit that the content object belongs to.

ObjectId

ID of the content object for which the required child topics are counted. If data is aggregated at OrgUnit level, the value is 0.

Title

Content object title. If data is aggregated at OrgUnit level, the value is the org unit name.

RequiredItems

This count includes completed topics which meet all of the following criteria: visible to the user, not marked as exempt for the user, and are required topics.

CompletedItems

This count includes all RequiredItems plus completed topics not visible to the user and any completed optional topics.

ContentCompletions.ContentLearnerProgress¶

When the client uses an action to retrieve content learner progress,

{
   "UserId": <string:D2LID>,
   "OrgUnitId": <string:D2LID>,
   "RequiredItems": <number>,
   "CompletedItems": <number>
}

UserId

ID of the user for whom the completion data is reported.

OrgUnitId

ID of the org unit that the content object belongs to.

RequiredItems

This count includes completed topics which meet all of the following criteria: visible to the user, not marked as exempt for the user, and are required topics.

CompletedItems

This count includes all RequiredItems plus completed topics not visible to the user and any completed optional topics.

UserProgress.UserProgressData¶

When the client uses an action to retrieve the user’s progress through content, the back-end service reports on the progress using blocks that look like this:

{
   "ObjectId": <number:D2LID>,
   "UserId": <number:D2LID>,
   "CompletedDate": <string:UTCDateTime>|null,
   "IsRead": <boolean>,
   "NumVisits": <number>,
   "TotalTime": <number>,
   "LastVisited": <string:UTCDateTime>|null,
   "Visited": <boolean>,
   "Completed": <boolean>,
   "IsExempt": <boolean>
}

ObjectId

ID of the content topic in question.

TotalTime

Total time spent on the page in seconds. You cannot update this property to a lower value than its current value; also, the service will not update the value to a time past the last login time of the user.

LastVisited

Date and time the user last visited the content.

Visited

If true, the user has visited the page; otherwise, false.

IsRead

If true, the user has read the page; otherwise, false.

IsExempt

If true, the user is exempt from the activity; otherwise, false.

Pacing¶

Pacing.PacingInfo¶

{
  "StartDate": <string:ISODate>|null,
  "EndDate": <string:ISODate>|null
}

Pacing.ModulePacingData¶

{
  "StartDate": <string:ISODate>|null,
  "EndDate": <string:ISODate>|null
}

Pacing.PacingData¶

{
  "StartDate": <string:ISODate>|null,
  "EndDate": <string:ISODate>|null,
  "SkipWeekends": <boolean>
}

SkipWeekends

If true, dates sent on content modules will not be set on weekends.

Captions¶

Captions.CaptionsMetadata¶

A captions metadata object describes a captions file. Each captions file is associated with a particular audio or video topic in course content, providing captions data for a specific language.

This object only contains file metadata. It does not contain the actual contents of the captions file.

{
   "Filename": <string>,
   "LanguageCode": <string>,
   "LanguageCulture": <string>, // Optional.
   "LanguageName": <string>
}

Filename

The name of the captions file, as it appears in Organization Files. Includes file extension.

LanguageCode

The two-letter ISO 639-1 language code of the language this captions file is associated with.

LanguageCulture

The two-letter ISO 639-1 culture code of the language this captions file is associated with. Some languages do not correspond to a specific culture, in which case this property will not be present.

LanguageName

The translated, human-readable name of the language this captions file is associated with. This property is translated to the language used by the LMS.

Content overview¶

GET /d2l/api/le/(version)/(orgUnitId)/overview¶

Retrieve the content overview for a course offering.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

Status Codes:

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to retrieve course offering’s content overview.

• 404 Not Found – Course has no content overview set.

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

Return. This action returns a Overview JSON data block containing the course offering’s content overview details.

GET /d2l/api/le/(version)/(orgUnitId)/overview/attachment¶

Retrieve the content overview’s file attachment for a course offering.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

Status Codes:

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to retrieve course offering’s content overview or overview attachment.

• 404 Not Found – Course has no content overview set, or has no overview attachment, or cannot find attachment file.

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

Return. This action returns a file stream containing the course offering’s content overview file attachment.

Scheduled items¶

Scheduled items are activities in content that have assigned dates (start, end, and/or due), and become therefore, scheduled for a user’s attention. Start and end dates govern the accessibility of the activity, while a due date specifies a date after which the item will become overdue if the user does not complete it.

GET /d2l/api/le/(version)/content/myItems/¶

Retrieve the calling user’s scheduled items.

Parameters:

• version (D2LVERSION) – API version.

Query Parameters:

• completion (COMPLETION_T) – Optional. Completion status.

• orgUnitIdsCSV (CSV of D2LIDs) – List of org unit IDs (limited to 100 or fewer).

• startDateTime (UTCDateTime) – Optional. Start of time window to examine.

• endDateTime (UTCDateTime) – Optional. End of time window to examine.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid org unit ID or provided start date later than end date.

• 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. When calling this action, you must provide a list of org unit IDs that amount to some or all of the calling user’s active enrollments. You can also filter the data retrieved based on its completion status or whether an item’s due date falls within a provided time window. Exempted items do not have due dates.

Return. This action returns an ObjectListPage JSON block containing a list of ScheduledItem blocks, sorted by the earliest of start date, end date, or due date that match the provided query parameter filters.

This action ignores invalid selection data on input (unknown or inaccessible org units or items), returning only those items that the calling user has access to.

GET /d2l/api/le/(version)/content/items/(userId)¶

Retrieve the scheduled items for a particular user, within a number of org units.

Parameters:

• version (D2LVERSION) – API version.

• userId (D2LID) – User for which to retrieve the scheduled items for.

Query Parameters:

• completion (COMPLETION_T) – Optional. Completion status.

• orgUnitIdsCSV (CSV of D2LIDs) – List of org unit IDs (limited to 100 or fewer).

• startDateTime (UTCDateTime) – Optional. Start of time window to examine.

• endDateTime (UTCDateTime) – Optional. End of time window to examine.

• exemption (EXEMPTION_T) – Optional. Exemption status.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid org unit ID or provided start date later than end date.

• 403 Forbidden – No permission to see scheduled items for the user in any of the provided org units.

• 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. When calling this action, you must provide a list of org unit IDs that amount to some or all of the calling user’s active enrollments. You can also filter the data retrieved based on its completion status or whether an item’s due date falls within a provided time window. Exempted items do not have due dates. Additionally, you can filter the data on its exemption status. Combining this with startDateTime or endDateTime will return exempted items within the due date, even though the items are not due.

Return. This action returns an ObjectListPage JSON block containing a list of ScheduledItem blocks, sorted by the earliest of start date, end date, or due date that match the provided query parameter filters.

This action ignores invalid selection data on input (unknown or inaccessible org units or items), returning only those items that the user provided has access to.

GET /d2l/api/le/(version)/content/myItems/due/¶

Retrieve the calling user’s scheduled items still due.

Parameters:

• version (D2LVERSION) – API version.

Query Parameters:

• completion (COMPLETION_T) – Optional. Completion status.

• orgUnitIdsCSV (CSV of D2LIDs) – List of org unit IDs (limited to 100 or fewer).

• startDateTime (UTCDateTime) – Optional. Start of time window to examine.

• endDateTime (UTCDateTime) – Optional. End of time window to examine.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid org unit ID or provided start date later than end date.

• 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. When calling this action, you must provide a list of org unit IDs that amount to some or all of the calling user’s active enrollments. You can also filter the data retrieved based on its completion status or whether an item’s due date falls within a provided time window.

Return. This action returns an ObjectListPage JSON block containing a list of ScheduledItem blocks of the user’s scheduled items that are still due, sorted by the due date, and that match the provided query parameter filters. Exempted items are considered not due and will not appear in the result list.

This action ignores invalid selection data on input (unknown or inaccessible org units or items), returning only those items that the calling user has access to.

GET /d2l/api/le/(version)/content/myItems/itemCounts/¶

Retrieve the quantities of the calling user’s scheduled items, organized by org unit.

Parameters:

• version (D2LVERSION) – API version.

Query Parameters:

• completion (COMPLETION_T) – Optional. Completion status.

• orgUnitIdsCSV (CSV of D2LIDs) – List of org unit IDs (limited to 100 or fewer).

• startDateTime (UTCDateTime) – Optional. Start of time window to examine.

• endDateTime (UTCDateTime) – Optional. End of time window to examine.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid org unit ID or provided start date later than end date.

• 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. When calling this action, you must provide a list of org unit IDs that amount to some or all of the calling user’s active enrollments. You can also filter the data retrieved based on its completion status or whether an item’s due date falls within a provided time window. Exempted items do not have due dates.

Return. This action returns an ObjectListPage JSON block containing a list of ScheduledItemCount blocks containing only the quantity of the calling user’s scheduled items that match the provided query parameter filters.

This action ignores invalid selection data on input (unknown or inaccessible org units or items), returning only those items that the calling user has access to.

GET /d2l/api/le/(version)/content/myItems/due/itemCounts/¶

Retrieve the quantities of the calling user’s scheduled items still due.

Parameters:

• version (D2LVERSION) – API version.

Query Parameters:

• completion (COMPLETION_T) – Optional. Completion status.

• orgUnitIdsCSV (CSV of D2LIDs) – List of org unit IDs (limited to 100 or fewer).

• startDateTime (UTCDateTime) – Optional. Start of time window to examine.

• endDateTime (UTCDateTime) – Optional. End of time window to examine.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid org unit ID or provided start date later than end date.

• 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. When calling this action, you must provide a list of org unit IDs that amount to some or all of the calling user’s active enrollments. You can also filter the data retrieved based on its completion status or whether an item’s due date falls within a provided time window.

Return. This action returns an ObjectListPage JSON block containing a list of ScheduledItemCount blocks containing only the quantity of the calling user’s scheduled items that are still due and match the provided query parameter filters. Exempted items are considered not due and will not be counted.

GET /d2l/api/le/(version)/content/myItems/completions/¶

Retrieve the calling user’s completed scheduled items.

Parameters:

• version (D2LVERSION) – API version.

Query Parameters:

• orgUnitIdsCSV (CSV of D2LIDs) – List of org unit IDs (limited to 100 or fewer).

• completedFromDateTime (UTCDateTime) – Optional. Start of time window to examine.

• completedToDateTime (UTCDateTime) – Optional. End of time window to examine.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid org unit ID or provided start date later than end date.

• 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. When calling this action, you must provide a list of org unit IDs that amount to some or all of the calling user’s active enrollments. You can also filter the data retrieved based on item’s completion date, which falls within the provided time window.

Return. This action returns an ObjectListPage JSON block containing a list of completed ScheduledItem blocks, sorted by completion date that match the provided query parameter filters.

This action ignores invalid selection data on input (unknown or inaccessible org units or items), returning only those items that the calling user has access to.

GET /d2l/api/le/(version)/content/myItems/completions/due/¶

Retrieve the calling user’s completed scheduled items that have a due date.

Parameters:

• version (D2LVERSION) – API version.

Query Parameters:

• orgUnitIdsCSV (CSV of D2LIDs) – List of org unit IDs (limited to 100 or fewer).

• completedFromDateTime (UTCDateTime) – Optional. Start of time window to examine.

• completedToDateTime (UTCDateTime) – Optional. End of time window to examine.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid org unit ID or provided start date later than end date.

• 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. When calling this action, you must provide a list of org unit IDs that amount to some or all of the calling user’s active enrollments. You can also filter the data retrieved based on item’s completion date, which falls within the provided time window.

Return. This action returns an ObjectListPage JSON block containing a list of completed ScheduledItem blocks, sorted by completion date that match the provided query parameter filters. Exempted items are considered not due and will not appear in the result list.

This action ignores invalid selection data on input (unknown or inaccessible org units or items), returning only those items that the calling user has access to.

GET /d2l/api/le/(version)/(orgUnitId)/content/myItems/¶

Retrieve the calling user’s scheduled items for a particular org unit.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

Query Parameters:

• completion (COMPLETION_T) – Optional. Completion status.

• startDateTime (UTCDateTime) – Optional. Start of time window to examine.

• endDateTime (UTCDateTime) – Optional. End of time window to examine.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Provided start date later than end date.

• 403 Forbidden – No permission to see scheduled items for org unit.

• 404 Not Found – No such org unit.

• 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. When calling this action, you can filter the data retrieved based on its completion status or whether an item’s due date falls within a provided time window. Exempted items do not have due dates.

Return. This action returns an ObjectListPage JSON block containing a list of ScheduledItem blocks, sorted by the earliest of start date, end date, or due date, that match the provided query parameter filters.

GET /d2l/api/le/(version)/(orgUnitId)/content/myItems/due/¶

Retrieve the calling user’s scheduled items still due for a particular org unit.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

Query Parameters:

• completion (COMPLETION_T) – Optional. Completion status.

• startDateTime (UTCDateTime) – Optional. Start of time window to examine.

• endDateTime (UTCDateTime) – Optional. End of time window to examine.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Provided start date later than end date.

• 403 Forbidden – No permission to see scheduled items for org unit.

• 404 Not Found – No such org unit.

• 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. When calling this action, you can filter the data retrieved based on its completion status or whether an item’s due date falls within a provided time window.

Return. An ObjectListPage JSON block containing a list of ScheduledItem blocks of the user’s scheduled items that are still due, sorted by due date, and that match the provided query parameter filters. Exempted items are considered not due and will not appear in the result list.

GET /d2l/api/le/(version)/(orgUnitId)/content/myItems/itemCount¶

Retrieve the quantity of the calling user’s scheduled items for provided org unit.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

Query Parameters:

• completion (COMPLETION_T) – Optional. Completion status.

• startDateTime (UTCDateTime) – Optional. Start of time window to examine.

• endDateTime (UTCDateTime) – Optional. End of time window to examine.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Provided start date later than end date.

• 403 Forbidden – No permission to see scheduled items for org unit.

• 404 Not Found – No such org unit.

• 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. When calling this action, you can filter the data retrieved based on its completion status or whether an item’s due date falls within a provided time window. Exempted items do not have due dates.

Return. This action returns a ScheduledItemCount JSON block containing only the quantity of the calling user’s scheduled items that match the provided query parameter filters.

GET /d2l/api/le/(version)/(orgUnitId)/content/myItems/due/itemCount¶

Retrieve quantity of the calling user’s scheduled items still due for a particular org unit.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

Query Parameters:

• completion (COMPLETION_T) – Optional. Completion status.

• startDateTime (UTCDateTime) – Optional. Start of time window to examine.

• endDateTime (UTCDateTime) – Optional. End of time window to examine.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Provided start date later than end date.

• 403 Forbidden – No permission to see scheduled items for org unit.

• 404 Not Found – No such org unit.

• 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. When calling this action, you can filter the data retrieved based on its completion status or whether an item’s due date falls within a provided time window.

Return. This action returns a ScheduledItemCount JSON block containing only the quantity of the calling user’s scheduled items that are still due and match the provided query parameter filters. Exempted items are considered not due and will not be counted.

GET /d2l/api/le/(version)/overdueItems/¶

Retrieve the overdue items for a particular user in a particular org unit.

Parameters:

• version (D2LVERSION) – API version.

Query Parameters:

• userId (D2LID) – User for which to retrieve the overdue activities.

• orgUnitIdsCSV (CSV of D2LIDs) – Optional. List of Org unit IDs.

Status Codes:

• 200 OK – Action succeeded.

• 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. For this call, you must provide a userId query parameter and may provide an orgUnitIdsCSV query parameter:

• Users can query about their own overdue items.

• Auditors can query about overdue items for users they audit.

• Users that have Manage Content permission over org units (for example, instructors for course offerings) may be able to query about overdue items for users enrolled in those org units (for example, students), but not for overdue items in org units that the user identified by userId has Manage Content permission over.

Return. This action returns an ObjectListPage JSON block containing a list of OverdueItem blocks. Exempted items are considered not due and will not be counted.

GET /d2l/api/le/(version)/overdueItems/myItems¶

Retrieves the calling user’s overdue items, within a number of org units.

Parameters:

• version (D2LVERSION) – API version.

Query Parameters:

• orgUnitIdsCSV (CSV of D2LIDs) – Optional. List of Org unit IDs.

Status Codes:

• 200 OK – Action succeeded.

• 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 may provide orgUnitIdsCSV query parameter for this call; you will be unable to retrieve overdue items for org units for which you do not have Manage Content privileges.

Return. This action returns an ObjectListPage JSON block containing a list of OverdueItem. Exempted items are considered not due and will not be counted.

Table of contents¶

GET /d2l/api/le/(version)/(orgUnitId)/content/bookmarks¶

Retrieve a list of topics that have been bookmarked.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

Oauth2 Scopes:

content:toc:read

Status Codes:

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to view course content.

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

Return. This action returns a JSON array of Topic ToC entries.

GET /d2l/api/le/(version)/(orgUnitId)/content/recent¶

Retrieve a list of the most recently visited topics.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

Oauth2 Scopes:

content:toc:read

Status Codes:

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to view course content.

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

Return. This action returns a JSON array of Topic ToC entries.

GET /d2l/api/le/(version)/(orgUnitId)/content/toc¶

Retrieve the table of course content for an org unit.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

Query Parameters:

• ignoreDateRestrictions (boolean) – (Optional) Include content modules and topics where date restriction would otherwise hide them from view.

• ignoreModuleDateRestrictions (boolean) – (Optional) Include content modules where date restriction would otherwise hide them from view.

• userId (D2LID) – (Optional) Fetch the table of course content as it would be viewed by this user.

• moduleId (D2LID) – (Optional) ModuleId used for filtering.

• title (string) – (Optional) Topic or module title used for filtering

Oauth2 Scopes:

content:toc:read

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Provided user ID not enrolled in the provided org unit.

• 403 Forbidden – No permission to view course content, or no permission to view table of content for provided user ID.

• 404 Not Found – No module was found with the provided moduleId.

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

API Versions:

• 1.67+ – Added support for ignoreDateRestrictions and ignore use of ignoreModuleDateRestrictions.

• 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 optional ignoreDateRestrictions query parameter supports inclusion of content module and topic entries regardless of date restrictions on viewing content:

• If false (or you don’t provide the query parameter) then this action fetches back the table of contents excluding all items restricted from view by date restriction, unless the calling user has permission to view them anyway (for example, administrator users).

• If true, then this action fetches back the table of contents including modules and topics that would otherwise be restricted from view by date restriction (start or end dates). No special view permissions are required from the calling user, and therefore, students will be allowed to view such modules (and their sub-modules) and topics even if the restrications are not met.

Note that the ignoreDateRestrictions query parameter is supported as of LE API v1.67 and forward and replaces support for the older ignoreModuleDateRestrictions (which the back-end service will ignore if used with version 1.67 of this action and forward). In API versions 1.66 and older, callers can use ignoreModuleDateRestrictions to ignore date restrictions only around content modules (descendant content topics would remain excluded, unless the calling user has permission to view them anyway, for example, administrator users).

This action’s optional userId query parameter lets you retrieve the table of course content as it might be viewed by another user (identified by your provided user ID). When used this way, the calling user context’s role affects access to this route:

• Auditors can use the route for users they audit.

• Users with permission to manage content for the org unit (for example, instructors for course offering org units) can use the route for users enrolled in the org unit.

This action’s optional moduleId query parameter lets you filter on a specific module. If the module exists, its sub-modules and topics will be returned. If not found, the status code will be 404.

This action’s optional title query parameter lets you filter on module and topic titles.

• If module title is matched, itself and all its submodules will be returned.

• If only a topic title is matched, only the parent module and the matched topic(s) will be returned.

• When both moduleId and title is provided, the title will be queried in the submodules and topics of the found module.

Return. This action returns a TableOfContents JSON block.

User Progress¶

GET /d2l/api/le/(version)/(orgUnitId)/content/topics/(topicId)/completions/¶

Retrieve a list of content topic completions for a topic for users the caller has access to.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org Unit ID.

• topicId (D2LID) – Content Topic ID.

Query Parameters:

• userId (D2LID) – Optional. User ID.

• isAscendingSort (boolean) – Optional. Whether to sort ascending. True by default.

• userBookmark (D2LID) – Optional. Bookmark for last user returned.

• pageSize – Optional. Number of entries to return in each data page (default is 20).

Oauth2 Scopes:

content:completions:read

Status Codes:

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to view content topic completion.

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

Return. This action returns an ObjectListPage JSON block containing a list of ContentTopicCompletion blocks, sorted by userId and the isAscendingSort parameter.

GET /d2l/api/le/(version)/(orgUnitId)/content/topics/(topicId)/completions/users/(userId)¶

Retrieve a content topic completion for a topic for a particular user.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org Unit ID.

• topicId (D2LID) – Content Topic ID.

• userId (D2LID) – User ID.

Oauth2 Scopes:

content:completions:read

Status Codes:

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to view content topic completion for this 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.

Return. This action returns a ContentTopicCompletion JSON block.

GET /d2l/api/le/(version)/(orgUnitId)/content/completions/mycount/¶

Retrieves the aggregate count of completed and required content topics in an org unit for the calling user.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org Unit ID.

Query Parameters:

• level (CONTENTCOMPLETIONLEVEL_T) – Completion aggregation level.

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Invalid level.

• 403 Forbidden – User has no permission to access the org unit.

• 404 Not Found – Org unit not found.

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

Return. This action returns an ObjectListPage JSON block containing a list of ContentAggregateCompletion items.

GET /d2l/api/le/(version)/(orgUnitId)/content/completions/¶

Retrieves the count of completed and required content topics in an org unit for each of the users in the csv.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org Unit ID.

Query Parameters:

• ignoreInvalid (boolean) – If true, prompt the back-end service to filter out and ignore provided userIdsCSV values that are unauthorized or non-existent.

• userIdsCSV (CSV of D2LIDs) – List of user IDs (limited to 100 or fewer).

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – userIdsCSV is invalid, empty, or has more than 100 ids.

• 403 Forbidden – At least one user is not enrolled in the org unit, or you don’t have access to this user in the classlist.

• 404 Not Found – Org unit not found.

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

Return. This action returns a JSON block containing a list of ContentLearnerProgress items.

GET /d2l/api/le/(version)/content/completions/(userId)/¶

Retrieves the count of completed and required content topics for a user in each org unit in the csv.

Parameters:

• version (D2LVERSION) – API version.

• userId (D2LID) – User ID.

Query Parameters:

• ignoreInvalid (boolean) – If true, prompt the back-end service to filter out and ignore provided orgUnitIdsCSV values that are unauthorized or non-existent.

• orgUnitIdsCSV (CSV of D2LIDs) – List of org unit IDs (limited to 100 or fewer).

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – User is not in the classlist, or orgUnitIdsCSV is invalid, empty, or has more than 100 ids.

• 403 Forbidden – You don’t have access to this user in the classlist, you are missing the ManageContent permission, or the user is not enrolled in one of the org units.

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

Return. This action returns a JSON block containing a list of ContentLearnerProgress items.

GET /d2l/api/le/(version)/(orgUnitId)/content/userprogress/¶

Retrieve the user progress items in an org unit, for specific users or content topics.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org Unit ID.

Query Parameters:

• userId (D2LID) – Report on progress for these users (you can use this parameter more than once for multiple users).

• objectId (D2LID) – Report on progress through these content topics (you can use this parameter more than once for multiple topics).

• pageSize – Optional. Number of entries to return in each data page (default is 20).

Status Codes:

• 200 OK – Action succeeded.

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

API Versions:

• unstable – Route first appears in LMS v10.6.0.

Input. The calling user context’s role affects the scope of this action:

• Users can query about their own progress through content.

• Auditors can query about progress for users they audit.

• Users with permission to see progress for all users over org units (for example, instructors for course offering org units) may be able to query about progress for all users enrolled in those org units.

Return. This action returns an ObjectListPage JSON block containing a list of UserProgressData.

Note that with this action, you will only retrieve user progress information for those users that have made some progress through content topics; you will not retrieve records for users that have made no progress on topics past the default state.

GET /d2l/api/le/(version)/(orgUnitId)/content/userprogress/(topicId)¶

Retrieve one user’s progress within an org unit for a particular content topic.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org Unit ID.

• topicId (D2LID) – Topic ID.

Query Parameters:

• userId (D2LID) – Report on progress for this user.

Status Codes:

• 200 OK – Action succeeded.

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

API Versions:

• unstable – Route first appears in LMS v10.6.0.

Input. The calling user context’s role affects the scope of this action:

• Users can query about their own progress through content.

• Auditors can query about progress for a user they audit.

• Users with permission to see progress for all users over org units (for example, instructors for course offering org units) may be able to query about progress for all users enrolled in those org units.

Return. This action returns a UserProgressData JSON block.

Note that with this action, you will retrieve all user progress records for the topic, including records with a default state for those users that have made no progress past that state.

POST /d2l/api/le/(version)/(orgUnitId)/content/userprogress/¶

Update a user progress item.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org Unit ID.

JSON Parameters:

• UserProgressData (UserProgressData) – Updated progress for a content topic.

Status Codes:

• 200 OK – Action succeeded.

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

API Versions:

• unstable – Route first appears in LMS v10.6.0.

Input. Note that the UserId property in your provided user progress data must be the ID for the calling user context: this action only lets users update their own progress through content.

Return. This action returns a UserProgressData JSON data block containing the updated state of the user’s progress.

PUT /d2l/api/le/(version)/(orgUnitId)/content/topics/(topicId)/completions/users/(userId)¶

Update a content topic completion for a topic for a particular user.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org Unit ID.

• topicId (D2LID) – Content Topic ID.

• userId (D2LID) – User ID.

JSON Parameters:

• ContentTopicCompletionUpdate (ContentTopicCompletionUpdate) – Updated completion information for the topic.

Oauth2 Scopes:

content:completions:write

Status Codes:

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to manage content topic completion for this 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. This action expects a ContentTopicCompletionUpdate JSON block as input.

Pacing¶

GET /d2l/api/le/(version)/(orgUnitId)/content/pacing¶

Retrieve pacing dates for content.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

Status Codes:

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to view course content.

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

Return. This action returns a PacingInfo JSON data block containing the course and semester start and end dates.

PUT /d2l/api/le/(version)/(orgUnitId)/content/pacing¶

Set pacing dates for content.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

JSON Parameters:

• PacingData (PacingData)

Status Codes:

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to view course content.

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

PUT /d2l/api/le/(version)/(orgUnitId)/content/pacing/modules/(moduleId)¶

Set pacing dates for a specific module.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

• moduleId (D2LID) – Module ID.

JSON Parameters:

• ModulePacingData (ModulePacingData)

Status Codes:

• 200 OK – Action succeeded.

• 403 Forbidden – No permission to view course content.

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

Captions¶

DELETE /d2l/api/le/(version)/(orgUnitId)/content/topics/(topicId)/captions/(language)¶

Delete the captions file associated with a content topic for a specific language.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

• topicId (D2LID) – Content Topic ID.

• language (string) – ISO 639-1 language and culture code of the captions file to delete.

Oauth2 Scopes:

content:file:write

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Content object with provided topic ID is not an audio topic or video topic, or invalid language provided.

• 403 Forbidden – No permission to manage content files.

• 404 Not Found – No such topic or org unit found, or could not find captions file associated with the provided topic and language.

• 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. The format of the language query parameter must be (language)-(culture), or (language) if culture does not apply. This parameter must match the ISO 639-1 code of the desired language exactly. For example, “FR” and “FR-CA” will be treated as separate resources, and deleting “FR” will not delete “FR-CA”.

GET /d2l/api/le/(version)/(orgUnitId)/content/topics/(topicId)/captions¶

Retrieve metadata for all captions associated with an audio or video content topic.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

• topicId (D2LID) – Content Topic ID.

Oauth2 Scopes:

content:file:write

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Content object with provided topic ID is not an audio topic or video topic.

• 403 Forbidden – No permission to manage content files.

• 404 Not Found – No such topic found in org unit, or org unit not found.

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

Return. This action returns an ObjectListPage JSON block containing a list of CaptionsMetadata blocks, sorted by their LanguageCode and LanguageCulture properties in ascending order.

PUT /d2l/api/le/(version)/(orgUnitId)/content/topics/(topicId)/captions/(language)¶

Provide a language-specific captions file associated with a particular content topic.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

• topicId (D2LID) – Content Topic ID.

• language (string) – ISO 639-1 language and culture code that the captions file will be associated with.

Oauth2 Scopes:

content:file:write

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Content object with provided topic ID is not an audio topic or video topic, or invalid language provided, or invalid file type provided.

• 403 Forbidden – No permission to manage content files.

• 404 Not Found – No such topic found in org unit, or org unit not found.

• 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 an uploaded SRT or WebVTT content file using the simple file upload process; the content-disposition part header for the file part should have the name file. This file will be saved in a content folder with a name matching the topic file’s name, without file extension.

The format of the language query parameter must be (language)-(culture), or (language) if culture does not apply. This parameter must match the ISO 639-1 code of the desired language exactly. For example, “FR” and “FR-CA” will be treated as separate resources, and uploading to “FR” will not modify “FR-CA”.

Note that if no such captions file existed previously for this language, for this content topic, this action will create one; if one already existed, this action will replace that previous file.

Return. This action returns a CaptionsMetadata JSON block describing the updated captions file.

Order¶

POST /d2l/api/le/(version)/(orgUnitId)/content/order/objectId/(objectId)¶

Specify the position order of a content object with respect to its sibling objects.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

• objectId (D2LID) – Content Object ID.

Query Parameters:

• position (string) – The order position within siblings and can be either first, last, or the objectId to be placed after.

Oauth2 Scopes:

content:modules:manage content:topics:manage

Status Codes:

• 200 OK – Action succeeded.

• 400 Bad Request – Content object with provided is invalid or not found.

• 403 Forbidden – No permission to manage content files.

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

API Versions:

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

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

Input. Provide a position query parameter value to indicate where in the content sorting you want a target content object (topic or module) to have its position. You may specify one of three kinds of values: first to move the specificed target content object to be first in order amongst its siblings; last to move the target object to be last in order; or, provide a content object ID value to indicate the object you want to be immediately before your target object in the order.

Note that you can only use this action to arrange the order of content objects in a single generation (that is, sibling content objects all with the same parent content module, or all at the root level); you cannot use this action to move an object across a generation boundery (that is, move it from within once content module to within another content module).