Valence (May 2014)

Grades (grade objects, categories, values, schemes)

«  Dropboxes (Folders, categories, submissions, feedback)   ·  [   home  ·   forums  ·   reference   ·  index   ·  routing table   ·  modules   ]   ·  Course content (content objects, ISBNs, tables of content)  »

Contents

Attributes

GRADEOBJ_T

Grade objects support several different means of assessment. We organize these into a list of grade object types and use the term GRADEOBJ_T to stand in for an appropriate integer value.

Grade object type Value
Numeric 1
PassFail 2
SelectBox 3
Text 4
Calculated 5 ^
Formula 6 ^
FinalCalculated 7 ^
FinalAdjusted 8 ^
Category 9 ^

^ Direct creation of these types through these APIs is not supported.

Grade.GradeObject

A grade object describes a single point of assessment for an org unit, containing the parameters within which participants will get assessed. The framework supports the creation of four different types of GradeObjects, each with slightly different properties.

Providing grade object data blocks. The following blocks demonstrate what the framework API returns to callers. When a caller must provide grade object data blocks into the framework API:

  • Do not provide an Id field.
  • The Description field you provide should use the RichTextInput field type, and not the RichText type sent back on output by the service.
  • The Name field must not be the same as any current grade object in the org unit’s gradebook.

Default Category ID values. When the service provides you with a grade object block, it may provide you with a CategoryId value of 0 if the grade object has no associated grade category, instead of providing you with null – you should be able to cope with receiving both values, and recognize that in either case, the grade object has no associated category (do not attmept to fetch a grade category with a category ID of 0, as one won’t be findable: this is also true of the call to retrieve all grade categories).

Numeric. Numeric grade objects look like this:

{
    "MaxPoints": <number:decimal>,
    "CanExceedMaxPoints": <boolean>,
    "IsBonus": <boolean>,
    "ExcludeFromFinalGradeCalculation": <boolean>,
    "GradeSchemeId": <number:D2LID>|null,
    "Id": <number:D2LID>,  // not on input actions
    "Name": <string>,
    "ShortName": <string>,
    "GradeType": "Numeric",
    "CategoryId": <number:D2LID>|null,
    "Description": { <composite:RichText> }  // { <composite:RichTextInput> } on input actions
}

PassFail. Pass-fail grade objects look like this:

{
    "MaxPoints": <number:decimal>,
    "IsBonus": <boolean>,
    "ExcludeFromFinalGradeCalculation": <boolean>,
    "GradeSchemeId": <number:D2LID>|null,
    "Id": <number:D2LID>,  // not on input actions
    "Name": <string>,
    "ShortName": <string>,
    "GradeType": "PassFail",
    "CategoryId": <number:D2LID>|null,
    "Description": { <composite:RichText> }  // { <composite:RichTextInput> } on input actions
}

SelectBox. Select-box grade objects look like this:

{
    "MaxPoints": <number:decimal>,
    "IsBonus": <boolean>,
    "ExcludeFromFinalGradeCalculation": <boolean>,
    "GradeSchemeId": <number:D2LID>,  // must not be null on input actions
    "Id": <number:D2LID>,  // not on input actions
    "Name": <string>,
    "ShortName": <string>,
    "GradeType": "SelectBox",
    "CategoryId": <number:D2LID>|null,
    "Description": { <composite:RichText> }  // { <composite:RichTextInput> } on input actions
}

Text. Text grade objects look like this:

{
    "Id": <number:D2LID>,  // not on input actions
    "Name": <string>,
    "ShortName": <string>,
    "GradeType": "Text",
    "CategoryId": <number:D2LID>|null,
    "Description": { <composite:RichText> }  // { <composite:RichTextInput> } on input actions
}

Grade categories

Grade.GradeObjectCategory

This data block contains a GradeObjectCategoryData block while adding an Id field and a Grades array field:

{
    "Id": <number:D2LID>,
    "Grades": [ <Grade.GradeObject>, ... ],
    "Name": <string>,
    "ShortName": <string>,
    "CanExceedMax": <boolean>,
    "ExcludeFromFinalGrade": <boolean>,
    "StartDate": <string:UTCDateTime>|null,
    "EndDate": <string:UTCDateTime>|null,
    "Weight": <number:decimal>|null,
    "MaxPoints": <number:decimal>|null,
    "AutoPoints": <boolean>|null,
    "WeightDistributionType": <number>|null,
    "NumberOfHighestToDrop": <number>|null,
    "NumberOfLowestToDrop": <number>|null
}
Grade.GradeObjectCategoryData

