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>22-10-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>22-10-17</job_startdate>

Description

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

Locations

<job_location>London</job_location>
Available options:

Avon
Bedfordshire
Berkshire
Borders
Buckinghamshire
Cambridgeshire
Central
Cheshire
Cleveland
Clwyd
Cornwall
County Antrim
County Armagh
County Down
County Fermanagh
County Londonderry
County Tyrone
Cumbria
Derbyshire
Devon
Dorset
Dumfries and Galloway
Durham
Dyfed
East Sussex
Essex
Fife
Gloucestershire
Grampian
Greater Manchester
Gwent
Gwynedd County
Hampshire
Herefordshire
Hertfordshire
Highlands and Islands
Humberside
Isle of Wight
Kent
Lancashire
Leicestershire
Lincolnshire
Lothian
Merseyside
Mid Glamorgan
Norfolk
North Yorkshire
Northamptonshire
Northumberland
Nottinghamshire
Oxfordshire
Powys
Rutland
Shropshire
Somerset
South Glamorgan
South Yorkshire
Staffordshire
Strathclyde
Suffolk
Surrey
Tayside
Tyne and Wear
Warwickshire
West Glamorgan
West Midlands
West Sussex
West Yorkshire
Wiltshire
Worcestershire
  	

Industry

<job_industry >Marketing</job_industry>
Available options:

Administrative Support and Secretarial
Advertising
Aerospace
Art, Design & Graphical
Automotive
Business Development 
Civil Engineering 
Construction
Consultancy
Defence
Education & Culture
Engineering
Financial Services
Food and Drink
General Manufacturing
Government
Health, Medical & Related services
Hotels, Catering & Tourism
Insurance
IT and Communications
Land, Sea, Environment & Veterinary
Law
Local Authorities
Logistics
Management and Recruitment
Manufacturing & Crafts
Marketing
Media, Audiovisual & Entertainment
Mining and Extraction
Oil and Gas
Petrochemical
Pharmaceuticals
Professional Service companies
Public Sector
Retail
Sales
Science & Scientific Research
Social, Care & Related services
Sports, Fitness & Beauty
Transportation & Logistics
Utilities
  	

Specialisation

<job_specialisation>All</job_specialisation>
Available options:

Category management
Contracts Management
Housing and Distribution
Indirect Purchasing
Logistics Management
Operational purchasing
Operations Management
Purchasing performance and benchmarking
Purchasing policy and procedures
Strategic Purchasing
Supply chain management
  	

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