API Integrations

Certifications Functions

certifications__issueOnlineCert

Parameters:

p1: partition username
p2: user username
p3: program name
p4: certification number
p5: (optional) date string

Return Type:

Boolean (true or false)

Description:

Issues a certification to a user that is an existing online certification (one that exists in the LMS as an online achievable certification). You may need to use the certifications__getList API command to identify the id you will need to pass as p3 here. The optional date string parameter (p5), if included, allows you to send the issue date and expire date of the certification in the following format: YYYYMMDD-YYYYMMDD, whereas the first date is the issue date, and the second date is the expire date (otherwise, the date will be today for issue, and today + programs configured duration for expire). The issue date can not be in the future, and the expire date can not be earlier than the issue date. Function returns false if any parameter is invalid, otherwise the function returns true.

Example (using Code Kit):
// assumes partition username "admin" exists, user username "b54776a" exists and cert program id 5 exists
$data = APICommand( "certifications__issueonlinecert", "admin", "b54776a", 5, "c12345", "20200101-20201231");
$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