This data block contains all the fundamental values for a generic grade object category.

{
    "Name": <string>,
    "ShortName": <string>,
    "CanExceedMax": <boolean>,
    "ExcludeFromFinalGrade": <boolean>,
    "StartDate": <string:UTCDateTime>|null,
    "EndDate": <string:UTCDateTime>|null,
    "Weight": <number:decimal>|null,
    "MaxPoints": <number:decimal>|null,
    "AutoPoints": <boolean>|null,
    "WeightDistributionType": <number>|null,
    "NumberOfHighestToDrop": <number>|null,
    "NumberOfLowestToDrop": <number>|null
}

Grade schemes

Grade.GradeScheme
{
    "Id": <number:D2LID>,
    "Name": <string>,
    "ShortName": <string>,
    "Ranges": [ // Array of GradeSchemeRange blocks
        {
            "PercentStart": <number:decimal>,
            "Symbol": <string>,
            "AssignedValue": <number:decimal>|null,
            "Colour": <string>
        },
        { <composite:GradeSchemeRange> }, ...
    ]
}

Grade values

Grade.GradeValue

The framework can provide grade values slightly differently depending upon whether the underlying grade object type is a computable value, or not (basically, only Text (4) grade types are not computable).

Basic. All grade values will share at least these properties:

{
    "DisplayedGrade": <string>,
    "GradeObjectIdentifier": <string:D2LID>,
    "GradeObjectName": <string>,
    "GradeObjectType": <number:GRADEOBJ_T>,
    "GradeObjectTypeName": <string>|null
}

Computable. Computable grade values can have additional properties, and look like this:

{
    "DisplayedGrade": <string>,
    "GradeObjectIdentifier": <string:D2LID>,
    "GradeObjectName": <string>,
    "GradeObjectType": <number:GRADEOBJ_T>,
    "GradeObjectTypeName": <string>|null,
    "PointsNumerator": <number>|null,  // nullable as of LE v1.3+ API
    "PointsDenominator": <number>|null,  // nullable as of LE v1.3+ API
    "WeightedDenominator": <number>|null,  // nullable as of LE v1.3+ API
    "WeightedNumerator": <number>|null  // nullable as of LE v1.3+ API
}

Changed in version 1.3: With version 1.3 and forward of the LE API, the additional properties in computable grade value structures are nullable, to indicate a default grade value state before a grade value has actually been assessed.

Grade.IncomingGradeValue

As with grade objects, the framework handles incoming grade values slightly differently depending upon the grade object type associated with the grade value (these APIs support incoming grade values for the first four grade object types).

Numeric. When you provide numeric grade values, use a block like this:

{
    "GradeObjectType": 1,
    "PointsNumerator": <number:decimal>

}

PassFail. When you provide pass-fail grade values, use a block like this:

{
    "GradeObjectType": 2,
    "Pass": <boolean>

}

SelectBox. When you provide select-box grade values, use a block like this:

{
    "GradeObjectType": 3,
    "Value": <string>
}

Text. When you provide text grade values, use a block like this:

{
    "GradeObjectType": 4,
    "Text": <string>
}
Grade.IncomingFinalAdjustedGradeValue

If you use the API to provide a final adjusted grade value for a user, then use a block like this:

{
    "PointsNumerator": <number:decimal>,
    "PointsDenominator": <number:decimal>
}

Course completion

Grade.CourseCompletion
{
    "OrgUnitId": <number:D2LID>,
    "CompletionId": <number:D2LID>,
    "UserId": <number:D2LID>,
    "CompletedDate": <string:UTCDateTime>,
    "ExpiryDate": <string:UTCDateTime>|null
}
Grade.CourseCompletionCreationData
{
    "UserId": <number:D2LID>,
    "CompletedDate": <string:UTCDateTime>,
    "ExpiryDate": <string:UTCDateTime>|null
}
ExpiryDate
Course created with an expiry date if this property is not null.
Grade.CourseCompletionUpdateData
{
    "CompletedDate": <string:UTCDateTime>,
    "ExpiryDate": <string:UTCDateTime>|null
}
ExpiryDate
Course adjusted to have an expiry date if this property is not null.

