Axis REST API

Reports Endpoints

GET /reports/learningpaths/

Description

Generates learningpath report for learningpath-id.

 

Endpoints

GET /reports/learningpaths/{learningpath-id}/
GET /reports/learningpaths/{learningpath-id}/page{#}/
GET /reports/learningpaths/{learningpath-id}/count/

 

Parameters 

user_filter : (user-search-phrase) as described here

status : (string)

type : (string)

min_start_date : (date8)

max_start_date : (date8)

min_completion_date : (date8)

max_completion_date : (date8)

 

Notes

  • No parameters are required - all paramters are optional
  • If no parameters are sent, all results in learningpath-id will be returned
  • These endpoints return paginated results, therefore having /page{#}/ and /count/ endpoint variants to read and control the results delivered
  • status valid values are complete and incomplete
  • type valid values are active and archived

 

Returns learningpath_id, learningpath_name, user_id, username, status, type, start_date, completion_date for specified learningpath-id.

[
    {
        "learningpath_id": "1",
        "learningpath_name": "First LP",
        "user_id": "5",
        "username": "bfroliad5302",
        "status": "complete",
        "type": "active",
        "start_date": "20230125",
        "completion_date": "20230125"
    },
    {
        "learningpath_id": "1",
        "learningpath_name": "First LP",
        "user_id": "25",
        "username": "ahhkw1588353769",
        "status": "incomplete",
        "type": "active",
        "start_date": "20230128",
        "completion_date": ""
    }
]
 
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/