Axis REST API

Reports Endpoints

GET /reports/courses/

Description

Generates course report for course-id.

 

Endpoints

GET /reports/courses/{course-id}/
GET /reports/courses/{course-id}/page{#}/
GET /reports/courses/{course-id}/count/

 

Parameters 

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

status : (string)

min_progress : (int) 0 - 100 

max_progress : (int) 0 - 100

min_score : (int) 0 - 100

max_score : (int) 0 - 100

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 users in course-id will be returned
  • Users in report are limited to those who are currently enrolled.
  • These endpoints return paginated results, therefore having /page{#}/ and /count/ endpoint variants to read and control the results delivered
  • valid values for status are passed, failed, complete or incomplete

 

Returns user_id, username, status, progress, score, start_date, completion_date for specified course-id.

[
    {
        "user_id": "2",
        "username": "gregory0429",
        "status": "incomplete",
        "progress": "0",
        "score": "0",
        "start_date": "20210429",
        "completion_date": ""
    },
    {
        "user_id": "3",
        "username": "adn9776",
        "status": "incomplete",
        "progress": "5",
        "score": "0",
        "start_date": "20200612",
        "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/