HRMS · Services and actions
Recruiting
The recruiting service of HRMS: 4 operation(s).
Type REST4 operationsBase path
/api/hrms/recruitingOverview
| 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 › Recruiting 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
4 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/recruiting/eeo-applicant-flowEeo applicant flow
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/recruiting/eeo-applicant-flow" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/recruiting/boardBoard
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/recruiting/board" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/recruiting/onboardingOnboarding
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/recruiting/onboarding" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/recruiting/offboardingOffboarding
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/recruiting/offboarding" \
-H "Authorization: Bearer $TOKEN"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 › Recruiting 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.