AVavionte
Placements

Get Placement Performance Definitions

Returns a list of dropdown values for the Placement Performance definitions.

get/v1/placement/performances

Request

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

Query parameters

includeArchivedboolean

An indication of whether archived placement performances are included in the response. When true, both active and archived performances are returned. When false (default), only active performances 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 performances.

idinteger

The identifier for the Placement Performance.

namestring

The name of the Placement Performance.

performanceTypestring

The type of the Placement Performance. Possible values are: Positive, Negative, Neutral.

isArchivedboolean

An indication of whether the Placement Performance is archived. Archived performances are only returned when includeArchived is true.

Example response

[
  {
    "id": 12345,
    "name": "Excellent",
    "performanceType": "Positive"
  }
]

Changes

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