Brightspace Data Streams (July 2023)

Award Events

«  Assignment Events   ·  [   home  ·   community   |   search  ·   index   ·  next   ·  previous   ]   ·  Award Association Events  »

Award EventsΒΆ

Award events are posted when a user performs certain action pertaining to awards, specifically creating, updating and deleting awards.

The actor is the user who performs the action, and the object is the award item involved. 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/<AwardVerbString>"
        },
        "object": {
                "objectType": "Activity",
                "id": "urn:uuid:<AwardItemUUID>",
                "definition": {
                        "type": "https://api.brightspace.com/xapi/activities/tools/award"
                }
        },
        "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": {
                                "originalUserId": <BrightspaceUserIdNumber>,
                                "userId": "urn:uuid:<UserUUID>",
                                "id": "<BrightspaceItemIdNumber>"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/context": {
                                "tenantId": "<TenantUUID>",
                                "originalEventId": "<InternalEventUUID>",
                                "orgUnitType": "<BrightspaceOrgUnitTypeString>",
                                "orgUnitId": "<BrightspaceOrgUnitIdNumber>"
                        }
                }
        }
}

Notes:

<AwardVerbString>

may be one of

created
updated
deleted
<AwardItemUUID>

a unique identifier for the award item. This UUID is created by an algorithm whose input is the TenantID and award item information. This UUID will be used whenever this item is referenced by any BDS event.

<OrgUnitUUID>

a unique identifier for the OrgUnit.

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.

«  Assignment Events   ·  [   home  ·   community   |   search  ·   index   ·  next   ·  previous   ]   ·  Award Association Events  »