TRANXACT.AI Help

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.

Type REST15 operationsBase path /api/hrms/lms-connectorsPublished as /api/v1/lms-connectors

Download specification (OpenAPI 3.1) Screen: LMS Connectors

Overview

PackageHRMS
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablehr.lms_connectors · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
platformtextNoPlatform — Where the field mapping starts: Aspire’s export headings, or our own field names.
Allowed: aspire generic
transporttextNoTransport
Allowed: file rest
base_urltextNoBase URL — For HTTP: https://… (or sandbox: to try it with sample data).
auth_typetextNoAuthentication
Allowed: none basic bearer api_key
usernametextNoUser name (basic)
api_key_headertextNoAPI key header — For example X-API-Key.
endpointsjsonbNoEndpoints — {"courses":"/courses","enrollments":"/enrollments","completions":"/completions"}
field_mapjsonbNoField 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_matchtextNoEmployees matched by
Allowed: employee_no email
enroll_on_completionbooleanNoA completion enrols if not enrolled
create_coursesbooleanNoCreate courses not seen before
delimitertextNoFile delimiter
import_entities_textNoScheduled import — ["courses","completions"]
export_entities_textNoScheduled export — ["enrollments"]
scheduletextNoSchedule
Allowed: manual hourly daily weekly
is_activebooleanNoActive

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
platformtextNoPlatform — Where the field mapping starts: Aspire’s export headings, or our own field names.
Allowed: aspire generic
transporttextNoTransport
Allowed: file rest
base_urltextNoBase URL — For HTTP: https://… (or sandbox: to try it with sample data).
auth_typetextNoAuthentication
Allowed: none basic bearer api_key
usernametextNoUser name (basic)
api_key_headertextNoAPI key header — For example X-API-Key.
endpointsjsonbNoEndpoints — {"courses":"/courses","enrollments":"/enrollments","completions":"/completions"}
field_mapjsonbNoField 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_matchtextNoEmployees matched by
Allowed: employee_no email
enroll_on_completionbooleanNoA completion enrols if not enrolled
create_coursesbooleanNoCreate courses not seen before
delimitertextNoFile delimiter
import_entities_textNoScheduled import — ["courses","completions"]
export_entities_textNoScheduled export — ["enrollments"]
scheduletextNoSchedule
Allowed: manual hourly daily weekly
is_activebooleanNoActive

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

secret

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 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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.
entitystring (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, records

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/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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

entity

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/import" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"entity":"value"}'
GET/api/hrms/lms-connectors/{id}/export/{entity}Export

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.
entitystring (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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.
entitystring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
codetextread, writeCode
nametextread, writeName
platformtextread, writePlatform — Where the field mapping starts: Aspire’s export headings, or our own field names.
Allowed: aspire generic
transporttextread, writeTransport
Allowed: file rest
base_urltextread, writeBase URL — For HTTP: https://… (or sandbox: to try it with sample data).
auth_typetextread, writeAuthentication
Allowed: none basic bearer api_key
usernametextread, writeUser name (basic)
api_key_headertextread, writeAPI key header — For example X-API-Key.
secret_cipherbytearead onlySecret cipher
secret_last4textread onlySecret last4
endpointsjsonbread, writeEndpoints — {"courses":"/courses","enrollments":"/enrollments","completions":"/completions"}
field_mapjsonbread, writeField 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_matchtextread, writeEmployees matched by
Allowed: employee_no email
enroll_on_completionbooleanread, writeA completion enrols if not enrolled
create_coursesbooleanread, writeCreate courses not seen before
delimitertextread, writeFile delimiter
import_entities_textread, writeScheduled import — ["courses","completions"]
export_entities_textread, writeScheduled export — ["enrollments"]
scheduletextread, writeSchedule
Allowed: manual hourly daily weekly
is_activebooleanread, writeActive
last_run_attimestamp with time zoneread onlyLast run at
last_statustextread onlyLast status
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold HRMS › LMS Connectors for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.