API Integrations

Getting Started

Understanding Return Values

When you run an API call, the data returned is always in XML, which looks something like this:

<api_result>
<result>The Result</result>
</api_result>

... or it could look like this (multiple results) ...

<api_result>
<result>The Result</result>
<result>The Result</result>
<result>The Result</result>
</api_result>

... or like this (specific tags determined by exact API function) ...

<api_result>
<some_tag>The Result</some_tag>
<another_tag>The Result</another_tag>
<third_tag>The Result</third_tag>
</api_result>

As you can see, there can be more than one returned (typically for the getList functions), or named tags (usually for getRecord functions). The data returned inside each or named tag can be a boolean value (true/false), an integer value, a string, or a tagged (xml-like) string. Each command explained later reveals what kind of data it will return.

A special note on the tagged (xml-like) string that is returned by some functions. The structure is very similar to XML, but it is not necessarily valid XML. It’s easy enough to parse through though - take a look at the api_wrapper.php file for a function named get_tag_data() to see how it works (if you are using PHP, you won’t have to worry about writing the function, but you you are using another language, you can use that as the basis for writing your own function).

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