v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

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

Path parameters

placementIdstring required

The identifier for the placement whose schedules are being retrieved.

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

The placement ID and associated placement schedule shifts.

placementScheduleGuidstring uuid

The unique identifier for the placement schedule, formatted as a GUID.

startDatestring date

Start date of the placement schedule in YYYY-MM-DD format, without a timestamp.

endDatestring date

End date of the placement schedule in YYYY-MM-DD format, without a timestamp.

isActiveboolean

An indication of whether the schedule is active. Only one schedule can be active for a placement.