Axis LMS MCP by usefulapi
Read Axis LMS users, courses, learning paths, certifications and reports; manage enrollments.
Should I use this
Quality & Safety
Findings (10)
- LOWTool 'axislms_list_learningpath_users' name length outside 3-30 rangein axislms_list_learningpath_users
- LOWTool 'axislms_list_certification_users' name length outside 3-30 rangein axislms_list_certification_users
- LOWTool 'axislms_list_organization_branches' name length outside 3-30 rangein axislms_list_organization_branches
- LOWTool 'axislms_list_organization_users' name length outside 3-30 rangein axislms_list_organization_users
- LOWTool 'axislms_unenroll_user_from_course' name length outside 3-30 rangein axislms_unenroll_user_from_course
- LOWTool 'axislms_enroll_user_in_learningpath' name length outside 3-30 rangein axislms_enroll_user_in_learningpath
- LOWTool 'axislms_unenroll_user_from_learningpath' name length outside 3-30 rangein axislms_unenroll_user_from_learningpath
- LOWTool 'axislms_enroll_user_in_ilt_session' name length outside 3-30 rangein axislms_enroll_user_in_ilt_session
- LOWTool 'axislms_unenroll_user_from_ilt_session' name length outside 3-30 rangein axislms_unenroll_user_from_ilt_session
- LOWTool 'axislms_remove_usergroup_member' name length outside 3-30 rangein axislms_remove_usergroup_member
Based on automated analysis of tool definitions and protocol compliance.
Context Cost
This is the approximate number of tokens consumed each time the server's tools are loaded into a model's context. Higher counts reduce the attention available for other tasks.
Install
One-Click Install
Add this to your `claude_desktop_config.json` file:
{
"mcpServers": {
"axis-lms": {
"url": "https://axis-lms.usefulapi.io/mcp"
}
}
}Remote endpoints
https://axis-lms.usefulapi.io/mcpstreamable-httpWhat it can do
Tool inventory
Tools (44)
🟢axislms_list_users(status)
List the LMS users (id and username only), active, inactive or all. Not paged: a large LMS returns every user. For names, emails or filters use axislms_search_users. GET /users/list/{status}/.
Input Schema
{
"type": "object",
"properties": {
"status": {
"description": "Default active.",
"type": "string",
"enum": [
"active",
"inactive",
"all"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_get_user(user_id, fields)
One user by id with the fields you ask for: profile (name, email, address, phone, custom1-15, role, manager_id, dates), usergroups, enrolled courses, ILT classes, certifications, learning paths, badges, organizations and system variables. Contains personal data. GET /users/{id}/?fields=.
Input Schema
{
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Axis user id (from axislms_list_users or axislms_search_users)."
},
"fields": {
"description": "User fields to return (default: id and username). The first field is also the sort key. The sso login link is not available.",
"minItems": 1,
"maxItems": 40,
"type": "array",
"items": {
"type": "string",
"enum": [
"id",
"username",
"first_name",
"last_name",
"email",
"middle_init",
"date_start",
"date_expire",
"company",
"address",
"city",
"state",
"zip",
"phone",
"custom1",
"custom2",
"custom3",
"custom4",
"custom5",
"custom6",
"custom7",
"custom8",
"custom9",
"custom10",
"custom11",
"custom12",
"custom13",
"custom14",
"custom15",
"localization",
"role",
"manager_id",
"usergroups",
"courses",
"iltclasses",
"certifications",
"learningpaths",
"badges",
"organizations",
"sysvars"
]
}
}
},
"required": [
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_search_users(user_filter, fields, page)
Page through all users, or only those matching a search phrase (for example email~example.com,role=manager), returning the fields you ask for. Contains personal data. GET /users/all/ or /users/filtered/ (page{n}).
Input Schema
{
"type": "object",
"properties": {
"user_filter": {
"type": "string",
"minLength": 1,
"maxLength": 500,
"description": "Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50"
},
"fields": {
"description": "User fields to return (default: id and username). The first field is also the sort key. The sso login link is not available.",
"minItems": 1,
"maxItems": 40,
"type": "array",
"items": {
"type": "string",
"enum": [
"id",
"username",
"first_name",
"last_name",
"email",
"middle_init",
"date_start",
"date_expire",
"company",
"address",
"city",
"state",
"zip",
"phone",
"custom1",
"custom2",
"custom3",
"custom4",
"custom5",
"custom6",
"custom7",
"custom8",
"custom9",
"custom10",
"custom11",
"custom12",
"custom13",
"custom14",
"custom15",
"localization",
"role",
"manager_id",
"usergroups",
"courses",
"iltclasses",
"certifications",
"learningpaths",
"badges",
"organizations",
"sysvars"
]
}
},
"page": {
"description": "Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_count_users(user_filter)
Number of users, all or matching a search phrase. GET /users/all/count/ or /users/filtered/count/?user_filter=.
Input Schema
{
"type": "object",
"properties": {
"user_filter": {
"type": "string",
"minLength": 1,
"maxLength": 500,
"description": "Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_courses
List the active online courses (id and name), plus the count. GET /courses/list/.
Input Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_count_courses
Number of active online courses. GET /courses/count/.
Input Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_get_course(course_id)
One online course: name, catalog id, description, active flag, created/updated dates, keyword tags, passing score, price and whether it is for sale, thumbnail, webhook. GET /courses/{id}/.
Input Schema
{
"type": "object",
"properties": {
"course_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Axis course id (from axislms_list_courses)."
}
},
"required": [
"course_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_course_users(course_id, status)
Users enrolled in a course with their access start and end dates (YYYYMMDD): active, expired or all enrollments. GET /courses/{id}/users/{status}/.
Input Schema
{
"type": "object",
"properties": {
"course_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"description": "Default active.",
"type": "string",
"enum": [
"active",
"expired",
"all"
]
}
},
"required": [
"course_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_usergroups
List usergroups (id and name). GET /usergroups/list/.
Input Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_get_usergroup(usergroup_id)
One usergroup: name, member counts (active, inactive, total) and owner. GET /usergroups/{id}/.
Input Schema
{
"type": "object",
"properties": {
"usergroup_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"usergroup_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_usergroup_members(usergroup_id, status)
Members of a usergroup (id and username): active, inactive or all. GET /usergroups/{id}/members/{status}/.
Input Schema
{
"type": "object",
"properties": {
"usergroup_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"description": "Default active.",
"type": "string",
"enum": [
"active",
"inactive",
"all"
]
}
},
"required": [
"usergroup_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_learningpaths
List the active learning paths (id and name). GET /learningpaths/list/.
Input Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_learningpath_users(learningpath_id, user_id)
Active enrolled users of a learning path (or one user), with status, start and completion time, completion method, path version, current branch and step, and progress. GET /learningpaths/{id}/users/[{user_id}/].
Input Schema
{
"type": "object",
"properties": {
"learningpath_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"user_id": {
"description": "Only this enrolled user.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"learningpath_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_certifications(status)
List certification programs (id and name): active, inactive or all. GET /certifications/list/{status}/.
Input Schema
{
"type": "object",
"properties": {
"status": {
"description": "Default active.",
"type": "string",
"enum": [
"active",
"inactive",
"all"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_get_certification(program_id)
One certification program: name, prefix, description, keyword tags, webhook and status. GET /certifications/{program_id}/.
Input Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"program_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_certification_users(program_id)
Users certified in a certification program (id and username). GET /certifications/{program_id}/users/.
Input Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"program_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_user_certificates(user_id)
The certifications a user holds: program, certification number, issue, renew and expire dates (YYYYMMDD). GET /certifications/certificates/{user_id}/.
Input Schema
{
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_user_ceus(user_id)
Continuing-education credits (CEUs) a user earned: type, name, credits and issue date. GET /certifications/ceus/{user_id}/.
Input Schema
{
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_ilt_programs
List instructor-led training (ILT) programs (id and name). GET /ilt/list/.
Input Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_get_ilt_program(program_id)
One ILT program: name, catalog id, description and keyword tags. GET /ilt/{program_id}/.
Input Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"program_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_ilt_sessions(program_id, scope)
Sessions of an ILT program with start and end dates and seats (total, reserved, remaining): current ones or all. GET /ilt/{program_id}/sessions/{current|all}/.
Input Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"scope": {
"description": "Default current.",
"type": "string",
"enum": [
"current",
"all"
]
}
},
"required": [
"program_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_ilt_meetings(program_id, session_id)
Meetings of one ILT session: date, time, timezone, duration, GMT start and end, facility. GET /ilt/{program_id}/meetings/{session_id}/.
Input Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"session_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"program_id",
"session_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_ilt_completions(program_id, session_id)
Users who completed an ILT program, or one session of it (id and username). GET /ilt/{program_id}/completions/[{session_id}/].
Input Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"session_id": {
"description": "Only this session.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"program_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_user_ilt_sessions(user_id)
ILT sessions a user is part of: program, session, start and end dates and percent attended. GET /ilt/users/{user_id}/sessions/.
Input Schema
{
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_organizations(owner_id)
List organizations with owner id and user count, all or those owned by one manager (owner id 0 = the partition admin). GET /organizations/list/{all|owner_id}/.
Input Schema
{
"type": "object",
"properties": {
"owner_id": {
"description": "Only organizations owned by this manager's user id; omit for all.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_organization_branches(organization_id)
The branches of an organization (nested branches included). GET /organizations/branches/{organization_id}/.
Input Schema
{
"type": "object",
"properties": {
"organization_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"organization_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_list_organization_users(organization_id, status)
Users in an organization (id, username, branch id): active, inactive or all. GET /organizations/users/{organization_id}/{status}/.
Input Schema
{
"type": "object",
"properties": {
"organization_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"description": "Default active.",
"type": "string",
"enum": [
"active",
"inactive",
"all"
]
}
},
"required": [
"organization_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_course_report(course_id, user_filter, status, min_progress, max_progress, ...)
Who is doing what in one online course: user, status, progress %, score, start and completion date (YYYYMMDD). Filter by users, status, progress, score and dates. Limited to users currently enrolled who accessed the course or have score data. Paged (100 per page). GET /reports/courses/{course_id}/.
Input Schema
{
"type": "object",
"properties": {
"course_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"user_filter": {
"type": "string",
"minLength": 1,
"maxLength": 500,
"description": "Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50"
},
"status": {
"type": "string",
"enum": [
"passed",
"failed",
"complete",
"incomplete"
]
},
"min_progress": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"max_progress": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"min_score": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"max_score": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"min_start_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"max_start_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"min_completion_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"max_completion_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"page": {
"description": "Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"count_only": {
"description": "If true, return only the number of matching records (and pages) instead of the records.",
"type": "boolean"
}
},
"required": [
"course_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_certification_report(program_id, user_filter, certification_number, method_earned, min_issue_date, ...)
Certifications issued in one certification program: user, certification number, how it was earned, issue, renewed and expire date (YYYYMMDD). Filter by users, number, method and dates. Paged (100 per page). GET /reports/certifications/{program_id}/.
Input Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"user_filter": {
"type": "string",
"minLength": 1,
"maxLength": 500,
"description": "Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50"
},
"certification_number": {
"description": "Contains match.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"method_earned": {
"description": "Contains match, e.g. course:1084.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"min_issue_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"max_issue_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"min_renewed_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"max_renewed_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"min_expire_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"max_expire_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"page": {
"description": "Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"count_only": {
"description": "If true, return only the number of matching records (and pages) instead of the records.",
"type": "boolean"
}
},
"required": [
"program_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_learningpath_report(learningpath_id, user_filter, status, type, min_start_date, ...)
Learning path enrollments and results for one path: user, status (complete or incomplete), active or archived, start and completion date (YYYYMMDD). Paged (100 per page). GET /reports/learningpaths/{learningpath_id}/.
Input Schema
{
"type": "object",
"properties": {
"learningpath_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"user_filter": {
"type": "string",
"minLength": 1,
"maxLength": 500,
"description": "Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50"
},
"status": {
"type": "string",
"enum": [
"complete",
"incomplete"
]
},
"type": {
"type": "string",
"enum": [
"active",
"archived"
]
},
"min_start_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"max_start_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"min_completion_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"max_completion_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"page": {
"description": "Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"count_only": {
"description": "If true, return only the number of matching records (and pages) instead of the records.",
"type": "boolean"
}
},
"required": [
"learningpath_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_ilt_report(program_id, user_filter, status, session_id, session_name, ...)
Attendance and results of one ILT program: user, session, start and end date, meetings and meetings attended, status. Filter by users, status, session and dates. Paged (100 per page). GET /reports/ilt/{program_id}/.
Input Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"user_filter": {
"type": "string",
"minLength": 1,
"maxLength": 500,
"description": "Axis user search phrase: field-name + operator + value, several joined by commas (all must match). Operators: = equals, != not equal, ~ contains, !~ does not contain; for usergroup, ~ means 'is in' and !~ 'is not in'. Fields: id, manager_id, org_id, branch_id, username, first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1..custom15, localization, role, usergroup, date_start, date_expire. Examples: state=nj | email~example.com | manager_id=12,usergroup~sales,branch_id=50"
},
"status": {
"description": "Result status as shown in the report, e.g. complete, incomplete, unavailable.",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"session_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"session_name": {
"description": "Contains match.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"method_earned": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"min_meetings_attended": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"max_meetings_attended": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"min_start_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"max_start_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"min_end_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"max_end_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"max_expire_date": {
"description": "yyyy-mm-dd",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"page": {
"description": "Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"count_only": {
"description": "If true, return only the number of matching records (and pages) instead of the records.",
"type": "boolean"
}
},
"required": [
"program_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢axislms_user_report(kind, user_id, user_filter, scope, page, ...)
A learner's records across the LMS, for one user, for all users, or for users matching a search phrase. kind: courses (status, progress, score, dates), archived (archived and imported course results), certifications, ilt, or learningpaths. Contains personal data; paged (100 per page). GET /reports/users/{user_id|all|filtered}/{kind}/.
Input Schema
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"courses",
"archived",
"certifications",
"ilt",
"learningpaths"
]
},
"user_id": {
"description": "One user (scope 'user').",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"user_filter": {
"description": "Required for scope 'filtered' (syntax as described).",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"scope": {
"type": "string",
"enum": [
"user",
"all",
"filtered"
],
"description": "user = needs user_id; all = every user; filtered = needs user_filter."
},
"page": {
"description": "Page number, from 1 (default 1); 100 records per page. Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"count_only": {
"description": "If true, return only the number of matching records (and pages) instead of the records.",
"type": "boolean"
}
},
"required": [
"kind",
"scope"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴axislms_enroll_user_in_course(course_id, user_id, start, end)
WRITE: enroll a user in an online course (optionally with access start and end dates). The user and the course must be active. If the user is already enrolled, send start or end to change the enrollment dates. Depending on the LMS settings the user may be notified. POST /courses/enrollments/{course_id}/{user_id}/.
Input Schema
{
"type": "object",
"properties": {
"course_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"user_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"start": {
"description": "Access start date, yyyy-mm-dd.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"end": {
"description": "Access end date, yyyy-mm-dd; must be after the start date.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"required": [
"course_id",
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴axislms_unenroll_user_from_course(course_id, user_id)
WRITE: remove a user from an online course. The user loses access to the course. DELETE /courses/enrollments/{course_id}/{user_id}/.
Input Schema
{
"type": "object",
"properties": {
"course_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"user_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"course_id",
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡axislms_enroll_user_in_learningpath(learningpath_id, user_id)
WRITE: enroll an active user in a learning path. The user must not already be enrolled. POST /learningpaths/enrollments/{learningpath_id}/users/{user_id}/.
Input Schema
{
"type": "object",
"properties": {
"learningpath_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"user_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"learningpath_id",
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴axislms_unenroll_user_from_learningpath(learningpath_id, user_id)
WRITE: remove a user from a learning path they are enrolled in. DELETE /learningpaths/enrollments/{learningpath_id}/users/{user_id}/.
Input Schema
{
"type": "object",
"properties": {
"learningpath_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"user_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"learningpath_id",
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡axislms_enroll_user_in_ilt_session(program_id, session_id, user_id)
WRITE: enroll a user in a session of an ILT program (takes a seat; check seats_remaining with axislms_list_ilt_sessions first). POST /ilt/enrollments/{program_id}/{session_id}/{user_id}/.
Input Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"session_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"user_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"program_id",
"session_id",
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴axislms_unenroll_user_from_ilt_session(program_id, session_id, user_id)
WRITE: remove a user from a session of an ILT program. DELETE /ilt/enrollments/{program_id}/{session_id}/{user_id}/.
Input Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"session_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"user_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"program_id",
"session_id",
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴axislms_mark_ilt_attendance(program_id, session_id, meeting_id, user_id, attendance)
WRITE: mark a user attended or absent for one ILT meeting. The user must already be enrolled in the meeting. Attendance can count toward completion. PUT /ilt/attendance/{program_id}/{session_id}/{meeting_id}/{user_id}/{attended|absent}/.
Input Schema
{
"type": "object",
"properties": {
"program_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"session_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"meeting_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"user_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"attendance": {
"type": "string",
"enum": [
"attended",
"absent"
]
}
},
"required": [
"program_id",
"session_id",
"meeting_id",
"user_id",
"attendance"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡axislms_create_user(username, first_name, last_name, email, middle_init, ...)
WRITE: create a new LMS user. The username must be 4-40 characters (letters, numbers, @ . _ -) and not in use. Returns the new user id. The temporary password the LMS generates is never shown here: give the person access through the LMS itself (its password reset, invitation or single sign-on). Depending on the LMS settings the user may be notified. POST /users/.
Input Schema
{
"type": "object",
"properties": {
"username": {
"type": "string",
"pattern": "^[A-Za-z0-9@._-]{4,40}$"
},
"first_name": {
"type": "string",
"maxLength": 100
},
"last_name": {
"type": "string",
"maxLength": 100
},
"email": {
"type": "string",
"maxLength": 80
},
"middle_init": {
"type": "string",
"maxLength": 1
},
"date_start": {
"description": "Account start date, yyyy-mm-dd.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"date_expire": {
"description": "Account expiry date, yyyy-mm-dd.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"company": {
"type": "string",
"maxLength": 255
},
"address": {
"type": "string",
"maxLength": 255
},
"city": {
"type": "string",
"maxLength": 100
},
"state": {
"type": "string",
"maxLength": 4
},
"zip": {
"type": "string",
"maxLength": 10
},
"phone": {
"type": "string",
"maxLength": 20
},
"localization": {
"description": "A language pack name installed in the LMS.",
"type": "string",
"maxLength": 100
},
"role": {
"type": "string",
"enum": [
"learner",
"manager"
]
},
"manager_id": {
"description": "User id of a manager.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"custom1": {
"type": "string",
"maxLength": 255
},
"custom2": {
"type": "string",
"maxLength": 255
},
"custom3": {
"type": "string",
"maxLength": 255
},
"custom4": {
"type": "string",
"maxLength": 255
},
"custom5": {
"type": "string",
"maxLength": 255
},
"custom6": {
"type": "string",
"maxLength": 255
},
"custom7": {
"type": "string",
"maxLength": 255
},
"custom8": {
"type": "string",
"maxLength": 255
},
"custom9": {
"type": "string",
"maxLength": 255
},
"custom10": {
"type": "string",
"maxLength": 255
},
"custom11": {
"type": "string",
"maxLength": 255
},
"custom12": {
"type": "string",
"maxLength": 255
},
"custom13": {
"type": "string",
"maxLength": 255
},
"custom14": {
"type": "string",
"maxLength": 255
},
"custom15": {
"type": "string",
"maxLength": 255
}
},
"required": [
"username"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴axislms_update_user(user_id, first_name, last_name, email, middle_init, ...)
WRITE: change profile fields of an existing user (only the fields you send are changed; an empty value is not sent, so a field cannot be cleared here). This edits personal data and can change the user's role or manager. PUT /users/{user_id}/.
Input Schema
{
"type": "object",
"properties": {
"user_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"first_name": {
"type": "string",
"maxLength": 100
},
"last_name": {
"type": "string",
"maxLength": 100
},
"email": {
"type": "string",
"maxLength": 80
},
"middle_init": {
"type": "string",
"maxLength": 1
},
"date_start": {
"description": "Account start date, yyyy-mm-dd.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"date_expire": {
"description": "Account expiry date, yyyy-mm-dd.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"company": {
"type": "string",
"maxLength": 255
},
"address": {
"type": "string",
"maxLength": 255
},
"city": {
"type": "string",
"maxLength": 100
},
"state": {
"type": "string",
"maxLength": 4
},
"zip": {
"type": "string",
"maxLength": 10
},
"phone": {
"type": "string",
"maxLength": 20
},
"localization": {
"description": "A language pack name installed in the LMS.",
"type": "string",
"maxLength": 100
},
"role": {
"type": "string",
"enum": [
"learner",
"manager"
]
},
"manager_id": {
"description": "User id of a manager.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"custom1": {
"type": "string",
"maxLength": 255
},
"custom2": {
"type": "string",
"maxLength": 255
},
"custom3": {
"type": "string",
"maxLength": 255
},
"custom4": {
"type": "string",
"maxLength": 255
},
"custom5": {
"type": "string",
"maxLength": 255
},
"custom6": {
"type": "string",
"maxLength": 255
},
"custom7": {
"type": "string",
"maxLength": 255
},
"custom8": {
"type": "string",
"maxLength": 255
},
"custom9": {
"type": "string",
"maxLength": 255
},
"custom10": {
"type": "string",
"maxLength": 255
},
"custom11": {
"type": "string",
"maxLength": 255
},
"custom12": {
"type": "string",
"maxLength": 255
},
"custom13": {
"type": "string",
"maxLength": 255
},
"custom14": {
"type": "string",
"maxLength": 255
},
"custom15": {
"type": "string",
"maxLength": 255
}
},
"required": [
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡axislms_create_usergroup(name)
WRITE: create a usergroup. The name must be 4-99 characters (letters, numbers, spaces and @ . _ -). Returns its id. POST /usergroups/{name}/.
Input Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Za-z0-9@._ -]{4,99}$"
}
},
"required": [
"name"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡axislms_add_usergroup_member(usergroup_id, user_id)
WRITE: add a user to a usergroup (they must not already be a member). Groups can drive course or path assignments. POST /usergroups/members/{usergroup_id}/{user_id}/.
Input Schema
{
"type": "object",
"properties": {
"usergroup_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"user_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"usergroup_id",
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴axislms_remove_usergroup_member(usergroup_id, user_id)
WRITE: remove a user from a usergroup they are a member of. DELETE /usergroups/members/{usergroup_id}/{user_id}/.
Input Schema
{
"type": "object",
"properties": {
"usergroup_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"user_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"usergroup_id",
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Community
Evidence