Building your First Job XML

Getting started with the new job posting API requires you to pull information from several different sources. We refer to these different sources as dictionary values. The table below describes the main list of mandatory and optional XML fields with links to the reference material for the other sources of data.

Mandatory and Optional Fields

Field Definition Maximum Characters Required Value Type XML Path
title The job title of the job advertisement 200 Yes String defaultDescription / title
summary A short summary of the job. The summary will be displayed on the job search results page for jobseekers. 45words Yes String defaultDescription / summary
description Detailed description of job details and responsibilities. Accepts limited set of HTML tags detailed below. 2000words Yes String defaultDescription / description
salaryDescription A short description of the salary, benefits, bonus, etc. 100 Yes String defaultDescription / salaryDescription
workPermitRequirements A list of work permits required for a job. 64 No String defaultDescription / workPermitRequirements
positionType The position type of the job (e.g. permanent, contract, etc) N/A Yes Use position type constant retrieved from GET position type API call positionType
employmentTypes Whether the job is full-time, part-time, etc. N/A Yes Use employment type constant retrieved from GET employment type API call employmentType
primarySector / sectorCode The primary sector of the job. N/A Yes Use sector constant retrieved from GET sector API call primarySector / sectorCode
primarySector / subSectorCode The primary sub sector of the job. N/A Yes Use sub-sector constant retrieved from GET sub-sector API call primarySector / subSectorCode
secondarySector / sectorCode An optional secondary sector of the job. N/A No Use sector constant retrieved from GET sector API call secondarySector / sectorCode
secondarySector / subSectorCode An optional secondary sub sector of the job. N/A No Use sub-sector constant retrieved from GET sub-sector API call secondarySector / subSectorCode
tertiarySector / sectorCode An optional third sector of the job. N/A No Use sector constant retrieved from GET sector API call tertiarySector / sectorCode
tertiarySector / subSectorCode An optional third sub sector of the job. N/A No Use sub-sector constant retrieved from GET sub-sector API call tertiarySector / subSectorCode
location/refId The ID of the location the job is in. N/A Yes Use location ID retrieved from location search API call location / refId
brand/refId Unique ID of a brand. Brands are explained in the Getting Started section N/A Yes Use brand ID retrieved from GET Brand API call brand / refId
team/refId Unique ID of a team. Teams are explained in the Getting Started section N/A Yes Use team ID retrieved from GET Team API call team / refId
jobReference Your job reference number 50 No String jobReference
applicationMethod Determines how a job seeker applies for the job and if the recruiter should be notified by email. Yes Use job application constant from GET job application types API call applicationMethod
applicationLink A URL to redirect the job seeker to another website to apply for the job. Only mandatory when applicationMethod is “EXTERNAL_APPLICATION” String applicationLink
salaryBand A range of salary bands No Use salary band retrieved from GET salary band API call salaryBand
salaryCurrency The currency of the salary No Use currency retrieved from GET currency API call salaryCurrency
contactFirstName Override recruiter first name in database with this field No String contactDetails / contactFirstName
contactLastName Override recruiter last name in database with this field No String contactDetails / contactLastName
contactEmail Override recruiter email address in database with this field No String contactDetails / contactEmail
contactPhone Override recruiter phone number in database with this field No String contactDetails / contactPhone
contactFax Override recruiter fax number in database with this field No String contactDetails / contactFax
contactCompanyName Override recruiter company name in database with this field No String contactDetails / contactCompanyName
contactAddress1 Override recruiter address 1 in database with this field No String contactDetails / contactAddress1
contactAddress2 Override recruiter address 2 in database with this field No String contactDetails / contactAddress2
contactAddress3 Override recruiter address 3 in database with this field No String contactDetails / contactAddress3
contactCity Override recruiter city in database with this field No String contactDetails / contactCity
contactRegion Override recruiter region in database with this field No String contactDetails / contactRegion
contactPostCode Override recruiter postal code in database with this field No String contactDetails / contactPostCode
contactCountry Override recruiter country in database with this field No String contactDetails / contactCountry
contactURL Override recruiter url in database with this field No String contactDetails / contactURL
displayBrandImage Should the brand image be displayed No Boolean contactDetails / displayBrandImage
jobCustomField Job Custom field 10 fields No jobCustomFields / jobCustomField
fieldName Name of the Job Custom field 100 Yes String jobCustomField / fieldName
fieldValue Value of the Job Custom field 1024 Yes String jobCustomField / fieldValue

 

The following HTML tags are supported in the job description field. Other HTML tags will be stripped out and their contents will be displayed as plain text.

HTML Tag Description
<b></b> <strong></strong> Bold
<i></i> Italic
<span style=”text-decoration:underline;”> Underline
<li></li> List
<ol></ol> Ordered List
<ul></ul> Unordered List
<br></br> Line break
<p></p> Paragraph

The XML schema for a jobfeed can be found here.

XML examples for a job can be found here.

XML examples for a jobfeed can be found here.

Our clients include