Employee Self Service · My Team
Team Learning
The training of the people who report to you: what is due, what is overdue, who is compliant. Enrol one of them on a course.
Type REST3 operationsBase path
/api/ess/team-learningOverview
| Package | Employee Self Service |
|---|---|
| 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 Employee Self Service › Team Learning 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. |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
3 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/ess/team-learningRead team learning
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/ess/team-learning" \
-H "Authorization: Bearer $TOKEN"GET/api/ess/team-learning/coursesCourses
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/ess/team-learning/courses" \
-H "Authorization: Bearer $TOKEN"POST/api/ess/team-learning/enrolEnrol
Request body
The keys this action reads (* = required; "one of" lists the only values):
employee_id, course_id, due_dateResponse
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/ess/team-learning/enrol" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employee_id":"value","course_id":"value","due_date":"value"}'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 Employee Self Service › Team Learning 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.