APIs

Update a Placement

put
https://api.avionte.com/front-office/v1/placement/

Updates information about the specified placement.

⚠️

When making a PUT request, make sure to include the entire object in the payload for successful updates.

Path Params
string
required

The identifier for the placement that should be updated.

Body Params
int32

The identifier for the placement.

int32
required
1 to 2147483647

The identifier for the talent.

int32
required
1 to 2147483647

The identifier for the job.

int32

The optional identifier for the placement extension.

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.

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
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.

string
length ≤ 255

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

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
int32

The identifier for the end reason.

string
length ≤ 500

The reason for ending the placement.

int32

The identifier for the recruiter user.

string
length ≤ 255

The email of the recruiter user.

int32
required
1 to 2147483647

The identifier for the user who created the placement.

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.

boolean

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

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.

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.

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
uuid

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

integer

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

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

Updated 2 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago