API Developer Reference

User Endpoints

user/enroll

IMPORTANT: The Axis Legacy API is deprecated and has been replaced with the Axis REST API

Parameters:

p1: partition username
p2: username
p3: course name to enroll user into
p4: OPTIONAL start date YYYYMMDD
p5: OPTIONAL end date YYYYMMDD

Return Type:

Boolean (true or false)

Description:

Enrolls an existing user from specified account into specified course. Returns true if user was enrolled, or false if it failed (or if user does not exist).

The p4 and p5 parameters are optional. They are used for setting an enrollment window of dates -- the date format should be YYYYMMDD, so for example a date of May 1, 2016 would be represented like this: 20160501.

 

Axis LMS API Overview
Overview
Getting Started
API Tools
PHP SDK
Javascript SDK
ColdFusion
Understanding Return Values
Certifications Endpoints
certifications/getuserlist
certifications/getuserinfo
certifications/getuserceus
certifications/issueofflinecert
certifications/issueonlinecert
certifications/extend
certifications/getprogramid
certifications/getprogramlist
Course Endpoints
course/getcount
course/getlist
course/getrecord
course/getuserlist
course/enrolluser
course/removeuser
Gradebook Endpoints
gradebook/getreportcard
ILT Endpoints
ilt/disenrolluser
ilt/enrolluser
ilt/getcompletedusers
ilt/getmeetings
ilt/getprograms
ilt/getsessions
ilt/getusersessions
ilt/setuserattendance
Learning Paths Endpoints
learningpaths/enrolluser
learningpaths/disenrolluser
learningpaths/getpaths
learningpaths/getusers
learningpaths/getuserstatus
learningpaths/resetuser
Manager Endpoints
manager/add
manager/demote
manager/assignemployee
manager/moveemployees
manager/getcoursekeywords
manager/setcoursekeywords
manager/getusername
manager/getlist
manager/getcount
manager/getuserlist
manager/getusercount
manager/getmanagerlist
manager/getmanagercount
Organization Endpoints
organizations/adduser
organizations/getbranches
organizations/getlist
organizations/getusercount
organizations/removeuser
Report Endpoints
report/getcourseinfo
report/getcourseactivityinfo
report/getuserinfo
report/getuserarchiveinfo
report/getusercourseinfo
report/getuserdetailedscoreinfo
report/getusertrainingsummary
System Endpoints
system/getapiversion
User Endpoints
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 Endpoints
usergroup/getcount
usergroup/getlist
usergroup/add
usergroup/remove
usergroup/getuserlist
usergroup/getusercount
usergroup/adduser
usergroup/removeuser