Actions

DELETE /d2l/api/le/(version)/(orgUnitId)/grades/(gradeObjectId)

Delete a specific grade object for a particular org unit.

Parameters:
  • version (D2LVERSION) – API version.
  • orgUnitId (D2LID) – Org unit ID.
  • gradeObjectID (D2LID) – Grade object ID.
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to manage grades.
  • 404 – No such grade object, or no such org unit.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.
GET /d2l/api/le/(version)/(orgUnitId)/grades/

Retrieve all the current grade objects for a particular org unit.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to see grades.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a JSON array of GradeObject blocks.

GET /d2l/api/le/(version)/(orgUnitId)/grades/(gradeObjectId)

Retrieve a specific grade object for a particular org unit.

Parameters:
  • version (D2LVERSION) – API version.
  • orgUnitId (D2LID) – Org unit ID.
  • gradeObjectId (D2LID) – Grade object ID.
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to see grades.
  • 404 – No such grade object, or no such org unit.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a GradeObject JSON block.

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

Create a new grade object for a particular org unit.

Parameters:
JSON Parameters:
 
Status Codes:
  • 200 – Action succeeded: the return body contains the parsed grade object data.
  • 400 – Bad request: you have posted invalid data, the return body may contain further detail.
  • 403 – No permission to manage grades.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Input. This action expects a grade object of one of the first four grade object types.

Note

Your posted grade object must have a unique Name property.

Return. This action returns a GradeObject JSON block for the grade object that the service just created, so you can quickly retrieve the grade object ID.

PUT /d2l/api/le/(version)/(orgUnitId)/grades/(gradeObjectId)

Update a specific grade object.

Parameters:
  • version (D2LVERSION) – API version.
  • orgUnitId (D2LID) – Org unit ID.
  • gradeObjectId (D2LID) – Grade object ID.
JSON Parameters:
 
Status Codes:
  • 200 – Action succeeded: the return body contains updated grade object data.
  • 400 – Bad request: you provided invalid data; the return body may contain further detail.
  • 403 – No permission to manage grade objects.
  • 404 – No such grade object, or no such org unit.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Input. This action expects a grade object of one of the first four grade object types. Note that your provided block’s data replaces all the associated grade object’s data on the service.

Note

If you update the Name property for your grade object, the new name should be unique.

Return. This action returns a GradeObject JSON block for the grade object that the service just updated.

Grade categories

DELETE /d2l/api/le/(version)/(orgUnitId)/grades/categories/(categoryId)

Delete a specific grade category for a provided org unit.

Parameters:
  • version (D2LVERSION) – API version.
  • orgUnitId (D2LID) – Org unit ID.
  • categoryId (D2LID) – Grade category ID.
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to manage grades.
  • 404 – Grade category not found, or org unit not found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.
GET /d2l/api/le/(version)/(orgUnitId)/grades/categories/

Retrieve a list of all grade categories for a provided org unit.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to see grades.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action retrieves a JSON array of GradeObjectCategory blocks.

GET /d2l/api/le/(version)/(orgUnitId)/grades/categories/(categoryId)

Retrieve a specific grade category for a provided org unit.

Parameters:
  • version (D2LVERSION) – API version.
  • orgUnitId (D2LID) – Org unit ID.
  • categoryId (D2LID) – Grade category ID.
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to see grades.
  • 404 – Grade category not found, or org unit not found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action retrieves a GradeObjectCategory JSON block.

POST /d2l/api/le/(version)/(orgUnitId)/grades/categories/

Create a new grade category for a provided org unit.

Parameters:
JSON Parameters:
 
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to manage grades.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns the newly created grade object category in a GradeObjectCategory JSON block, so that you can quickly gather its grade category ID.

Grade schemes

GET /d2l/api/le/(version)/(orgUnitId)/grades/schemes/

Retrieve all the grade schemes for a provided org unit.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to manage grades.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a JSON array of GradeScheme blocks.

GET /d2l/api/le/(version)/(orgUnitId)/grades/schemes/(gradeSchemeId)

Retrieve a particular grade scheme.

