Brightspace Data Streams (July 2023)

CalendarHome_View Event

«  CalendarEvent_View Event   ·  [   home  ·   community   |   search  ·   index   ·  next   ·  previous   ]   ·  Content Events  »

CalendarHome_View Event

CalendarHome_View is posted when a user views the home page for the user’s calendar. The actor is the user who views the page, and the object is the calendar home page 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:<CalendarHomePageUUID>",
                "definition": {
                        "type": "https://api.brightspace.com/xapi/activities/tools/calendar"
                }
        },
        "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/context": {
                                "tenantId": "<TenantUUID>",
                                "originalEventId": "<InternalEventUUID>",
                                "orgUnitId": "<BrightspaceOrgUnitIdNumber>",
                                "orgUnitTypeId": "<BrightspaceOrgUnitTypeIdNumber",
                                "imsRoleIds": [ <IMSRoles> ]
                        }
                }
        }
}

Notes:

<CalendarHomePageUUID>

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

«  CalendarEvent_View Event   ·  [   home  ·   community   |   search  ·   index   ·  next   ·  previous   ]   ·  Content Events  »