v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Jobs

Get New Job Required Fields

Returns a list of required fields for creating a new job.

get/v1/new-job-required-fields

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 list of required fields for creating a new job.

clientAddressboolean

A flag indicating worksite address1 may be required when creating a new job.

clientCityboolean

A flag indicating worksite city may be required when creating a new job.

clientStateboolean

A flag indicating worksite state may be required when creating a new job.

clientZipboolean

A flag indicating worksite zip may be required when creating a new job.

clientEmailboolean

A flag indicating contact email may be required when creating a new job.

clientPhoneboolean

A flag indicating contact phone1 may be required when creating a new job.

endDateboolean

A flag indicating endDate may be required when creating a new job.

estimatedHoursboolean

A flag indicating estimatedHours may be required when creating a new job.

jobCityboolean

A flag indicating contact city may be required when creating a new job.

jobCountryboolean

A flag indicating contact country may be required when creating a new job.

jobStateboolean

A flag indicating contact state may be required when creating a new job.

placementFeeAmountboolean

A flag indicating placementFee may be required when creating a new job.

placementFeePercentboolean

A flag indicating placementPercentage may be required when creating a new job.

positionCategorySkillboolean

A flag indicating positionCategoryId may be required when creating a new job.

targetBillRateboolean

A flag indicating targetBillRate may be required when creating a new job.

targetPayRateboolean

A flag indicating targetPayRate may be required when creating a new job.

workersCompCodeboolean

A flag indicating workerCompCodeId may be required when creating a new job.

Example response

{
  "clientAddress": true,
  "clientCity": true,
  "clientState": true,
  "clientZip": true,
  "clientEmail": true,
  "clientPhone": true,
  "endDate": true,
  "estimatedHours": true,
  "jobCity": true,
  "jobCountry": true,
  "jobState": true,
  "placementFeeAmount": true,
  "placementFeePercent": true,
  "positionCategorySkill": true,
  "targetBillRate": true,
  "targetPayRate": true,
  "workersCompCode": true,
  "customJobDetails": [
    {
      "id": 12345,
      "jobId": 67890,
      "name": "Dress Code",
      "value": "Business Casual",
      "additionalValue": "No jeans",
      "type": "text",
      "isActive": true,
      "customJobDetailId": 54321
    }
  ]
}