HRMS · Learning
Training Courses
Read and maintain training courses records (hr.training_courses).
/api/hrms/training-coursesPublished as /api/v1/training-coursesDownload specification (OpenAPI 3.1) Screen: Training Courses
Overview
| Package | HRMS |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold HRMS › Training Courses on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | hr.training_courses · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/training-coursesList training courses
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"delivery": "in_person",
"duration_hours": "1250.00",
"is_compliance": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text",
"xf_text_4": "text",
"xf_text_5": "text",
"xf_num_1": "1250.00",
"xf_num_2": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/training-courses?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/training-courses/{id}Read one training courses
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"delivery": "in_person",
"duration_hours": "1250.00",
"is_compliance": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text",
"xf_text_4": "text",
"xf_text_5": "text",
"xf_num_1": "1250.00",
"xf_num_2": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/training-courses/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/training-coursesCreate a training courses
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code — Letters, numbers and - _ . only, up to 30 characters (for example LDR-301). |
name | text | Yes | Name |
delivery | text | No | Delivery Allowed: in_person virtual self_paced |
duration_hours | numeric | No | Duration (hours) |
is_compliance | boolean | No | Compliance training — Marks this as compliance (mandatory) training: the Compliance column shows Yes, and it counts in Compliance Training and the mandatory-training completion figures. People are enrolled by hand: Enrol employee, or + Add in the course’s 360° view (one, several, or a whole unit) -- or by a Training Assignment Rule, which sets due dates, reminders and escalation. The box by itself enrols nobody. |
description | text | No | Description |
category | text | No | Category |
provider | text | No | Provider |
validity_months | integer | No | Valid for (months) — A completion counts this long; blank is for good. |
evaluation_required | boolean | No | Ask for an evaluation — On completion the learner is asked to evaluate it under My Learning, and reminded until they do. |
passing_score | numeric | No | Pass mark — A course with a pass mark is completed by its assessment, not by the learner. |
is_active | boolean | No | Active |
external_id | text | No | Id in the learning platform |
external_source | text | No | External source |
self_register | boolean | No | Open for self-registration — Anybody may register for its sessions from My Learning; off, only people on the course. |
Sample body
{
"code": "COD-000001",
"name": "Example",
"delivery": "in_person",
"duration_hours": "1250.00",
"is_compliance": true,
"description": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"delivery": "in_person",
"duration_hours": "1250.00",
"is_compliance": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text",
"xf_text_4": "text",
"xf_text_5": "text",
"xf_num_1": "1250.00",
"xf_num_2": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/training-courses" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","delivery":"in_person","duration_hours":"1250.00","is_compliance":true,"description":"text"}'PUT/api/hrms/training-courses/{id}Change a training courses
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code — Letters, numbers and - _ . only, up to 30 characters (for example LDR-301). |
name | text | Yes | Name |
delivery | text | No | Delivery Allowed: in_person virtual self_paced |
duration_hours | numeric | No | Duration (hours) |
is_compliance | boolean | No | Compliance training — Marks this as compliance (mandatory) training: the Compliance column shows Yes, and it counts in Compliance Training and the mandatory-training completion figures. People are enrolled by hand: Enrol employee, or + Add in the course’s 360° view (one, several, or a whole unit) -- or by a Training Assignment Rule, which sets due dates, reminders and escalation. The box by itself enrols nobody. |
description | text | No | Description |
category | text | No | Category |
provider | text | No | Provider |
validity_months | integer | No | Valid for (months) — A completion counts this long; blank is for good. |
evaluation_required | boolean | No | Ask for an evaluation — On completion the learner is asked to evaluate it under My Learning, and reminded until they do. |
passing_score | numeric | No | Pass mark — A course with a pass mark is completed by its assessment, not by the learner. |
is_active | boolean | No | Active |
external_id | text | No | Id in the learning platform |
external_source | text | No | External source |
self_register | boolean | No | Open for self-registration — Anybody may register for its sessions from My Learning; off, only people on the course. |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"delivery": "in_person",
"duration_hours": "1250.00",
"is_compliance": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text",
"xf_text_4": "text",
"xf_text_5": "text",
"xf_num_1": "1250.00",
"xf_num_2": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/training-courses/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/hrms/training-courses/{id}Delete a training courses
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/hrms/training-courses/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/training-courses/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/training-courses/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a training courses, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
code | text | read, write | Code — Letters, numbers and - _ . only, up to 30 characters (for example LDR-301). |
name | text | read, write | Name |
delivery | text | read, write | Delivery Allowed: in_person virtual self_paced |
duration_hours | numeric | read, write | Duration (hours) |
is_compliance | boolean | read, write | Compliance training — Marks this as compliance (mandatory) training: the Compliance column shows Yes, and it counts in Compliance Training and the mandatory-training completion figures. People are enrolled by hand: Enrol employee, or + Add in the course’s 360° view (one, several, or a whole unit) -- or by a Training Assignment Rule, which sets due dates, reminders and escalation. The box by itself enrols nobody. |
org_unit_id | uuid | read only | Org unit id |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
description | text | read, write | Description |
category | text | read, write | Category |
provider | text | read, write | Provider |
validity_months | integer | read, write | Valid for (months) — A completion counts this long; blank is for good. |
evaluation_required | boolean | read, write | Ask for an evaluation — On completion the learner is asked to evaluate it under My Learning, and reminded until they do. |
passing_score | numeric | read, write | Pass mark — A course with a pass mark is completed by its assessment, not by the learner. |
is_active | boolean | read, write | Active |
external_id | text | read, write | Id in the learning platform |
external_source | text | read, write | External source |
self_register | boolean | read, write | Open for self-registration — Anybody may register for its sessions from My Learning; off, only people on the course. |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold HRMS › Training Courses for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.