Calendar Events ¶

Calendar events are posted when a user performs any action pertaining to calendars, except for simply viewing calendar items. For example, a calendar event occurs when someone puts a new event on the calendar or modifies an existing event.

We use “calendar item” as a generic term that includes individual events on a calendar as well as calendars in general.

The actor is the user who performs the action, and the object is the calendar 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/<CalendarVerbString>"
        },
        "object": {
                "objectType": "Activity",
                "id": "urn:uuid:<CalendarItemUUID>",
                "definition": {
                        "type": "https://api.brightspace.com/xapi/activities/tools/<CalendarItemString>"
                }
        },
        "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": "<BrightspaceItemIdNumber>"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/context": {
                                "tenantId": "<TenantUUID>",
                                "originalEventId": "<InternalEventUUID>",
                                "orgUnitType": "<BrightspaceOrgUnitTypeString>",
                                "orgUnitId": "<BrightspaceOrgUnitIdNumber>"
                        }
                }
        }
}

Notes:

<CalendarVerbString>

may be one of

created
updated
deleted

<CalendarItemUUID>

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

<CalendarItemString>

indicates what type of calendar item was involved in this event. Possibilities are:

"type": "https://api.brightspace.com/xapi/activities/tools/calendar"

for an entire calendar, and

"type": "https://api.brightspace.com/xapi/activities/tools/calendar/event"

for an individual calendar 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.

Brightspace Data Streams (July 2023)

Calendar Events

Calendar Events¶

Calendar Events ¶