API Integrations

User Functions

user__disenroll

Parameters:

p1: partition username
p2: username
p3: course name to enroll user into

Return Type:

Boolean (true or false)

Description:

Dis-enrolls an existing user from specified account out of the specified course. Returns true if user was dis-enrolled (or was not enrolled in the first place).

Example (using Code Kit):
// assumes partition username "anthony" exists
// try to disenroll username Bob out of course named Sample Course
$data = APICommand( "user__disenroll", "anthony", "Bob", "Sample Course" );
$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
Learning Paths Commands
learningpaths__enrolluser
learningpaths__disenrolluser
learningpaths__getpaths
learningpaths__getusers
learningpaths__getuserstatus
learningpaths__resetuser
System Functions
system__getApiVersion