Attributes¶

ASSESSMENT_T¶

We categorize the kinds of assessments that can be performed, and use the term ASSESSMENT_T to stand in for an appropriate string name.

Assessment type
Rubric

EVAL_T¶

We categorize the kinds of objects that can be associated with (evalutated by) rubrics, and use the term EVAL_T to stand in for an appropriate string name.

Object type for evaluation
Dropbox
ManualAssessment
Quiz
Survey
Discussion
Grades
ContentObject

RUBRIC_T¶

We categorize the kinds of scoring rubrics into types, and use the term RUBRIC_T to stand in for an appropriate integer value.

Rubric type	Value
Holistic	0
Analytic	1

SCORING_M¶

We support a number of different ways of scoring when providing assessments. We use the term SCORING_M to stand in for an appropriate integer value.

Scoring method	Value
TextOnly	0
Points	1
TextAndNumeric	2
CustomPoints	3

Rubric.CriteriaGroup¶

{
    "Name": <string>,
    "Levels": [  // Array of Level blocks
        { <composite:Level> },
        { <composite:Level> }, ...
    ],
    "Criteria": [  // Array of Criterion blocks
        {
            "Id": <number:D2LID>,
            "Name": <string>,
            "Cells": [  // Array of CriterionCell blocks
                {
                    "Feedback": { <composite:RichText> },
                    "Description": { <composite:RichText> },
                    "Points": <number:decimal>|null
                },
                { <composite:CriterionCell> }, ...
            ]
        },
        { <composite:Criterion> }, ...
    ]
}

Rubric.Level¶

{
    "Id": <number:D2LID>,
    "Name": <string>,
    "Points": <number:decimal>|null
}

Rubric.OverallLevel¶

{
    "Id": <number:D2LID>,
    "Name": <string>,
    "RangeStart": <number:decimal>|null,
    "Description": { <composite:RichText> },
    "Feedback": { <composite:RichText> }
}

Description and Feedback properties

Note that these properties require a RichText object.

Rubric.Rubric¶

Defines a rubric in the abstract, without any attached assessment.

{
    "RubricId": <number:D2LID>,
    "Name": <string>,
    "Description": "{composite:RichText}",
    "RubricType": <number:RUBRIC_T>,
    "ScoringMethod": <number:SCORING_M>,
    "CriteriaGroups": [  // Array of CriteriaGroup blocks
        { <composite:CriteriaGroup> },
        { <composite:CriteriaGroup> }, ...
    ],
    "OverallLevels": [  // Array of OverallLevel blocks
        { <composite:Overalllevel> },
        { <composite:OverallLevel> }, ...
    ]
}

Rubric.RubricAssessment¶

Defines an assessment with accompanying rubric.

{
    "RubricId": <number:D2LID>,
    "OverallScore": <number:decimal>|null,
    "OverallFeedback": { <composite:RichText> },
    "OverallLevel": { // Note that the OverallLevel property may be null
        "LevelId": <number:D2LID>,
        "Feedback": { <composite:RichText> }
    },
    "OverallScoreOverridden": <boolean>,
    "OverallFeedbackOverridden": <boolean>,
    "CriteriaOutcome": [ // Array of CriterionOutcome blocks
        {
            "CriterionId": <number:D2LID>,
            "LevelId": <number:D2LID>|null,
            "Score": <number:decimal>|null,
            "ScoreIsOverridden": <boolean>,
            "Feedback": { <composite:RichText> },
            "FeedbackIsOverridden": <boolean>
        },
        { <composite:CriterionOutcome> }, ...
    ]
}

Actions¶

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

Retrieve rubrics for an object in an org unit.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

Query Parameters:

• objectType (EVAL_T) – Type name for object associated with the evaluation.

• objectId (D2LID) – Object ID.

Status Codes:

• 200 OK – Action successful.

• 403 Forbidden – Not permitted to view one of the matched rubrics.

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

API Versions:

• unstable – Route first appears in LE v10.5.2.

Input. You must provide a particular object type name (for example, Discussion), and the identifier for that object.

Return. This action returns a JSON array of Rubric blocks for all the rubrics that apply to your specified object.

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

Retrieve an assessment in an org unit.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

Query Parameters:

• assessmentType (ASSESSMENT_T) – Assessment type.

• objectType (EVAL_T) – Type name for object associated with the assessment.

• objectId (D2LID) – Object ID.

• rubricId (D2LID) – Rubrid ID.

• userId (D2LID) – User for whom the assessment applies.

Status Codes:

• 200 OK – Action successful.

• 403 Forbidden – Not permitted to view matched rubric.

• 404 Not Found – No matching rubrics found.

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

API Versions:

• unstable – Route first appears in LE v10.5.2.

Input. You must provide: a particular object type name (for example, Discussion), the identifier for that object, an assessment type, a rubric identifier for the relevant rubric, and the user ID for the user in question.

Return. This action returns a RubricAssessment JSON structure.

PUT /d2l/api/le/(version)/(orgUnitId)/assessment¶

Update an assessment in an org unit.

Parameters:

• version (D2LVERSION) – API version.

• orgUnitId (D2LID) – Org unit ID.

Query Parameters:

• assessmentType (ASSESSMENT_T) – Assessment type.

• objectType (EVAL_T) – Type name for object associated with the assessment.

• objectId (D2LID) – Object ID.

• userId (D2LID) – User for whom the assessment applies.

Status Codes:

• 200 OK – Action successful.

• 403 Forbidden – Not permitted to view matched rubric.

• 404 Not Found – No matching rubrics found.

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

API Versions:

• unstable – Route first appears in LE v10.5.2.

Input. You must provide a query parameter value for: a particular object type name (for example, Discussion); the identifier for that object; an assessment type; and the user ID for the user in question. You must also provide a RubricAssessment for the new assessment for the user.

Return. This action returns the updated value of the assessment in a RubricAssessment JSON structure.