API Integrations

Usergroup Functions

usergroup__getUserList

Parameters:

p1: partition username
p2: usergroup name
p3: (optional) list type (defaults to "active"), other options "inactive" and "all"

Return Type:

String

Description:

Returns each user (as a username) from usergroup and from specified account as an XML node. You can specify the list type for the 3rd parameter. By default, returned count will be 'active' users. You can set 3rd parameter to inactive (to get inactive user list) or all (to get list of all users). Note that previous versions of this API command returned list of ALL users, and did not offer the 3rd parameter.

Example (using Code Kit):
// assumes partition username "anthony" exists
$data = APICommand( "usergroup__getUserList", "anthony", "Building 101" );
$xml = simplexml_load_string( $data );

foreach ( $xml->children() as $result ) { echo "{$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