Talent & Contingent Workforce · Advertising
Advertisements
One job order on one board. Six boards is six of these, with six references, six expiry dates and six costs — which is why a flag per board would answer nothing.
/api/ats/board-postingsPublished as /api/v1/board-postingsOverview
| Package | Talent & Contingent Workforce |
|---|---|
| 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 Talent & Contingent Workforce › Advertisements 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. |
| Table | ats.board_postings · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The 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/ats/board-postingsList advertisements
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"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",
"posting_no": "POS-000001",
"job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"board_code": "BOA-000001",
"title": "Example",
"title_local": "Example",
"description": "text",
"description_local": "text",
"summary": "text",
"summary_local": "text",
"location_text": "text",
"work_arrangement": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/ats/board-postings?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/ats/board-postings/{id}Read one advertisement
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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",
"posting_no": "POS-000001",
"job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"board_code": "BOA-000001",
"title": "Example",
"title_local": "Example",
"description": "text",
"description_local": "text",
"summary": "text",
"summary_local": "text",
"location_text": "text",
"work_arrangement": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/ats/board-postings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/board-postingsCreate a advertisement
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
job_order_id | uuid | Yes | Job order |
connection_id | uuid | No | Contract |
board_code | text | Yes | Board |
title | text | Yes | Advertised as — Not the job order title. A job order says "bill rate max 95" and an advertisement must not. |
title_local | text | No | Local title |
description | text | No | Advertisement |
description_local | text | No | Local advertisement |
summary | text | No | Summary |
summary_local | text | No | Summary local |
location_text | text | No | Location |
work_arrangement | text | No | Work arrangement |
employment_type | text | No | Employment type |
is_confidential | boolean | No | Do not name the client — Most contract advertising is blind, and naming a client by accident is a commercial problem. |
display_company | text | No | Show as |
salary_from | numeric | No | From |
salary_to | numeric | No | To |
salary_period | text | No | Salary period |
currency | text | No | Currency |
show_salary | boolean | No | Show the rate |
skills | _text | No | Skills |
category | text | No | Category |
apply_url | text | No | Apply at |
apply_email | text | No | Apply by mail |
notes | text | No | Notes |
Sample body
{
"job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"board_code": "BOA-000001",
"title": "Example",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title_local": "Example",
"description": "text",
"description_local": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"posting_no": "POS-000001",
"job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"board_code": "BOA-000001",
"title": "Example",
"title_local": "Example",
"description": "text",
"description_local": "text",
"summary": "text",
"summary_local": "text",
"location_text": "text",
"work_arrangement": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/ats/board-postings" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"job_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","board_code":"BOA-000001","title":"Example","connection_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","title_local":"Example","description":"text","description_local":"text"}'PUT/api/ats/board-postings/{id}Change a advertisement
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
job_order_id | uuid | Yes | Job order |
connection_id | uuid | No | Contract |
board_code | text | Yes | Board |
title | text | Yes | Advertised as — Not the job order title. A job order says "bill rate max 95" and an advertisement must not. |
title_local | text | No | Local title |
description | text | No | Advertisement |
description_local | text | No | Local advertisement |
summary | text | No | Summary |
summary_local | text | No | Summary local |
location_text | text | No | Location |
work_arrangement | text | No | Work arrangement |
employment_type | text | No | Employment type |
is_confidential | boolean | No | Do not name the client — Most contract advertising is blind, and naming a client by accident is a commercial problem. |
display_company | text | No | Show as |
salary_from | numeric | No | From |
salary_to | numeric | No | To |
salary_period | text | No | Salary period |
currency | text | No | Currency |
show_salary | boolean | No | Show the rate |
skills | _text | No | Skills |
category | text | No | Category |
apply_url | text | No | Apply at |
apply_email | text | No | Apply by mail |
notes | text | No | Notes |
Sample body
{
"job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"board_code": "BOA-000001"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"posting_no": "POS-000001",
"job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"board_code": "BOA-000001",
"title": "Example",
"title_local": "Example",
"description": "text",
"description_local": "text",
"summary": "text",
"summary_local": "text",
"location_text": "text",
"work_arrangement": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/ats/board-postings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"job_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","board_code":"BOA-000001"}'DELETE/api/ats/board-postings/{id}Delete a advertisement
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/ats/board-postings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/board-postings/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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/ats/board-postings/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 advertisement, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
posting_no | text | read only | Posting no |
job_order_id | uuid | read, write | Job order |
connection_id | uuid | read, write | Contract |
board_code | text | read, write | Board |
title | text | read, write | Advertised as — Not the job order title. A job order says "bill rate max 95" and an advertisement must not. |
title_local | text | read, write | Local title |
description | text | read, write | Advertisement |
description_local | text | read, write | Local advertisement |
summary | text | read, write | Summary |
summary_local | text | read, write | Summary local |
location_text | text | read, write | Location |
work_arrangement | text | read, write | Work arrangement |
employment_type | text | read, write | Employment type |
is_confidential | boolean | read, write | Do not name the client — Most contract advertising is blind, and naming a client by accident is a commercial problem. |
display_company | text | read, write | Show as |
salary_from | numeric | read, write | From |
salary_to | numeric | read, write | To |
salary_period | text | read, write | Salary period |
currency | text | read, write | Currency |
show_salary | boolean | read, write | Show the rate |
skills | _text | read, write | Skills |
category | text | read, write | Category |
apply_url | text | read, write | Apply at |
apply_email | text | read, write | Apply by mail |
external_id | text | read only | External id |
external_url | text | read only | External url |
status | text | read only | Status |
posted_at | timestamp with time zone | read only | Posted at |
expires_at | timestamp with time zone | read only | Expires at |
removed_at | timestamp with time zone | read only | Removed at |
last_synced_at | timestamp with time zone | read only | Last synced at |
views | integer | read only | Views |
applications | integer | read only | Applications |
qualified | integer | read only | Qualified |
submitted | integer | read only | Submitted |
placed | integer | read only | Placed |
cost | numeric | read only | Cost |
error_message | text | read only | Error message |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
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 Talent & Contingent Workforce › Advertisements 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.