AVavionte
Placements

Cancel Placement Schedule Shifts

Cancel one or more Placement Schedule Shifts by identifiers.

post/v1/placement/{placementId}/extension/{extensionId}/cancel-schedule-shifts

Request

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

Path parameters

placementIdstring required

The unique identifier for the placement.

extensionIdstring required

The unique identifier for the extension.

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.

Request body

IntegerSchema[] required

Response

A list of responses for each canceled schedule shift.

scheduleShiftIdinteger
isSuccessboolean
errorMessagestring
errorCodestring

Changes

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