Parameters:
  • version (D2LVERSION) – API version.
  • orgUnitId (D2LID) – Org unit ID.
  • gradeSchemeId (D2LID) – Grade scheme ID.
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to manage grades.
  • 404 – No grade scheme found for org unit, or no org unit found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a GradeScheme JSON block.

Grade values

Default grade values. Each user can have a grade value associated with each grade object. With version 1.2 of the LE API and earlier, if a user has no grade value yet created for a particular grade object, trying to retrieve that value can result in a 404 status. However, with version 1.3 of the LE API and later, if you try to retrieve a computable grade value for a user, the API may return a “default” grade value object instead of a 404. In this case, the computable properties for the grade value that the LMS has not yet been able to calculate (the numerator and denominator properties for the grade value) will be set to null, and you should be prepared to handle such values.

GET /d2l/api/le/(version)/(orgUnitId)/grades/final/values/myGradeValue

Retrieve the final grade value for the current user context.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – Current user context has no permission to see grade values.
  • 404 – No final grade found for current user in org unit, or no org unit found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a GradeValue JSON block.

GET /d2l/api/le/(version)/(orgUnitId)/grades/final/values/(userId)

Retrieve the final grade value for a particular user.

Parameters:
  • version (D2LVERSION) – API version.
  • orgUnitId (D2LID) – Org unit ID.
  • userId (D2LID) – User ID.
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to see grade values.
  • 404 – No final grade found for provided user in org unit, or no user found, or no org unit found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a GradeValue JSON block.

GET /d2l/api/le/(version)/(orgUnitId)/grades/(gradeObjectId)/values/(userId)

Retrieve a specific grade value for a particular user assigned in an org unit.

Parameters:
  • version (D2LVERSION) – API version.
  • orgUnitId (D2LID) – Org unit ID.
  • gradeObjectId (D2LID) – Grade object ID.
  • userId (D2LID) – User ID.
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to see grade values.
  • 404 – No grade found for provided user in org unit, or no grade object, user, or org unit found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a GradeValue JSON block.

GET /d2l/api/le/(version)/(orgUnitId)/grades/(gradeObjectId)/values/myGradeValue

Retrieve a specific grade value for the current user context assigned in a particular org unit.

Parameters:
  • version (D2LVERSION) – API version.
  • orgUnitId (D2LID) – Org unit ID.
  • gradeObjectId (D2LID) – Grade object ID.
Status Codes:
  • 200 – Action succeeded.
  • 403 – Current user context has no permission to see grade values.
  • 404 – No grade found for current user in org unit, or no grade object found, or no org unit not found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a GradeValue JSON block.

GET /d2l/api/le/(version)/(orgUnitId)/grades/values/myGradeValues/

Retrieve all the grade objects for the current user context assigned in a particular org unit.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – Current user context has no permission to see grade values.
  • 404 – No grades found for current user context in org unit, or no org unit not found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a JSON array of GradeValue blocks.

GET /d2l/api/le/(version)/(orgUnitId)/grades/values/(userId)/

Retrieve all the grade objects for a particular user assigned in an org unit.

Parameters:
  • version (D2LVERSION) – API version.
  • orgUnitId (D2LID) – Org unit ID.
  • userId (D2LID) – User ID.
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to see grades.
  • 404 – No grades found for provided user in org unit, or no user found, or no org unit found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a JSON array of GradeValue blocks.

POST /d2l/api/le/(version)/(orgUnitId)/grades/final/calculated/(userId)

Recalculate final grade value for provided user in org unit.

Parameters:
  • version (D2LVERSION) – API version.
  • orgUnitId (D2LID) – Org unit ID.
  • userId (D2LID) – User ID.
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to change final grades.
  • 404 – No user found, or no org unit found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.
POST /d2l/api/le/(version)/(orgUnitId)/grades/final/calculated/all

Recalculate all final grade values for provided org unit.

Parameters:
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to change final grades.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.
PUT /d2l/api/le/(version)/(orgUnitId)/grades/final/values/(userId)

Set the adjusted final grade value for provided user in org unit.

Parameters:
  • version (D2LVERSION) – API version.
  • orgUnitId (D2LID) – Org unit ID.
  • userId (D2LID) – User ID.
JSON Parameters:
 
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to see or manage grades.
  • 404 – No such user in org unit, or no org unit found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.
