ActivityExemptionEvent ¶

ActivityExemptionEvent objects are posted when an authorized user exempts or unexempts another user from an activity. The actor is the user who grants the exemption or revokes it, and the object is the person who is exempted. The activity from which the person is exempted is specified by the https://api.brightspace.com/xapi/extension_keys/context/object field within the context part of the event. 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/<ExemptionVerbString>"
        },
        "object": {
                "objectType": "Activity",
                "id": "urn:uuid:<ExemptionUUID>",
                "definition": {
                        "type": "https://api.brightspace.com/xapi/activities/tools/exemption"
                }
        },
        "context": {
                "contextActivities": {
                        "category": [
                                {
                                        "id": "https://api.brightspace.com/xapi/profiles/brightspace-activity-v1p0.jsonld"
                                }
                        ]
                },
                "registration": "<OrgUnitUUID>",
                "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": "<BrightspaceActivityId>",
                                "associatedOrgUnitId": "<AssociatedOrgUnitIdNumber>",
                                "associatedUserId": "<ExemptedUserIdNumber>",
                                "associatedObjectId": "<BrightspaceObjectIdNumber>",
                                "associatedToolId": "<BrightspaceToolIdNumber>"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/context": {
                                "tenantId": "<TenantUUID>",
                                "originalEventId": "<InternalEventUUID>",
                                "orgUnitType": "<BrightspaceOrgUnitTypeString>",
                                "orgUnitId": "<BrightspaceOrgUnitIdNumber>"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/target": {
                                "id": "urn:uuid:<UserUUID>",
                                "originalId": "<ExemptedUserIdNumber>",
                                "definition": {
                                        "type": "https://api.brightspace.com/xapi/activities/users/user"
                                }
                        }
                }
        }
}

Notes:

<ExemptionVerbString>

may be one of

exempted
unexempted

<ExemptionUUID>

a unique identifier for the exemption. This UUID is created by an aglorithm whose input is the TenantID, the ActivityID, the OrgUnitID, and the exempted user ID number. This UUID will be used whenever this exemption is referenced by a BDS event.

<OrgUnitUUID>

a unique identifier for the OrgUnit.

<BrightspaceActivityId>

identifies the activity from which the user has been exempted.

<AssociatedOrgUnitIdNumber>

the Brightspace ID number for the org unit in which the exemption occurs.

<ExemptedUserIdNumber>

the Brightspace user ID number for the user associated with the exemption.

<BrightspaceObjectIdNumber>, <BrightspaceToolIdNumber>

the Brightspace ID numbers for the underlying object and tool comprised by the activity from which the user has been exempted.

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)

ActivityExemptionEvent

ActivityExemptionEvent¶

ActivityExemptionEvent ¶