Axis REST API

Learningpaths Endpoints

GET /learningpaths/{learningpath-id}/users/

Description

Lists information about active enrolled users (or a specific enrolled user) in a learningpath.

 

Endpoints

GET /learningpaths/{learningpath-id}/users/
GET /learningpaths/{learningpath-id}/users/{user-id}/

 

Returns user_id, username, status, start_time, completion_time, completion_method, path_version, current_branch, current_step, user_progress for each active user (or for user-id) in learningpath-id

[
    {
        "user_id": "1",
        "username": "admin",
        "status": "Main Branch | Step 1",
        "start_time": "20230921 13:30:09",
        "completion_time": "",
        "completion_method": "",
        "path_version": "3",
        "current_branch": "Main Branch",
        "current_step": "Welcome to the Learning Path",
        "user_progress": "0"
    },
    {
        "user_id": "25",
        "username": "ahhkw1588353769",
        "status": "Main Branch | Step 2",
        "start_time": "20230223 14:14:15",
        "completion_time": "",
        "completion_method": "",
        "path_version": "3",
        "current_branch": "Main Branch",
        "current_step": "Checklist",
        "user_progress": "16"
    }
]

 

Introduction and Overview
How to Use this Documentation
Authentication and API Keys
Authorization using Bearer Tokens
Data Types
Return Data Format
Pagination
API Logging
Consuming the Axis REST API
cURL Example Code
PHP Example Code
Certifications Endpoints
Certifications Endpoints Overview
GET /certifications/list/
GET /certifications/{program-id}/
GET /certifications/{program-id}/users/
GET /certifications/certificates/
GET /certifications/ceus/
POST /certifications/certificates/online/
POST /certifications/certificates/offline/
PUT /certifications/certificates/extend/
Courses Endpoints
Courses Endpoints Overview
GET /courses/count/
GET /courses/list/
GET /courses/{course-id}/
GET /courses/{course-id}/users/
POST /courses/enrollments/
DELETE /courses/enrollments/
ILT Endpoints
ILT Endpoints Overview
GET /ilt/list/
GET /ilt/users/{user-id}/sessions/
GET /ilt/{program-id}/
GET /ilt/{program-id}/sessions/
GET /ilt/{program-id}/meetings/
GET /ilt/{program-id}/completions/
POST /ilt/enrollments/
PUT /ilt/attendance/
DELETE /ilt/enrollments/
Learningpaths Endpoints
Learningpaths Endpoints Overview
GET /learningpaths/list/
GET /learningpaths/{learningpath-id}/users/
POST /learningpaths/enrollments/
DELETE /learningpaths/enrollments/
Organizations Endpoints
Organizations Endpoints Overview
GET /organizations/list/
GET /organizations/branches/
GET /organizations/users/{organization-id}/
GET /organizations/users/{organization-id}/{branch-id}/
POST /organizations/users/
DELETE /organizations/users/
Reports Endpoints
Reports Endpoints Overview
GET /reports/certifications/
GET /reports/courses/
GET /reports/learningpaths/
GET /reports/ilt/
GET /reports/users/{user-id}/courses/
GET /reports/users/all/courses/
GET /reports/users/filtered/courses/
GET /reports/users/{user-id}/archived/
GET /reports/users/all/archived/
GET /reports/users/filtered/archived/
GET/reports/users/{user-id}/certifications/
GET /reports/users/all/certifications/
GET /reports/users/filtered/certifications/
GET /reports/users/{user-id}/ilt/
GET /reports/users/all/ilt/
GET /reports/users/filtered/ilt/
GET /reports/users/{user-id}/learningpaths/
GET /reports/users/all/learningpaths/
GET /reports/users/filtered/learningpaths/
Users Endpoints
Users Endpoints Overview
GET /users/list/
GET /users/{user-id}/
GET /users/all/
GET /users/filtered/
POST /users/
PUT /users/
Usergroups Endpoints
Usergroups Endpoints Overview
GET /usergroups/list/
GET /usergroups/{usergroup-id}/
GET /usergroups/{usergroup-id}/members/
POST /usergroups/
POST /usergroups/members/
DELETE /usergroups/
DELETE /usergroups/members/