How to Use this Documentation
The Axis API is organized around REST, and is a RESTful API.
Each endpoint requires a specific HTTP method - either POST, GET, PUT, or DELETE.
When reading this documentation, you will see each endpoint starting with one of these. Here are a few examples:
GET /certifications/certificates/{user-id}/
POST /courses/enrollments/{course-id}/{user-id}/
DELETE /learningpaths/enrollments/{lp-id}/users/{user-id}/
PUT /certifications/certificates/extend/
The HTTP method indicates the method you will need to use to send the request.
Each endpoint requires the URL of your system API as well. For example, this documented endpoint:
GET /certifications/certificates/{user-id}/
Means this:
Send a GET
request to https://www.my-system-url.com/api.php/certifications/certificates/{user-id}/
Anything inside tags like this {user-id}
means a dynamic value is required. For example:
GET /certifications/certificates/{user-id}/
Would actually be something like this:
GET /certifications/certificates/286/