Update a Placement

put

https://api.avionte.com/front-office/v1/placement/{placementId}

Updates information about the specified placement.

Path Params

placementId

string

required

The identifier for the placement that should be updated.

Body Params

int32

The identifier for the placement.

talentId

int32

required

1 to 2147483647

The identifier for the talent.

jobId

int32

required

1 to 2147483647

The identifier for the job.

extensionId

int32

The optional identifier for the placement extension.

startDate

date-time

required

length ≥ 1

The placement start date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

endDate

date-time

The placement end date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

payRates

required

Information about the pay rates.

billRates

required

Information about the bill rates.

commissionUsers

array of objects

A list of commission recipients and their details.

commissionUsers

frontOfficeId

int32

The identifier for the placement's home office/branch. It occupies the following position in the Front Office hierarchy: Division → Region → Office/Branch. Refer to the Get Branches endpoint to retrieve the ID.

payBasis

string

length ≤ 255

The pay basis for the placement. Valid values are Commission, Day, Hourly, Hybrid/Other, Piece Pay, Salary, Shift, and Weekly.

hiredDate

date-time

The date the talent was hired. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

placementAdditionalRates

array of objects

A list of additional rates and their details.

placementAdditionalRates

endReasonId

int32

The identifier for the end reason.

endReason

string

length ≤ 500

The reason for ending the placement.

recruiterUserId

int32

The identifier for the recruiter user.

recruiterUser

string

length ≤ 255

The email of the recruiter user.

enteredByUserId

int32

required

1 to 2147483647

The identifier for the user who created the placement.

createdDate

date-time

required

length ≥ 1

The date when the placement was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

hasNoEndDate

boolean

An indication of whether the placement has an end date or not.

originalStartDate

date-time

The optional original start date of the placement. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

finalEndDate

date-time

The optional final end date of the placement. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

origin

string

required

length between 1 and 50

The origin of the placement.

timeApproverIds

array of int32s

List of identifiers for Time Approver users.

timeApproverIds

placementScheduleShiftDtos

array of objects

The list of placement schedules shifts.

placementScheduleShiftDtos

Headers

RequestId

uuid

Unique request identifier (GUID) used to correlate request data with log entries and events.

FrontOfficeTenantId

integer

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenant

string

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Responses

401

Unauthorized

403

Access Denied

405

Unsupported method

406

Unsupported format(s) indicated by Accept header

415

Unsupported format(s) indicated by the Content-Type header

429

Too many requests

500

An unexpected error occurred

502

Service Unavailable

504

Gateway Timeout

200The updated placement details.

400Bad Request

404Not found