Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Placements

Get Placement End Reason Definitions

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

get/v1/placement/end-reasons

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

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'.

Example response

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