Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qualio Training API

The Training API from Qualio — 2 operation(s) for training.

Qualio Training API is one of 11 APIs that Qualio publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Training. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 2 paths, and defines 16 schemas. It is described by OpenAPI 3.1.0, at version 0.1.

Requests are made against a single base URL, https://api.qualio.com.

4 operations 2 paths 16 schemas 1 GET2 OPTIONS1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1
Base URL
https://api.qualio.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Qualio Training API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (api_key). By default, every request must be authenticated.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 GET, 2 OPTIONS, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Training 4
GET
/v1/training/user-training/query
Query training assignments
queryUserTraining 7 params → 200400403429
OPTIONS
/v1/training/user-training/query
Queries user training assignments (also called training records, or the training matrix) across your Qualio instance. When a document that requires training becomes effective, Qualio assigns the rele…
queryUserTrainingOptions 7 params → 200
PUT
/v1/training/document/{documentId}/remind
Send training reminders
sendTrainingReminders 1 param body → 200400403404429
OPTIONS
/v1/training/document/{documentId}/remind
Send training reminders for a document to one or more users. Recipients can be specified by numeric user ID or email address. If no recipients are provided, reminders are sent to all users with incom…
sendTrainingRemindersOptions 1 param → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are genericBadRequest400ParametersResponse (2 properties), genericBadRequestResponse (2 properties), trainingReminderResponse (2 properties), trainingQueryResp (2 properties). Each schema is shown below with its type and property counts.

includeRemoved
boolean
When true, includes training assignments that were completed and subsequently unassigned. Defaults to false.
generic404
A generic response when a resource can't be found
trainingQueryResp
object
A series of training assignments for your instance, based on the query
2 properties 2 required
trainingReminderResponse
object
Training reminder response
2 properties 2 required
trainingReminderRequest
object
Training reminder request body
1 property
genericForbiddenResponse
object
1 property 1 required
documentIds
array
A unique identifier for a document version, for which you want to query for user training sessions
limitParam
number
The maximum number of results to return. This is typically used with offset to paginate results.
includeInactiveUsers
boolean
When true, includes training records for users who are no longer active in the company. Defaults to false.
groupIds
array
A unique identifier for a user group, for whom you want to retrieve training sessions
genericBadRequest400ParametersResponse
object
2 properties 2 required
throttledResponse
object
1 property 1 required
trainingDocumentId
integer
A unique identifier for a document
trainingStatus
string
Filter by training status. 'overdue' returns assignments past their due date that are not yet complete. 'due' returns incomplete assignments that are not yet o…
genericBadRequestResponse
object
2 properties 2 required
offsetParam
number
A start point for the batch to be returned. For example, a value of 5 will start at the 6th element in the overall population

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qualio-training-api-openapi.yml Raw ↑

Other APIs Qualio publishes across the network.

Qualio Audit Trail API
Qualio Change Management API
Qualio Compliance Intelligence API
Qualio Design Controls API
Qualio Documents API
Qualio Events API
Qualio Resource Library API
Qualio Suppliers API
Qualio Tags API
Qualio User Management API