AVavionte
Export

Create Placement Export Request

Submits an asynchronous request to export placement data for the given tenant. The request is queued for processing, and the response returns a correlation identifier used to track the request through the export pipeline.<br><br>When the export completes, the <a href="https://developer.avionte.com/docs/partnerexportreadyevent">PartnerExportReadyEvent</a> webhook is delivered to the partner. The resulting batch can then be retrieved using the <a href="https://developer.avionte.com/reference/getpartnerexportbatch">Get Partner Export Batch Paged Data</a> endpoint.

post/v1/export-request/placements/active

Request

  • Base URL
    https://api.avionte.com/front-office
  • URL
    https://api.avionte.com/front-office/v1/export-request/placements/active
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

yearsLookBackinteger

The number of years back that will be searched, relative to the request date. For example, a value of 3 entered on 3/10/2026 will return placements active between 3/10/2023 and 3/10/2026. The maximum value is 5. The default value is 0; when 0, only currently active placements 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

The placement export request was accepted for processing.

correlationIdstring

Unique identifier for the accepted placement export request. Use this value to correlate the request with the asynchronous export pipeline and the resulting export batch retrieved through the Get Partner Export Batch Paged Data endpoint.

Example response

{
  "correlationId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Changes

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