TRANXACT.AI Help

HRMS · Recruiting & Onboarding

Candidate Ranking

Everybody who applied for a vacancy, in the order the interview panels put them. Candidates on the same score share a rank. Selecting anyone ranked below a candidate still in the running is allowed — with the reason kept on the record.

Type REST7 operationsBase path /api/hrms/panel-rankingsPublished as /api/v1/panel-rankings

Download specification (OpenAPI 3.1) Screen: Candidate Ranking

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 › Candidate Ranking 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.panel_ranking · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

7 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/hrms/panel-rankingsList candidate ranking

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",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "requisition_no": "REQ-000001",
      "role": "text",
      "openings": 10,
      "application_no": "APP-000001",
      "status": "draft",
      "applied_on": "2026-10-30",
      "candidate_no": "CAN-000001",
      "candidate_name": "Example",
      "stage": "text",
      "panel_score": "1250.00",
      "rank_no": 10
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/hrms/panel-rankings?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/panel-rankings/{id}Read one panel rankings

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requisition_no": "REQ-000001",
  "role": "text",
  "openings": 10,
  "application_no": "APP-000001",
  "status": "draft",
  "applied_on": "2026-10-30",
  "candidate_no": "CAN-000001",
  "candidate_name": "Example",
  "stage": "text",
  "panel_score": "1250.00",
  "rank_no": 10
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/hrms/panel-rankings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/panel-rankings/{id}/selectSelect

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

reason

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/panel-rankings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/select" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'
POST/api/hrms/panel-rankingsPost candidate ranking

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/panel-rankings" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/panel-rankings/{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/panel-rankings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/hrms/panel-rankings/{id}Put candidate ranking

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 PUT "https://demo.tranxact.ai/api/hrms/panel-rankings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/hrms/panel-rankings/{id}Delete candidate ranking

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 DELETE "https://demo.tranxact.ai/api/hrms/panel-rankings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a panel rankings, 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
org_unit_iduuidread onlyOrg unit id
requisition_iduuidread onlyRequisition id
requisition_notextread onlyRequisition no
roletextread onlyRole
openingsintegerread onlyOpenings
application_notextread onlyApplication no
statustextread onlyStatus
applied_ondateread onlyApplied on
candidate_notextread onlyCandidate no
candidate_nametextread onlyCandidate name
stagetextread onlyStage
panel_scorenumericread onlyPanel score
rank_nointegerread onlyRank no
interviews_scoredintegerread onlyInterviews scored
latest_outcometextread onlyLatest outcome
outlier_marksintegerread onlyOutlier marks
is_selectedbooleanread onlyIs selected
selected_out_of_rankbooleanread onlySelected out of rank
selection_reasontextread onlySelection reason
selected_attimestamp with time zoneread onlySelected at
selected_by_nametextread onlySelected by name
display_nametextread onlyDisplay name

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 › Candidate Ranking 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.