APIs
Start typing to search…

Update a VMS Job

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

Updates an existing VMS job record in the system.

Path Params
string
required

The identifier for the VMS job in BOLD.

Body Params
int32

The identifier for the VMS job.

int32

The identifier for the job.

int32
required

The identifier for the company.

int32
required

The identifier for the company branch or department.

int32

The identifier for the job'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.

int32
required

The identifier for the company contact.

int32
required

The identifier for the worksite address.

int32
required

The number of positions.

date-time
required

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

int32

The estimated amount of time the job requires.

number

The target bill rate for the job.

number

The target pay rate for the job.

enum

Information about the overtime type.

enum

Information about the expense type.

int32

The identifier for the overtime rule.

boolean

A flag indicating custom overtime rates can be used.

number

The overtime bill rate value.

number

The overtime pay rate value.

number

The double time bill rate value.

number

The double time pay rate value.

number

The maximum bill rate value.

number

The minimum bill rate value.

number

The maximum pay rate value.

number

The minimum pay rate value.

enum

The rate types for the job.

enum

The week duration options for the job.

number

The mark-up percentage value.

int32

The identifier for the billing manager for the job.

string
length ≤ 255

The name of the billing contact.

string
length ≤ 255

Billing address, line 1.

string
length ≤ 100

Billing address, line 2.

string
length ≤ 50

Billing city.

string
length ≤ 50

Billing state.

string
length ≤ 50

Billing ZIP/postal code.

string
length ≤ 50

Billing phone.

string
length ≤ 100

Billing email.

enum

The billing term.

number

The placement fee for the job.

float

The placement percentage for the job.

string
required
length between 1 and 500

The title for the job.

int32

The identifier for the position category.

string
length ≤ 50

The company's cost center.

string
length ≤ 50

The company's division.

string
length ≤ 50

The company's department.

int32

The identifier for the worker's comp code.

int32

The identifier for the job order status.

int32

The identifier for the job type.

int32

The identifier for the sales representative user for the job.

int32

The identifier for the user who created a job.

string

The job description.

string

The HTML for job description.

string

The job notes.

customJobDetails
array of objects

A list of custom job details.

customJobDetails
string
required
length between 1 and 50

The partner or vendor that originated the request.

boolean

An indication of whether the job record is archived or not.

string

The start time for the job in 24-hour local time. This property is specific to Avionté 24/7.

string

The end time for the job in 24-hour local time. This property is specific to Avionté 24/7.

shiftScheduleDays

Object that contains Shift Days. This property is specific to Avionté 24/7.

boolean

An indication of whether a job offer has been made or not. This property is specific to Avionté 24/7.

boolean

An indication of whether the job is of a Pick List type or not. This property is specific to Avionté 24/7.

boolean

An indication of whether the job should be posted on the mobile application. This property is specific to Avionté 24/7.

enum

The pay period available for a job.

string

The notes related to the VMS job.

int32

The maximum number of submittals.

string
length ≤ 50

The string identifier for the vendor job.

string

VMS provider name.

string
length ≤ 50

VMS type.

string
length ≤ 255

The name for the job order status.

jobRequirements
array of objects

The requirements of the job.

jobRequirements
string
length ≤ 255

The job type.

jobSkills
array of objects

The job skills of the job.

jobSkills
jobSkillResponse

The job skills response of the job.

jobOwners
array of int32s

The user IDs of the job owners.

jobOwners
boolean

An indication of whether workers can pick up one job. This property is specific to Avionté 24/7.

Headers
uuid

Unique request identifier (GUID) 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 about 2 months ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago