Award Association Events ¶

In Brightspace, users can associate an award with a particular org unit; this makes the award available for issuing to users within that org unit. The award association events are posted when a user performs certain actions pertaining to the management of these award associations: specifically, creating, updating and deleting these associations. Note that the management of the awards themselves, and the issuing of them to users, are dealt with in other event types.

The actor is the user who performs the action, and the object is the award association 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:<AwardAssociationUUID>",
                "definition": {
                        "type": "https://api.brightspace.com/xapi/activities/tools/award/association"
                }
        },
        "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": {
            "associationId": "<BrightspaceAwardAssociationId>",
            "awardId": "<BrightspaceAwardId>",
            "associatedOrgUnitId": "<BrightspaceAssociatedOrgUnitId>"
                        },
                        "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

<AwardAssociationUUID>

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

<OrgUnitUUID>

a unique identifier for the OrgUnit of the event.

<BrightspaceAssociatedOrgUnitId>

the ID of the of the award association’s org unit.

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)

Award Association Events

Award Association Events¶

Award Association Events ¶