AVavionte
Jobs

Get Job Order Template

Returns the full configuration for the specified Job Order Template.

get/v1/job/templates/{templateId}

Request

  • Base URL
    https://api.avionte.com/front-office
  • URL
    https://api.avionte.com/front-office/v1/job/templates/{templateId}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

templateIdinteger required

The identifier for the Job Order Template to retrieve.

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.

Response

The requested Job Order Template.

idinteger
namestring
companyIdinteger
companyNamestring
officeIdinteger
isDefaultboolean
archivedboolean
lockedboolean
createdOnUtcstring date-time
updatedOnUtcstring date-time
jobBoardLocationboolean
jobBoardStateboolean
jobBoardCountryboolean
jobBoardTitlestring
requireBillRateboolean
billRatenumber double
requirePayRateboolean
payRatenumber double
requirePlacementFeeboolean
placementFeenumber double
requirePlacementPercentboolean
placementPercentnumber double
requireMarkupPercentboolean
markupPercentnumber double
requireMinMaxBillboolean
minBillnumber double
maxBillnumber double
requireMinMaxPayboolean
minPaynumber double
maxPaynumber double
requireJobDescriptionFileboolean
requireSkillsboolean
requireCustomBillIdboolean
requireClientAddress1boolean
requireClientCityboolean
requireClientStateboolean
requireClientZipboolean
requireClientPhoneboolean
requireManagerEmailboolean
requireBillingTermsboolean
requireWorkersCompCodeboolean
requireEndDateboolean
requireEndReasonboolean
requireEstimatedHoursboolean
requireWorksiteAddressboolean
requireCustomDetailsboolean
requireCompanyRequirementsboolean
requireInterviewQuestionnaireboolean
interviewQuestionnaireIdinteger nullable
tierIdinteger
jobTypeIdinteger
rateTypeIdinteger
positionCategoryIdinteger nullable
positionSkillIdinteger nullable
defaultWorkersCompCodeIdinteger nullable
overtimeTypeinteger
overtimeRuleIdinteger
overtimeCustomRatesboolean
overtimePaynumber double
overtimeBillnumber double
doubletimePaynumber double
doubletimeBillnumber double
overtimeMarkupnumber double
doubletimeMarkupnumber double
applyMarkupboolean
applyOvertimeMarkupboolean
applyDoubletimeMarkupboolean
markupLockedboolean
enforceCompanyFilledJobRequirementsGroupboolean
enforceCustomFilledRequirementGroupboolean
customFilledRequirementGroupIdinteger

Example response

{
  "customJobDetails": [
    {
      "name": "Dress Code",
      "value": "10",
      "additionalValue": "100",
      "type": "text",
      "isRequired": true,
      "customJobDetailId": 54321
    }
  ]
}

Changes

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