Enrollment Events ¶

Enrollment events are posted when someone enrolls or unenrolls in a class. The actor is the user who is enrolled or unenrolled, and the object is the class. 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/<EnrollmentVerbString>"
        },
        "object": {
                "objectType": "Activity",
                "id": "urn:uuid:<ClassUUID>",
                "definition": {
                        "type": "https://api.brightspace.com/xapi/activities/tools/classlist"
                }
        },
        "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": "<BrightspaceClassIdNumber>"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/context": {
                                "tenantId": "<TenantUUID>",
                                "originalEventId": "<InternalEventUUID>",
                                "orgUnitType": "<BrightspaceOrgUnitTypeString",
                                "orgUnitId": "<BrightspaceOrgUnitIdNumber>",
                        }
                }
        }
}

Notes:

<EnrollmentVerbString>

is one of:

enrolled
unenrolled

<ClassUUID>

is a unique identifier for the class created by an algorithm whose input is the TenantID, OrgUnit, and other information about the class.

<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)

Enrollment Events

Enrollment Events¶

Enrollment Events ¶