Brightspace Data Streams (July 2023)

CalendarEvent_View Event

«  Calendar Events   ·  [   home  ·   community   |   search  ·   index   ·  next   ·  previous   ]   ·  CalendarHome_View Event  »

CalendarEvent_View Event

CalendarEvent_View is posted when a user views a specific event on the user’s calendar. The actor is the user who views the event, and the object is the calendar event itself. 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/viewed"
        },
        "object": {
                "objectType": "Activity",
                "id": "urn:uuid:<CalendarEventUUID>",
                "definition": {
                        "type": "https://api.brightspace.com/xapi/activities/tools/calendar/event"
                }
        },
        "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>",
                                "impersonatingUserId": "<BrightspaceImpersonatingUserIdNumber>",
                                "roleId": "BrightspaceRoleIdNumber>"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/object": {
                                "id": "<BrightspaceEventIdNumber>"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/context": {
                                "tenantId": "<TenantUUID>",
                                "originalEventId": "<InternalEventUUID>",
                                "orgUnitId": "<BrightspaceOrgUnitIdNumber>",
                                "orgUnitTypeId": "<BrightspaceOrgUnitTypeIdNumber",
                                "imsRoleIds": [ <IMSRoles> ]
                        }
                }
        }
}

Notes:

<CalendarEventUUID>

a unique identifier for the calendar event. This UUID is created by an algorithm whose input is the TenantID, OrgUnitID, and calendar event ID. This UUID will be used whenever this event 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.

orgUnitTypeId

only present if the OrgUnit has been assigned a type ID number.

originalEventId

only provided for use by D2L personnel if needed for troubleshooting.

See Fundamental xAPI Concepts for information on other fields.

«  Calendar Events   ·  [   home  ·   community   |   search  ·   index   ·  next   ·  previous   ]   ·  CalendarHome_View Event  »