Award Issued Events ¶

In Brightspace, users can issue an award to a particular user; this is only possible if the award is associated with the org unit it is issued in. The award issued events are posted when an award issuance is created, updated, revoked, or expired.

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/<IssuingVerbString>"
        },
        "object": {
                "objectType": "Activity",
                "id": "urn:uuid:<AwardIssuanceUUID>",
                "definition": {
                        "type": "https://api.brightspace.com/xapi/activities/tools/award/issue"
                }
        },
        "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": {
                                "awardId": "<BrightspaceAwardId>",
                                "issuanceId": "<BrightspaceAwardIssuanceId>",
                                "issuedUserId": "<BrightspaceIssuedUserId>"
                        },
                        "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
revoked
expired

<AwardIssuanceUUID>

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

<OrgUnitUUID>

a unique identifier for the OrgUnit of the event.

<BrightspaceIssuedUserId>

the ID of the of the award issuance’s user.

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 Issued Events

Award Issued Events¶

Award Issued Events ¶