PUT /d2l/api/le/(version)/(orgUnitId)/grades/(gradeObjectId)/values/(userId)

Provide a specific grade value for a particular user.

Parameters:
  • version (D2LVERSION) – API version.
  • orgUnitId (D2LID) – Org unit ID.
  • gradeObjectId (D2LID) – Grade object ID
  • userId (D2LID) – User ID.
JSON Parameters:
 
Status Codes:
  • 200 – Action succeeded.
  • 400 – Mismatch between provided incoming grade value type and grade object type.
  • 403 – No permission to see or manage grades.
  • 404 – No such user in org unit, or no grade object found, or no org unit found.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Input. This action expects a grade object of one of the first four grade object types.

Course completion

DELETE /d2l/api/le/(version)/(orgUnitId)/grades/courseCompletion/(completionId)

Delete a course completion.

Parameters:
  • version (D2LVERSION) – API version.
  • orgUnitId (D2LID) – Org unit ID.
  • completionId (D2LID) – Completion ID.
Status Codes:
  • 200 – Action succeeded.
  • 403 – No permission to delete course completion.
  • 404 – No such course completion found for org unit.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.
GET /d2l/api/le/(version)/(orgUnitId)/grades/courseCompletion/

Retrieve all the course completion records for an org unit.

Parameters:
Query Parameters:
 
  • userId (D2LID) – Optional. User ID.
  • startExpiry (UTCDateTime) – Optional. Start of expiration range to query.
  • endExpiry (UTCDateTime) – Optional. End of expirtation range to query.
  • bookmark (string) – Optional. Bookmark to use for fetching the next data set segment.
API Versions:
  • 200 – Action succeeded.
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Input. You can limit the scope of this query by providing an optional start and/or end date to clamp the search. You can also limit the scope of this query by providing an optional User ID (to fetch only course completions for that user within the org unit).

You can also use a bookmark query parameter as a paging offset, to indicate that the service should return the segment of results immediately following your bookmark.

Return. This action returns a paged result set containing the resulting CourseCompletion data blocks for the segment following your bookmark parameter (or the first segment if the parameter is empty or missing).

GET /d2l/api/le/(version)/grades/courseCompletion/(userId)/

Retrieve all the course completion records for a user.

Parameters:
Query Parameters:
 
  • startExpiry (UTCDateTime) – Optional. Start of expiration range to query.
  • endExpiry (UTCDateTime) – Optional. End of expirtation range to query.
  • bookmark (string) – Optional. Bookmark to use for fetching the next data set segment.
Status Codes:
  • 200 – Action succeeded.
  • 400 – Invalid expiration dates provided.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Input. You can limit the scope of this query by providing an optional start and/or end date to clamp the search.

You can also use a bookmark query parameter as a paging offset, to indicate that the service should return the segment of results immediately following your bookmark.

Return. This action returns a paged result set containing the resulting CourseCompletion data blocks for the segment following your bookmark parameter (or the first segment if the parameter is empty or missing).

POST /d2l/api/le/(version)/(orgUnitId)/grades/courseCompletion/

Create a new course completion for an org unit.

Parameters:
JSON Parameters:
 
Status Codes:
  • 200 – Action succeeded.
  • 400 – Invalid completion dates provided.
  • 403 – No permission to create course completion.
  • 404 – Unable to find created course completion.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a CourseCompletion JSON block with the newly created course completion record.

PUT /d2l/api/le/(version)/(orgUnitId)/grades/courseCompletion/(completionId)

Update an existing course completion.

Parameters:
  • version (D2LVERSION) – API version.
  • orgUnitId (D2LID) – Org unit ID.
  • completionId (D2LID) – Completion ID.
JSON Parameters:
 
Status Codes:
  • 200 – Action succeeded.
  • 400 – Invalid completion dates provided.
  • 403 – No permision to update course completion.
  • 404 – No such course completion found for org unit.
API Versions:
  • 1.1-Deprecated as of LMS v10.4.0.
  • 1.2+ – Route first appears in LMS v10.1.0.

Return. This action returns a CourseCompletion JSON block with the updated course completion record.


«  Dropboxes (Folders, categories, submissions, feedback)   ·  [   home  ·   forums  ·   reference   ·  index   ·  routing table   ·  modules   ]   ·  Course content (content objects, ISBNs, tables of content)  »