xAPI.js
  • xAPI.js
  • xAPI Wrapper Library
    • Introduction
    • Getting Started
    • The XAPI Class
    • Statement Resource
    • State Resource
    • Activity Profile Resource
    • Agent Profile Resource
    • About Resource
    • Agents Resource
    • Activities Resource
    • Helpers
    • Verbs
    • Attachment Usages
  • cmi5 Profile Library
    • Introduction
    • Getting Started
    • The Cmi5 Class
    • "cmi5 defined" Statement methods
    • "cmi5 allowed" Statement methods
    • Helpers
Powered by GitBook
On this page

Was this helpful?

Last updated 3 years ago

getAgent

Gets all agents used by a single person.

Example

Parameters

Returns

This method returns an AxiosPromise with the success data containing the if successful.

Person
  • getAgent
  • Example
  • Parameters
  • Returns
PreviousAbout ResourceNextActivities Resource
  1. xAPI Wrapper Library

Agents Resource

Gets agent information about a particular person.

Parameter

Type

Required

Description

agent

Agent

true

The agent experiencing the AU.

useCacheBuster

boolean

false

Enables cache busting.

const agent: Agent = {
  objectType: "Agent",
  name: "Test Agent",
  mbox: "mailto:test@agent.com"
};

xapi.getAgent({
  agent: agent
}).then((result: AxiosResponse<Person>) => {
  const person: Person = result.data;
  // do stuff with person
});