AVavionte
Placements

Get a List of Placement Schedules

Returns a list of placement schedules for the specified placement from the Schedule widget of the Hired Details aside. This endpoint is specific to Avionté 24/7.

get/v1/placement/{placementId}/placement-schedules

Request

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

Path parameters

placementIdstring required

The identifier for the placement whose schedules are being retrieved.

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 ID and associated placement schedule shifts.

placementIdinteger

The identifier for the placement.

Example response

{
  "placementId": 123456,
  "placementScheduleShifts": [
    {
      "id": 12345,
      "weekDay": 1,
      "duration": 480,
      "startTime": "08:00:00",
      "createdDate": "2024-12-01T14:30:00.546Z",
      "updatedDate": "2024-12-01T14:30:00.546Z",
      "status": "COMMITTED"
    }
  ]
}

Changes

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