1. Home
  2. Docs
  3. Developer Documentations
  4. Publisher XML Feed Specifications

Publisher XML Feed Specifications

An XML file is used to describe currently available jobs openings. All valid tags are described below. Tag names must be given exactly as below, in English, while text in tag values can be given in any language, using UTF-8 encoding.

Note: All string tags must have their values wrapped as CDATA, for example <![CDATA[Some Data]]>.

source tag

The <source> tag is the topmost tag in a feed. The following sub-tags are valid within it.
NameDescription
publisher-name

Type: string
Required

Max characters: 1000

The name of your organization. Plain text only.

Example: awesome-ats
publisher-url

Type: string
Required

Max characters: 1000

The URL of your organization's website, including leading http:// or https://.

Example: http://www.awesome-ats.com

last-build-date

Type: string

Optional

Max characters: 100

The date this feed was last updated, in RFC3339 format with a space separator.

Example: 2020-11-06 18:47:08 +0000

job

Type: wrapper

Required

Each instance of this tag defines a job. See the full specification below.

Each feed XML file cannot contain more than 100,000 jobs. To publish more than 100,000 jobs, we recommend to split them into multiple feeds and maintain 1:1 mapping between the jobs and job_feed_id.

job tag

The <job> tag represents a single job opening. The following sub-tags are valid within it.
NameDescription

job-type

Type: string

Optional & Recommended

Supported values: FULL_TIMEPART_TIMECONTRACTINTERNSHIPVOLUNTEER, SEASONAL

FULL_TIME is the default.

remote-type

Type: string

Optional

Indicates that this job can be performed remotely.

Supported values:

  • FULLY_REMOTE: A job that can be performed entirely remotely from any location, and doesn't require any regular travel to an office or job site.

  • WFH_FLEXIBLE: A job for which employees have the flexibility to sometimes work remotely, but are still expected to report to a local office most of the time.

  • TEMPORARILY_REMOTE: A job that’s normally performed in a single location, such as an office or at a job site, but which is temporarily remote during the coronavirus (COVID-19) pandemic.

organization-data-policy-url

Type: string

Optional & Recommended

Max characters: 1000

URL containing the data policy of the hiring company.

Example: https://www.hiringcompany.com/policy.html

city

Type: string

Optional

Max characters: 1000

City where the job is located.

Example: Menlo Park

postal-code

Type: string

Optional

Max characters: 1000

Postal code for where the job is located. In the United States this is the zip code.

Example: 94025

salary

Type: number

Optional

Max characters: 1000

Salary of this job, without currency or separators. Digits and decimal point only.

Example: 150000

If the job is unpaid, then leave out all salary related tags.

target-location

Type: string

Optional

Max-characters: 1000

Location of the target audience.

country-wide

Type: string

Optional

Target audience across the country.

Supported values: True, False

region-wide

Type: string

Optional

Target audience across the state.

Will be ignored if region is not set.

Supported values: True, False

employer

Type: string

Optional

Max characters: 1000

The name of the employer. Ignore if its the same as company.

Example: Acme Inc.

industry

Type: string

Optional

Max characters: 1000

The industry associated with the job position.

Example: Finance

category

Type: string

Optional

Max characters: 1000

  • A category describing the job, preferably using a term from a taxonomy such as O*NET-SOC.


Example: Computer Hardware Engineers

valid-through

Type: string

Optional

Max characters: 1000

The date after when the job is not valid, in RFC3339 format with a space separator.

Example: 2020-11-06 18:47:08 +0000

experience

Type: string

Optional

Max characters: 1000

Description of skills or experience needed for the position or Occupation.

Example: 5+ years

mobile-friendly

Type: string

Optional

Max characters: 1000

If the website has mobile friendly user interface.

Supported values: True, False

media-url

Type: string

Optional

Max characters: 1000

URL to image/video that showcase your company.

Example: https://youtu.be/7WH8uxXXe9o

title

Type: string

Required

Max characters: 1000

The job title. Plain text only.

Example: Cashier

date

Type: string

Required

Max characters: 1000

The date the job was posted, in RFC3339 format with a space separator.

