TRANXACT.AI Help

Talent & Contingent Workforce · Advertising

Board Alerts

A saved search that watches the boards for work this desk could fill. The other direction from an advertisement: not "advertise my job" but "tell me when somebody advertises a job I could fill".

Type REST6 operationsBase path /api/ats/board-alertsPublished as /api/v1/board-alerts

Download specification (OpenAPI 3.1) Screen: Board Alerts

Overview

PackageTalent & Contingent Workforce
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 Talent & Contingent Workforce › Board Alerts 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.
Tableats.board_alerts · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; 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/ats/board-alertsList board alerts

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",
      "code": "COD-000001",
      "name": "Example",
      "name_local": "Example",
      "description": "text",
      "owner_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "board_codes": [],
      "keywords": [],
      "exclude_keywords": [],
      "skills": [],
      "locations": [],
      "countries": [],
      "remote_only": true
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/ats/board-alerts?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ats/board-alerts/{id}Read one board alert

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",
  "code": "COD-000001",
  "name": "Example",
  "name_local": "Example",
  "description": "text",
  "owner_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "board_codes": [],
  "keywords": [],
  "exclude_keywords": [],
  "skills": [],
  "locations": [],
  "countries": [],
  "remote_only": true
}

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

Sample request

curl "https://demo.tranxact.ai/api/ats/board-alerts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/board-alertsCreate a board alert

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
name_localtextNoLocal name
descriptiontextNoWhat it watches for
owner_user_iduuidNoOwner
board_codes_textNoBoard codes
keywords_textNoWords to look for
exclude_keywords_textNoWords to ignore
skills_textNoSkills
locations_textNoPlaces
countries_textNoCountries
remote_onlybooleanNoRemote only
employment_types_textNoEmployment types
min_ratenumericNoRate from
max_ratenumericNoRate to
rate_unittextNoRate unit
currencytextNoCurrency
posted_within_hoursintegerNoPosted within (hours)
check_every_minutesintegerNoLook every (minutes)
min_match_scoreintegerNoOnly notify above — A desk that gets forty hits an hour stops reading them within a week, which is why this is on the alert rather than in somebody head.
notify_kindtextNoTell me by
Allowed: console email both none
max_per_dayintegerNoMost a day
statustextNoStatus
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "name_local": "Example",
  "description": "text",
  "owner_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "board_codes": []
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "name_local": "Example",
  "description": "text",
  "owner_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "board_codes": [],
  "keywords": [],
  "exclude_keywords": [],
  "skills": [],
  "locations": [],
  "countries": [],
  "remote_only": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ats/board-alerts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","name_local":"Example","description":"text","owner_user_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","board_codes":[]}'
PUT/api/ats/board-alerts/{id}Change a board alert

Path parameters

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

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
name_localtextNoLocal name
descriptiontextNoWhat it watches for
owner_user_iduuidNoOwner
board_codes_textNoBoard codes
keywords_textNoWords to look for
exclude_keywords_textNoWords to ignore
skills_textNoSkills
locations_textNoPlaces
countries_textNoCountries
remote_onlybooleanNoRemote only
employment_types_textNoEmployment types
min_ratenumericNoRate from
max_ratenumericNoRate to
rate_unittextNoRate unit
currencytextNoCurrency
posted_within_hoursintegerNoPosted within (hours)
check_every_minutesintegerNoLook every (minutes)
min_match_scoreintegerNoOnly notify above — A desk that gets forty hits an hour stops reading them within a week, which is why this is on the alert rather than in somebody head.
notify_kindtextNoTell me by
Allowed: console email both none
max_per_dayintegerNoMost a day
statustextNoStatus
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "name_local": "Example",
  "description": "text",
  "owner_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "board_codes": [],
  "keywords": [],
  "exclude_keywords": [],
  "skills": [],
  "locations": [],
  "countries": [],
  "remote_only": true
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/ats/board-alerts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/ats/board-alerts/{id}Delete a board alert

Path parameters

NameTypeDescription
idstring (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-alerts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/board-alerts/{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/ats/board-alerts/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 board alert, 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
codetextread, writeCode
nametextread, writeName
name_localtextread, writeLocal name
descriptiontextread, writeWhat it watches for
owner_user_iduuidread, writeOwner
board_codes_textread, writeBoard codes
keywords_textread, writeWords to look for
exclude_keywords_textread, writeWords to ignore
skills_textread, writeSkills
locations_textread, writePlaces
countries_textread, writeCountries
remote_onlybooleanread, writeRemote only
employment_types_textread, writeEmployment types
min_ratenumericread, writeRate from
max_ratenumericread, writeRate to
rate_unittextread, writeRate unit
currencytextread, writeCurrency
posted_within_hoursintegerread, writePosted within (hours)
check_every_minutesintegerread, writeLook every (minutes)
min_match_scoreintegerread, writeOnly notify above — A desk that gets forty hits an hour stops reading them within a week, which is why this is on the alert rather than in somebody head.
notify_kindtextread, writeTell me by
Allowed: console email both none
notify_user_ids_uuidread onlyNotify user ids
max_per_dayintegerread, writeMost a day
statustextread, writeStatus
last_run_attimestamp with time zoneread onlyLast run at
next_due_attimestamp with time zoneread onlyNext due at
runsbigintread onlyRuns
hitsbigintread onlyHits
last_errortextread onlyLast error
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

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 Talent & Contingent Workforce › Board Alerts 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.