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

Extensions

Last updated