Brightspace Data Streams (July 2023)

GroupsHome_View Event

«  GradesHome_View Event   ·  [   home  ·   community   |   search  ·   index   ·  next   ·  previous   ]   ·  Homepage_View Event  »

GroupsHome_View Event

GroupsHome_View is posted when a user views the list of groups for the current OrgUnit. The actor is the user who goes to the home page, and the object is the list of groups available to the user within the OrgUnit. 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:<GroupsHomeUUID>",
                "definition": {
                        "type": "https://api.brightspace.com/xapi/activities/tools/groups"
                }
        },
        "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:

<GroupsHomeUUID>

a unique identifier for the list of groups (the “groups home”) for a particular OrgUnit. This UUID is created by an algorithm whose input is the TenantID and OrgUnitID. This ID will be used whenever the list of groups for an OrgUnit is viewed or managed.

<OrgUnitUUID>

a unique identifier for the OrgUnit.

orgUnitTypeId

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

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.

«  GradesHome_View Event   ·  [   home  ·   community   |   search  ·   index   ·  next   ·  previous   ]   ·  Homepage_View Event  »