This a typical configuration you can use as a guide when creating your job posting API.
Content
Typical Advert Fields
Supported Formats of Advert Data
Default Values
Typical Advert Fields
This is an example of advert fields we can send to your site. if you require custom information please specify in your technical specification.
| Node | Example Value | Notes |
|---|---|---|
| command/action | Add | One of either 'Add', 'Delete' or 'Update'. |
| username | bobsmith | Issued by you/your developer, where your interface requires a username for authentication. |
| password | p455w0rd | Issued by you/your developer, where your interface requires a password for authentication. |
| contact_name | Bob Smith | Recruiter name as stored within a client's AdCourier (Brodabean) account. |
| contact_email | bob@smith.com | Recruiter email address as stored within a client's AdCourier (Brodabean) account. |
| contact_telephone | 020 7987 6900 | Recruiter phone number as stored within a client's AdCourier (Brodabean) account. |
| contact_url | www.smith-recruitment-agency.com | Client's own website URL as stored within a client's AdCourier (Brodabean) account. |
| days_to_advertise | 7 | An Integer. A client can choose the number of days the advert should be active for on your career site/job board. Default options are: 7,14,21,28 days. |
| application_email | bob.12345.123@smith.aplitrak.com | Email address used for forwarding applications to. Please read about Aplitrak - our applicant tracking system. |
| application_url | http://url.com/ad.asp?adid=12345123 | Applications via a URL is advised for job board integrations. This, normally, is not used for integrations with clients' own career sites. Please read about Aplitrak - our applicant tracking system. |
| job_reference | abc123 | Freetext. 20 char limit. Can be made unique if requested (by appending a time-stamp). |
| job_title | Test Engineer | Freetext. 63 char limit. |
| job_type | Permanent | Please see our Default Values. |
| job_duration | 6 months | Freetext, duration of the position (Normally used for Contract positions). |
| job_startdate | ASAP | Freetext, a start date of the position. |
| job_skills | vb, c++, perl, java | Freetext, specific skills/keywords relevant to the position. |
| job_description | Detailed Job Description | Freetext. 6000 char limit. This field can accept HTML if required. This must be specified in your technical specification. |
| job_location | London | For more information please see our Default Values. |
| job_industry | Marketing | For more information please see our Default Values. |
| salary_currency | gbp | For more information please see our Default Values. |
| salary_from | 25000 | A number (float) for the lower salary. |
| salary_to | 30000 | A number (float) for the upper salary. |
| salary_per | annum | For more information please see our Default Values. |
| salary_benefits | + Bonus and Pension | Freetext, additional salary information. |
| salary | £25000 - £30000 per annum + Bonus and Pension | Freetext salary information for display purposes (build as salary_from + salary_to + salary_benefits). |
Supported Formats of Advert Data
Please see examples of the supported data formats Broadbean will send to your site. Please note, that the request structure can be altered to your requirements.
The data will be sent via HTTP POST and your website will receive, validate and display the data on the careers page. How the advert is displayed on the site is your decision, our main objective is to ensure the data we send across is displayed correctly.
XML
Content-Type: text/xml
Method: POST
Posting an advert
Request
<?xml version="1.0" encoding="UTF-8"?>
<job>
<command>add</command>
<username>bobsmith</username>
<password>p455w0rd</password>
<contact_name>Bob Smith</contact_name>
<contact_email>bob@smith.com</contact_email>
<contact_telephone>020 7987 6900</contact_telephone>
<contact_url>www.smith.com</contact_url>
<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_duration>6 Months</job_duration>
<job_startdate>ASAP</job_startdate>
<job_skills>VB, C++, PERL, Java</job_skills>
<job_description>This is the detailed description</job_description>
<job_location>London</job_location>
<job_industry>Marketing</job_industry>
<salary_currency>gbp</salary_currency>
<salary_from>25000</salary_from>
<salary_to>30000</salary_to>
<salary_per>annum</salary_per>
<salary_benefits>Bonus and Pension</salary_benefits>
<salary>£25000 - £30000 per annum + Bonus and Pension</salary>
</job>
Response
<response>advert has been posted successfully</response>
<job_url>www.smith.com/jobs/12345</job_url>
Deleting an advert
Request
<?xml version="1.0" encoding="UTF-8"?>
<job>
<command>delete</command>
<username>bobsmith</username>
<password>p455w0rd</password>
<job_reference>abc123</job_reference>
</job
Response
<response>advert has been deleted successfully</response>
JSON
Content-Type: application/json
Method: POST
Posting an advert
Request
{
"command":"add",
"username":"bobsmith",
"password":"p455w0rd",
"contact_name":"Bob Smith",
"contact_email":"bob@smith.com",
"contact_telephone":"020 7987 6900",
"contact_url":"www.smith.com",
"days_to_advertise":"7",
"application_email":"bob.12345.123@smith.aplitrak.com",
"application_url":"http://www.url.com/ad.asp?adid=12345123",
"job_reference":"abc123",
"job_title":"Test Engineer",
"job_type":"Contract",
"job_duration":"6 Months",
"job_startdate":"ASAP",
"job_skills":"VB, C++, PERL, Java",
"job_description":"This is the detailed description",
"job_location":"London",
"job_industry":"Marketing",
"salary_currency":"GBP",
"salary_from":"25000",
"salary_to":"30000",
"salary_per":"annum",
"salary_benefits":"Bonus and Pension",
"salary":"£25000 - £30000 per annum + Bonus and Pension"
}
Response
{
"status":"posted",
"job_url":"www.smith.com/jobs/12345"
}
Deleting an advert
Request
{
"command":"delete",
"username":"bobsmith",
"password":"p455w0rd",
"job_reference":"abc123"
}
Response
{
"status":"deleted"
}
URL Encoded
Content-Type: application/x-www-form-urlencoded
Method: GET
Posting an advert
Request
command=add&username=bobsmith&password=p455w0rd&contact_name=Bob Smith&
contact_email=bob@smith.com&contact_telephone=020 7987 6900&
contact_url=www.smith.com&days_to_advertise=7&
application_email=bob.12345.123@smith.aplitrak.com&
application_url=http://www.url.com/ad.asp?adid=12345123&
job_reference=abc123&job_title=Test Engineer&job_type=Contract&
job_duration=6 Months&job_startdate=ASAP&
job_skills=VB, C++, PERL, Java&
job_description=This is the detailed description&job_location=London&
job_industry=Marketing&salary_currency=gbp&salary_from=25000&
salary_to=30000&salary_per=annum&salary_benefits=Bonus and Pension&
salary=£25000 - £30000 per annum + Bonus and Pension
Response
Advert has been posted successfully
www.smith.com/jobs/12345
Deleting an advert
Request
command=delete&username=bobsmith&password=p455w0rd&contact_name=Bob Smith&
contact_email=bob@smith.com&contact_telephone=020 7987 6900&
contact_url=www.smith.com&days_to_advertise=7&
application_email=bob.12345.123@smith.aplitrak.com&
application_url=http://www.url.com/ad.asp?adid=12345123&job_reference=abc123&
job_title=Test Engineer&job_type=Contract&job_duration=6 Months&
job_startdate=ASAP&job_skills=VB, C++, PERL, Java&
job_description=This is the detailed description&job_location=London&
job_industry=Marketing&salary_currency=gbp&salary_from=25000&
salary_to=30000&salary_per=annum&salary_benefits=Bonus and Pension&
salary=£25000 - £30000 per annum + Bonus and Pension
Response
Advert has been deleted successfully
Default Values
Prior to starting an integration, we request from you lists/drop-down values you have on your site. However, you can set your site to use our default values provided below.
| Job Types | ||||||
| Permanent Contract Temporary |
||||||
| Locations | ||||||
| We have 90,000+ global locations which can be selected from an autocomplete list on our job posting form. When an advert is submitted to your site a location can be sent as a text, for example, Europe, England, London, City of London, or as a specific ID. As long as you provide us with a list of locations and corresponding IDs we can map them against our locations. |
||||||
| Industries | ||||||
| When an advert is submitted to your site an industry can be sent as a text, for example, Engineering, or as a specific ID. As long as you provide us with a list of industries and corresponding IDs we can map them against ours. Or alternatively, we can set it as a custom drop-down in case your industries differ too much from ours. | ||||||
| Accountancy Admin and Secretarial Advertising and PR Aerospace Agriculture Fishing and Forestry Arts Automotive Banking Building and Construction Call Centre and Customer Service Community Services Consultancy Defence and Military Design and Creative Education and Training Electronics Engineering FMCG Fashion Financial Services Graduates and Trainees Health and Safety Hospitality and Catering Human Resources and Personnel IT Insurance Legal |
Leisure and Sport Logistics Distribution and Supply Chain Manufacturing and Production Marketing Media Medical and Nursing Mining New Media and Internet Not for Profit and Charities Oil and Gas Pharmaceuticals Property and Housing Public Sector and Government Purchasing and Procurement Real Estate and Property Recruitment Consultancy Retail Sales Science and Research Senior Appointments Social Care Telecommunications Trade and Services Transport and Rail Travel and Tourism Utilities |
|||||
| Salary Periods | ||||||
| annum month week day hour |
||||||
| Salary Currencies | ||||||
| GBP EUR USD AUD NZD CAD TWD JPY CHF AED PLN HUF MXN SEK |
NOK DKK SGD HKD CNY MYR ANG ARS AZN BDT BGN BHD BND BOB |
BRL BWP CLP COP CRC CZK DOP DZD EEK EGP FJD HNL HRK IDR |
ILS INR JMD JOD KES KRW KWD KYD KZT LAK LBP LKR LTL LVL |
MAD MDL MKD MOP MUR MVR NAD NGN NIO NPR OMR PEN PGK PHP |
PKR PYG QAR RON RSD RUB SAR SCR SKK SLL SVC THB TND TRY |
TTD TZS UAH UGX UYU UZS VEF VND XAF XBT XOF YER ZAR ZMK |