Axis REST API

Reports Endpoints

GET /reports/certifications/

Description

Generates certifications report for program-id.

 

Endpoints

GET /reports/certifications/{program-id}/
GET /reports/certifications/{program-id}/page{#}/
GET /reports/certifications/{program-id}/count/

 

Parameters 

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

certification_number : (string)

method_earned : (string)

min_issue_date : (date8)

max_issue_date : (date8)

min_renewed_date : (date8)

max_renewed_date : (date8)

min_expire_date : (date8)

max_expire_date : (date8)

 

Notes

  • No parameters are required - all paramters are optional
  • If no parameters are sent, all certifications in program-id will be returned
  • These endpoints return paginated results, therefore having /page{#}/ and /count/ endpoint variants to read and control the results delivered
  • certificaton_number and method_earned parameters use 'contains' comparisons (method_earned contains instead of equals).

 

Returns program_id, program_name, user_id, username, certification_number, method_earned, issue_date, renewed_date, expire_date for specified program-id.

[
    {
        "program_id": "35",
        "program_name": "Floor Supervisor",
        "user_id": "1",
        "username": "adm56671n3",
        "certification_number": "SCCEU0911233155",
        "method_earned": "course:1084",
        "issue_date": "20230911",
        "renewed_date": "20230911",
        "expire_date": "20240910"
    },
    {
        "program_id": "35",
        "program_name": "Floor Supervisor",
        "user_id": "2",
        "username": "gregory0429",
        "certification_number": "SCCEU1118223275",
        "method_earned": "course:1084",
        "issue_date": "20221118",
        "renewed_date": "20221118",
        "expire_date": "20231118"
    }
]
 
 
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/