Actor

Overview

The Actor object is a base model that is used to represent both users (Agents) and groups (Groups) as defined by the Experience API. In cases where an operation can be performed on either a user or a group, an Actor object is accepted by the Clear API.

In addition to the base xAPI properties of an Actor, this page will outline additional extensions defined by the Clear API that convey special meaning within the platform.

See the Experience API specification for more details: https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#actor

Agent

Example

Users are represented by an Actor object of Agent type as shown below:

{
  "objectType": "Agent",
  "account": {
    "homePage": "https://organisation.clearlrs.com",
    "name": "uuid"
  },
  "name": "John Smith",
  "extensions": {
    "http://clearlrs.com/api/ext/agent/attributes": {
      "Country": "Australia",
      "Department": "Sales",
      "Position Title": "Team Lead"
    }
  }
}

Reference

Field	Description
objectType	The type of Actor – must be "Agent" for users.
account	Unique identifier for this agent (or any other valid IFI as defined in the xAPI specification).
name	Display name for the user. Separate given and surnames may be recorded in the attributes extension, if desired.
extensions	Open object for any valid xAPI extensions, see the xAPI specification and the Extensions table below for Clear-defined extensions.

Extensions

Field	Description
Agent http://clearlrs.com/api/ext/agent	Status metadata about the agent including creation, activation and sync dates. Read-only
Attributes http://clearlrs.com/api/ext/agent/attributes	Arbitrary user profile metadata that take the form of key-value pairs. These attributes can then be used for filtering, reporting and assigning training.
Groups https://clearlrs.com/api/ext/agent/groups	Any Groups the user has been assigned to in the form of an Array of Actor objects. Read-only