HRMS · LMS Integration
LMS Connectors
An external learning platform -- Aspire, or any other -- exchanging courses, enrolments and completions by file (CSV, Excel, text) or over HTTP, with the field mapping and the schedule.
/api/hrms/lms-connectorsPublished as /api/v1/lms-connectorsOverview
| 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 › LMS Connectors 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.lms_connectors · 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
15 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/lms-connectorsList lms connectors
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",
"platform": "aspire",
"transport": "file",
"base_url": "https://example.com",
"auth_type": "none",
"username": "Example",
"api_key_header": "text",
"secret_cipher": "text",
"secret_last4": "text",
"endpoints": {},
"field_map": {},
"employee_match": "employee_no"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/lms-connectors?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/lms-connectors/{id}Read one lms connectors
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",
"platform": "aspire",
"transport": "file",
"base_url": "https://example.com",
"auth_type": "none",
"username": "Example",
"api_key_header": "text",
"secret_cipher": "text",
"secret_last4": "text",
"endpoints": {},
"field_map": {},
"employee_match": "employee_no"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/lms-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/lms-connectorsCreate a lms connectors
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
platform | text | No | Platform — Where the field mapping starts: Aspire’s export headings, or our own field names. Allowed: aspire generic |
transport | text | No | Transport Allowed: file rest |
base_url | text | No | Base URL — For HTTP: https://… (or sandbox: to try it with sample data). |
auth_type | text | No | Authentication Allowed: none basic bearer api_key |
username | text | No | User name (basic) |
api_key_header | text | No | API key header — For example X-API-Key. |
endpoints | jsonb | No | Endpoints — {"courses":"/courses","enrollments":"/enrollments","completions":"/completions"} |
field_map | jsonb | No | Field mapping — Per kind of record, our field: their column. For example {"completions":{"employee":"EmpID","completed_at":"Date"}}. Only what differs from the platform’s starting map. |
employee_match | text | No | Employees matched by Allowed: employee_no email |
enroll_on_completion | boolean | No | A completion enrols if not enrolled |
create_courses | boolean | No | Create courses not seen before |
delimiter | text | No | File delimiter |
import_entities | _text | No | Scheduled import — ["courses","completions"] |
export_entities | _text | No | Scheduled export — ["enrollments"] |
schedule | text | No | Schedule Allowed: manual hourly daily weekly |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example",
"platform": "aspire",
"transport": "file",
"base_url": "https://example.com",
"auth_type": "none"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"platform": "aspire",
"transport": "file",
"base_url": "https://example.com",
"auth_type": "none",
"username": "Example",
"api_key_header": "text",
"secret_cipher": "text",
"secret_last4": "text",
"endpoints": {},
"field_map": {},
"employee_match": "employee_no"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/lms-connectors" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","platform":"aspire","transport":"file","base_url":"https://example.com","auth_type":"none"}'PUT/api/hrms/lms-connectors/{id}Change a lms connectors
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 |
name | text | Yes | Name |
platform | text | No | Platform — Where the field mapping starts: Aspire’s export headings, or our own field names. Allowed: aspire generic |
transport | text | No | Transport Allowed: file rest |
base_url | text | No | Base URL — For HTTP: https://… (or sandbox: to try it with sample data). |
auth_type | text | No | Authentication Allowed: none basic bearer api_key |
username | text | No | User name (basic) |
api_key_header | text | No | API key header — For example X-API-Key. |
endpoints | jsonb | No | Endpoints — {"courses":"/courses","enrollments":"/enrollments","completions":"/completions"} |
field_map | jsonb | No | Field mapping — Per kind of record, our field: their column. For example {"completions":{"employee":"EmpID","completed_at":"Date"}}. Only what differs from the platform’s starting map. |
employee_match | text | No | Employees matched by Allowed: employee_no email |
enroll_on_completion | boolean | No | A completion enrols if not enrolled |
create_courses | boolean | No | Create courses not seen before |
delimiter | text | No | File delimiter |
import_entities | _text | No | Scheduled import — ["courses","completions"] |
export_entities | _text | No | Scheduled export — ["enrollments"] |
schedule | text | No | Schedule Allowed: manual hourly daily weekly |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"platform": "aspire",
"transport": "file",
"base_url": "https://example.com",
"auth_type": "none",
"username": "Example",
"api_key_header": "text",
"secret_cipher": "text",
"secret_last4": "text",
"endpoints": {},
"field_map": {},
"employee_match": "employee_no"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/lms-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/hrms/lms-connectors/{id}Delete a lms connectors
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/lms-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/lms-connectors/platformsPlatforms
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/lms-connectors/platforms" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/lms-connectors/{id}/mappingMapping
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/lms-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/mapping" \
-H "Authorization: Bearer $TOKEN"PUT/api/hrms/lms-connectors/{id}/secretSecret
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):
secretResponse
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 PUT "https://demo.tranxact.ai/api/hrms/lms-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/secret" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"secret":"value"}'POST/api/hrms/lms-connectors/{id}/testTest
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
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/lms-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/test" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/lms-connectors/{id}/import/{entity}Import
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
entity | string (uuid) | The record's entity, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
file, sheet, fileName, recordsResponse
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/lms-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/import/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"file":"value","sheet":"value","fileName":"value","records":"value"}'POST/api/hrms/lms-connectors/{id}/importImport
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):
entityResponse
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/lms-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/import" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"entity":"value"}'GET/api/hrms/lms-connectors/{id}/export/{entity}Export
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
entity | string (uuid) | The record's entity, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/lms-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/export/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/lms-connectors/{id}/push/{entity}Push
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
entity | string (uuid) | The record's entity, as a list returns it. |
No body is required.
Response
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/lms-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/push/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/lms-connectors/{id}/syncSync
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
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/lms-connectors/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/sync" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/lms-connectors/{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/lms-connectors/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 lms connectors, 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 |
name | text | read, write | Name |
platform | text | read, write | Platform — Where the field mapping starts: Aspire’s export headings, or our own field names. Allowed: aspire generic |
transport | text | read, write | Transport Allowed: file rest |
base_url | text | read, write | Base URL — For HTTP: https://… (or sandbox: to try it with sample data). |
auth_type | text | read, write | Authentication Allowed: none basic bearer api_key |
username | text | read, write | User name (basic) |
api_key_header | text | read, write | API key header — For example X-API-Key. |
secret_cipher | bytea | read only | Secret cipher |
secret_last4 | text | read only | Secret last4 |
endpoints | jsonb | read, write | Endpoints — {"courses":"/courses","enrollments":"/enrollments","completions":"/completions"} |
field_map | jsonb | read, write | Field mapping — Per kind of record, our field: their column. For example {"completions":{"employee":"EmpID","completed_at":"Date"}}. Only what differs from the platform’s starting map. |
employee_match | text | read, write | Employees matched by Allowed: employee_no email |
enroll_on_completion | boolean | read, write | A completion enrols if not enrolled |
create_courses | boolean | read, write | Create courses not seen before |
delimiter | text | read, write | File delimiter |
import_entities | _text | read, write | Scheduled import — ["courses","completions"] |
export_entities | _text | read, write | Scheduled export — ["enrollments"] |
schedule | text | read, write | Schedule Allowed: manual hourly daily weekly |
is_active | boolean | read, write | Active |
last_run_at | timestamp with time zone | read only | Last run at |
last_status | text | read only | Last status |
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 |
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 |
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 › LMS Connectors 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.