API Integrations

Manager Functions

manager__add

Parameters:

p1: partition username
p2: desired user's username
p3: desired user's password
p4: OPTIONAL name=value pairs

Return Type:

Boolean (true or false)

Description:

Adds a user into specified account, with a role of manager (requires manager functionality). The p2 (username) and p3 (password) parameters are required parameters, but the 4th parameter (p4) of name=value pairs is optional, and worth discussing a bit further.

Each name=value should be separated by a two pipe characters (||), and each pair looks like this: name=value where name is the row name (like address, or first_name for example), and value is the value for that row.

For example, to set a user's first name and last name, p4 will look like this:

first_name=Bob||last_name=Jones

Here are the possible name values you can use for the name=value pairs:

first_name, last_name, email, middle_init, date_start, date_expire, company, address, city, state, zip, phone, custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9, custom10, custom11, custom12, custom13, custom14, custom15

Example (using Code Kit):
// assumes partition username "anthony" exists
// should return true if username Bob does not exist, or false if it does
// try to add manager Bob, with password of bob1, name of Robert Smith
// and Start Date of May 1, 2012
$data = APICommand( "manager__add", "anthony", "Bob", "bob1", "first_name=Robert|| last_name=Smith||date_start=20120501" );
$xml = simplexml_load_string( $data );
echo $xml->result;

Table of Contents

Axis LMS API Overview
Overview
Getting Started
API Tools
Understanding Return Values
Partition Functions
partition__getCount
partition__getList
partition__getRecord
User Functions
user__getCount
user__getList
user__getRecord
user__getUsername
user__getImage
user__getSSO
user__add
user__update
user__elevate
user__getManager
user__assignToManager
user__enroll
user__disenroll
user__getSysVars
user__getSysVar
user__setSysVar
Usergroup Functions
usergroup__getCount
usergroup__getList
usergroup__add
usergroup__remove
usergroup__getUserList
usergroup__getUserCount
usergroup__addUser
usergroup__removeUser
Manager Functions
manager__add
manager__getUsername
manager__assignEmployee
manager__getCourseKeywords
manager__setCourseKeywords
manager__getList
manager__getCount
manager__getUserList
manager__getUserCount
manager__getManagerList
manager__getManagerCount
Organization Functions
organizations__addUser
organizations__getBranches
organizations__getList
organizations__getUserCount
organizations__removeUser
Course Functions
course__getCount
course__getList
course__getRecord
course__getUserList
course__enrollUser
course__removeUser
Report Functions
report__getCourseInfo
report__getCourseActivityInfo
report__getUserInfo
report__getUserArchiveInfo
report__getUserCourseInfo
report__getUserTrainingSummary
Gradebook Functions
gradebook__getReportCard
Certifications Functions
certifications__getUserList
certifications__getUserInfo
certifications__getUserCeus
certifications__issueOfflineCert
certifications__issueOnlineCert
certifications__extend
certifications__getProgramID
certifications__getProgramList
System Functions
system__getApiVersion