Example: 2020-11-06 18:47:08 +0000

identifier

Type: string

Required

Max characters: 1000

A unique ID of your choosing that distinguishes this job from all other jobs you provide Jobadx. Must be unique across all jobs and across all your XML feeds.

Example: unique11111

description

Type: string

Required

Max characters: 50000

The job description. Plain text only. HTML tags will be stripped. Newline characters are respected to start new lines. See sample XML below.

Example:

Greet customers with energy!

Arrange shopping carts, help customers with information.

organization

Type: string

Required

Max characters: 1000

The name of the hiring company. Note this is usually not your company, but the company that is offering the job. Plain text only.

Example: Hiring Company, Ltd.

url

Type: string

Required

Max characters: 1000

Url of the job.

Example: https://www.example.com/the-job

region

Type: string

Required if region-wide is used

Max characters: 1000

Region where the job is located. In the United States this is the USPS two letter state abbreviation.

Example: CA

country

Type: string

Required

Max characters: 1000

2-letter ISO 3166-1 code for country where the job is located. A full English spelling of the country name may also work, but is not recommended.

Example: US

salary-currency

Type: string

Required if salary is used

The 3 letter ISO 4217 code of the currency that the salary tags are denominated in.

Example: USD

salary-type

Type: string

Required if salary is used

The type of salary offered for this job.

Supported values: HOURLYDAILYWEEKLYBIWEEKLYMONTHLYANNUALLYONE-TIME


<?xml version="1.0" encoding="utf-8"?>
<source>

<!-- Publisher and feed info -->
<publisher-name>Your ATS</publisher-name>
<publisher-url>http://www.yourdomain.com</publisher-url>
<last-build-date>2020-11-06 18:47:08 +0000</last-build-date>

<!-- Job tag. Repeat for each job opening. -->
<job>
  <!-- Basic job info -->
  <title><![CDATA[Mechanical Engineer]]></title>
  <date><![CDATA[2020-11-06 18:47:08 +0000]]></date>
  <identifier><![CDATA[unique11111]]></identifier>
  <description><![CDATA[Mechanical Engineer. Help develop a perpetual motion machine. Great perks.]]></description>
  <job-type><![CDATA[FULL_TIME]]></job-type><!-- optional. -->
  <organization><![CDATA[Hiring Company, Ltd.]]></organization>
  <organization-data-policy-url>
    <![CDATA[https://www.hiringcompany.com/policy.html]]>
  </organization-data-policy-url><!-- optional. -->
  <experience><![CDATA[5+ years]]></experience><!-- optional. -->
  <valid-through><![CDATA[2020-11-09 18:47:08 +0000]]></valid-through><!-- optional. -->
  <mobile-friendly><![CDATA[True]]></mobile-friendly><!-- optional. -->
  <category><![CDATA[Mechanical Engineers]]></category><!-- optional. -->
  <industry><![CDATA[Manufacturing]]></industry><!-- optional. -->
  <employer><![CDATA[Employer, Inc.]]></employer><!-- optional. -->
  <remote-type><![CDATA[WFH_FLEXIBLE]]></remote-type><!-- optional. -->
  
  <!-- Location -->
  <city><![CDATA[New York]]></city><!-- optional. -->
  <country><![CDATA[US]]></country>
  <region><![CDATA[NY]]></region><!-- optional. -->
  <postal-code><![CDATA[94025]]></postal-code><!-- optional. -->
  <target-location><![CDATA[Buffalo, NY, US]]></target-location><!-- optional. -->
  <country-wide><![CDATA[True]]></country-wide><!-- optional. -->
  <region-wide><![CDATA[False]]></region-wide><!-- optional. -->

  <!-- Salary -->
  <salary><![CDATA[100000]]></salary><!-- optional. -->
  <salary-currency><![CDATA[USD]]></salary-currency><!-- optional. -->
  <salary-type><![CDATA[ANNUALLY]]></salary-type><!-- optional. -->
  <media-url><![CDATA[https://youtu.be/7WH8uxXXe9o]]></media-url><!-- optional. -->
</job>

<!-- ...add more <job> tags for additional jobs -->

</source>