TRANXACT.AI Help

HRMS · Recruiting & Onboarding

Interview Panels

Every seat on every interview panel: who sits, as what, what they recommended and what they gave out of 100. A panelist marks their own row with Score.

Type REST6 operationsBase path /api/hrms/interview-panelsPublished as /api/v1/interview-panels

Download specification (OpenAPI 3.1) Screen: Interview Panels

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 › Interview Panels 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.interview_panel_board · 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

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

GET/api/hrms/interview-panelsList interview panels

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",
      "interview_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "panelist_name": "Example",
      "panel_role": "text",
      "weight": "1250.00",
      "is_voting": true,
      "recommendation": "text",
      "weighted_score": "1250.00",
      "criteria_scored": 10,
      "is_complete": true,
      "deviation": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "interview_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "panelist_name": "Example",
  "panel_role": "text",
  "weight": "1250.00",
  "is_voting": true,
  "recommendation": "text",
  "weighted_score": "1250.00",
  "criteria_scored": 10,
  "is_complete": true,
  "deviation": "1250.00"
}

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

Sample request

curl "https://demo.tranxact.ai/api/hrms/interview-panels/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/interview-panelsPost interview panels

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/interview-panels" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/interview-panels/{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/interview-panels/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/interview-panels/{id}Put interview panels

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/interview-panels/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/hrms/interview-panels/{id}Delete interview panels

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/interview-panels/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a interview panels, 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
interview_iduuidread onlyInterview id
employee_iduuidread onlyEmployee id
user_iduuidread onlyUser id
panelist_nametextread onlyPanelist name
panel_roletextread onlyPanel role
weightnumericread onlyWeight
is_votingbooleanread onlyIs voting
recommendationtextread onlyRecommendation
weighted_scorenumericread onlyWeighted score
criteria_scoredintegerread onlyCriteria scored
is_completebooleanread onlyIs complete
deviationnumericread onlyDeviation
is_outlierbooleanread onlyIs outlier
submitted_attimestamp with time zoneread onlySubmitted at
strengthstextread onlyStrengths
concernstextread onlyConcerns
commentstextread onlyComments
sort_orderintegerread onlySort order
employee_notextread onlyEmployee no
round_nointegerread onlyRound no
interview_typetextread onlyInterview type
scheduled_attimestamp with time zoneread onlyScheduled at
interview_statustextread onlyInterview status
interview_outcometextread onlyInterview outcome
panel_scorenumericread onlyPanel score
criteria_countintegerread onlyCriteria count
application_iduuidread onlyApplication id
application_notextread onlyApplication no
candidate_notextread onlyCandidate no
candidate_nametextread onlyCandidate name
requisition_iduuidread onlyRequisition id
requisition_notextread onlyRequisition no
roletextread onlyRole
standingtextread onlyStanding

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 › Interview Panels 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.