Axis REST API

Courses Endpoints

POST /courses/enrollments/

Description

Enrolls user user-id into online course course-id.

 

Endpoints

POST /courses/enrollments/{course-id}/{user-id}/

 

Parameters

start : (date8) [optional]

end : (date8) [optional]

 

Notes

  • user-id must be active
  • course-id must be active
  • if user is already enrolled, either start or end must be sent to change enrollment
  • end must be after start - either the submitted date or the date already on file for the user

 

Returns status, course_id, user_id and also start_date if start was sent, and end_date if end was sent.
 
{
    "status": "200",
    "course_id": "1",
    "user_id": "2",
    "start_date": "20240315",
    "end_date": "20240601"
}
 
 
 
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/