AVavionte
Placements

Get Placement End Reason Definitions

Returns a list of dropdown values for the Placement End Reason definitions.

get/v1/placement/end-reasons

Request

  • Base URL
    https://api.avionte.com/front-office
  • URL
    https://api.avionte.com/front-office/v1/placement/end-reasons
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

includeArchivedboolean

An indication of whether archived placement end reasons are included in the response. When true, both active and archived end reasons are returned. When false (default), only active end reasons are returned.

Headers

RequestIdstring uuid

Unique request identifier in UUID format used to correlate request data to log entries and events.

Example:63680b86-c7e0-4a36-ae4a-d0d481089aff

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

A list of placement end reasons.

idinteger

The identifier for the Placement End Reason.

namestring

The name of the Placement End Reason.

endReasonTypestring

The type of the Placement End Reason. Possible values are: 'Positive', 'Negative', 'Unknown'.

keepPositionFilledboolean

An indication of whether ending a placement with this reason keeps the job's position filled.

createTimesheetboolean

An indication of whether ending a placement with this reason allows a timesheet to be created.

isArchivedboolean

An indication of whether the Placement End Reason is archived. Archived end reasons are only returned when includeArchived is true.

Example response

[
  {
    "id": 12345,
    "name": "Contract Completed",
    "endReasonType": "Positive"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.