Grades Events ¶

Grades events are posted when someone creates or modifies a grade. The actor is the user who does the work, and the object is the record for the grade. The event object has the following form:

{
        "id": "<EventUUID>",
        "timestamp": "<UTCDateTimeString>",
        "actor": {
                "account": {
                        "homePage": "https://<TenantUUID>.lms.d2l.com/",
                        "name": "urn:uuid:<UserUUID>"
                }
        },
        "verb": {
                "id": "https://api.brightspace.com/xapi/verbs/<GradeVerbString>"
        },
        "object": {
                "objectType": "Activity",
                "id": "urn:uuid:<GradeRecordUUID>",
                "definition": {
                        "type": "https://api.brightspace.com/xapi/activities/tools/<GradeActivityString>"
                }
        },
        "context": {
                "contextActivities": {
                        "category": [
                                {
                                        "id": "https://api.brightspace.com/xapi/profiles/brightspace-activity-v1p0.jsonld"
                                }
                        ]
                },
                "registration": "<ContextUUID>",
                "extensions": {
                        "https://api.brightspace.com/xapi/extension_keys/context/actor": {
                                "userId": "<BrightspaceUserIdNumber>",
                                "imsRoleIds": [ <IMSRoles> ],
                                "impersonatingUserId": "<BrightspaceImpersonatingUserIdNumber>",
                                "roleId": "BrightspaceRoleIdNumber>"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/object": {
                                "id": "<BrightspaceGradeIdNumber>"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/context": {
                                "tenantId": "<TenantUUID>",
                                "originalEventId": "<InternalEventUUID>",
                                "orgUnitType": "<BrightspaceOrgUnitTypeString",
                                "orgUnitId": "<BrightspaceOrgUnitIdNumber>",
                        }
                }
        }
}

Notes:

<GradeVerbString>

is one of

created
updated
deleted
restored
released
predicted

<GradeActivitySting>

indicates what type of grade information was involved in this event. Possibilities are:

"type": "https://api.brightspace.com/xapi/activities/tools/grade"

for an overall grade.

"type": "https://api.brightspace.com/xapi/activities/tools/grade/item"

for an individual grade item.

"type": "https://api.brightspace.com/xapi/activities/tools/grade/final"

when a final grade is predicted.

<ContextUUID>

a unique identifier created by an algorithm that uses the OrgUnitID, TenantID and ContextID as input.

impersonatingUserID

only present if the user is being impersonated by a different user. If this field is present, then the Actor information refers to the person being impersonated, not the impersonator.

originalEventId

only provided for use by D2L personnel if needed for troubleshooting.

See Fundamental xAPI Concepts for information on other fields.

Brightspace Data Streams (July 2023)

Grades Events

Grades Events¶

Grades Events ¶