Our API Documentation

It's easy to connect to our job board using our api.

As long as you or you client is signed up to our board, jobs can be remotely sent via an xml push

<job> <command>add</command> <aggr>Aggregator</aggr> <username>bobsmith</username> <password>p455w0rd</password> <contact_name>Bob Smith</contact_name> <days_to_advertise>7</days_to_advertise> <application_email>bob.12345.123@smith.aplitrak.com</application_email> <application_url>http://www.url.com/ad.asp?adid=12345123</application_url> <job_reference>abc123</job_reference> <job_title>Test Engineer</job_title> <job_type>Contract</job_type> <job_startdate>15-12-17</job_startdate> <job_description>This is the detailed description</job_description> <job_location>London</job_location> <job_industry >Marketing</job_industry> <job_specialisation>All</job_specialisation> <salary_currency>gbp</salary_currency> <salary_from>25000</salary_from> <salary_to>30000</salary_to> <salary_per>annum</salary_per> <salary_benefits>0</salary_benefits> <salary_bonus>0</salary_bonus> </job>
Example xml data
Required nodes: command, aggr, username, password, contact_name, days_to_advertise, application_email, job_reference, job_title, job_type, job_startdate, job_description, job_location, job_industry, job_specialisation

Command

The command tag informs our api what function to carry out.

<command>add</command> <command>delete</command>
When using delete the job id must be specified
<job_id>1234</job_id>

Authentication

For the connection to be made between the site and the feed, the login details must be correct. The user must have signed up to our job board.

Aggregator

Who are you? We need to know who is send the jobs to our site.

<aggr>Company name</aggr>

Contact

Contact details for the job, we just need the name to be sent, as all other company details are kept on the company details page.

<contact_name>Bob Smith</contact_name>

From the moment the job is posted, how many days do you want the job to be displayed.

<days_to_advertise>7</days_to_advertise> <days_to_advertise>14</days_to_advertise> <days_to_advertise>30</days_to_advertise> <days_to_advertise>60</days_to_advertise>

Options:

  • 7
  • 14
  • 30
  • 60

Applications

Application settings show how the job applications are handled.

<application_email>bob.12345.123@smith.aplitrak.com</application_email> <application_url>http://www.url.com/ad.asp?adid=12345123</application_url>
If the 'application_url' node is set the user will be forwarded to this address when applying. If not an email application will be sent to 'application_email'.

Reference

<job_reference>abc123</job_reference>

Title

<job_title>Test Engineer</job_title>

Type/Duration

<job_type>Contract</job_type>

Start Date

<job_startdate>15-12-17</job_startdate>

Description

<job_description>This is the detailed description</job_description>

Locations

<job_location>London</job_location>
Available options:

All
Channel Islands
East Anglia
East Midlands
International
London
North East
North West
Northern Ireland
Republic of Ireland
Scotland
South East (excl London)
South West
Surrey
Wales
West Midlands
  	

Industry

<job_industry >Marketing</job_industry>
Available options:

Administrative Services
Advertising
All
Art, Design & Graphical
Civil Engineering 
Defense
Education and Culture
Energy and Utilities
Engineering 
Financial Services
General Manufacturing
Government
Health, Medical & Related services
Hotels, Catering & Related services
Insurance
IT & Communications
Law
Local Authorities
Logistics
Management & Recruitment
Manufacturing & Crafts
Marketing
Media and Entertainment
Petrochemicals
Pharmaceuticals 
Practice
Public Sector
Retail
Sales
Science & Research
Social Care & Related services
Sports & Fitness
Transportation
  	

Specialisation

<job_specialisation>All</job_specialisation>
Available options:

Accounts Administration
Actuarial
All
Audit 
Bookkeeping
Business Advisory
Cashier
Charities
Consultant
Corporate Finance
Credit Control
Financial Controller
Forensic Accountant
Fund Accountant
Group Accountant
Insolvency
Ledger Clerk
Management Accountant
Newly Qualified
Payroll
Risk
Sarbanes Oxley
Taxation
Trainee - Graduate
Trainee - Non-graduate
Treasury
VAT Accountant
  	

Currency

Currently not used
<salary_currency>gbp</salary_currency>

Salary

<salary_from>25000</salary_from> <salary_to>30000</salary_to> <salary_per>annum</salary_per>

Benefits

<salary_benefits>0</salary_benefits>

Bonus

<salary_bonus>0</salary_bonus>

Testing

<username>sandbox</username> <password>letmein</password>
We have a test area set-up for testing the api. Username: sandbox password: letmein