API variables

Configuration field variables

Each of these variables is to be sent in the configuration block of the XML request, which is enclosed in the config tag.

XML element	Type restrictions	Required?	Notes
utf8_enable	String	Yes	Always set to yes! Non-UTF-8 posting has been deprecated. Indicates that you are sending data in the UTF-8 encoding.
lockboards	String (enum) Default: no Accepted values: yes - will generate the PCP (and block the Portal selection) only if some required Portal data is missing no - will always generate the PCP and allow to select and deselect Portals yes_pcp - will always generate the PCP but block the Portal selection	No	Controls whether and when the PCP is generated and if the user is able to select and unselect Portals on the page.
partnerid	String	No	Only applicable to PCP. Your PartnerID allows you to identify your styling to control the look and feel of the pages.
show_durations	String (enum) Default: yes Accepted values: yes - display the posting duration selection field for each Portal no - don't display the posting duration selection field	No	Only applicable to PCP. See the <durations> element of the Portal's detailed information response for more info.
redirecturl	String (url)	No	Only applicable to PCP. The URL to which the user is redirected after completing the posting.
returnurl	String (url)	No	Only applicable to PCP. If present, the page will contain a "Back" button leading to the provided URL, allowing the user to return to the initial posting step within your system. idibu will automatically append two parameters to this URL when redirecting the user: jobID - identifies the Job continue - stores the Portals and their Extra Fields already selected in the page
continue	String	No	Only applicable to PCP. Use this to provide the continue value previously appended to the returnurl when the user went back from the page. This will allow to automatically pre-load all their previous Portal and Extra Field selections when generating a new PCP.

Core field variables

The below variables need to be provided in the job tag of the XML request.

XML element	Type restrictions	Required?	Notes
client_reference	String (alphanumeric)	Yes, if utilized	You can use your system's own identifiers instead of the idibu's Job ID. These must be unique across your entire Partner account.
title	String	Yes Minimum 5 characters	The title of the Job.
reference	String (alphanumeric)	Yes Minimum 4 characters	The reference code of the Job. Ideally, should be unique per Client account. **Cannot be changed on update and repost.
description	String	Yes Minimum 200 characters	The full main body of the Job, HTML supported. It is very imporant that you provide the text as one block of text and any character returns are encoded as <br/>. Otherwise, there is a risk that your ads won't be formatted correctly when posted to Portals.
startdate	Date Format: YYYY-MM-DD	Yes	When the candidate will start working.
duration	String	No	How long will the candidate's work arrangement last.
salarymin	Number Up to two decimals allowed	Yes	The minimum salary.
salarymax	Number Up to two decimals allowed Must be equal to or greater than salarymin	Yes -	The maximum salary.
salaryper:value	String (enum) Accepted values: annum month week day hour)	Yes	The pay cycle for the remuneration package. Must be provided as a value attribute of the <salaryper> element.
salaryextras	String	No	Extra benefits.
currency	String (enum) Accepted values obtainable via the currencies/available call	Yes	The ISO-3 currency code. Use the custom-currencies webservice to control and obtain the available ones for the given Client account.
jobtype:id	Integer (enum) Accepted values: 1 - Contract 2 - Permanent 4 - Temporary)	Yes	Employment type. Must be provided as an id attribute of the <jobtype> element.
job_time	Integer (enum) Accepted values: 1 - Part-time 2 - Full-time	Yes	Working hours.
category:id	Integer (enum) Accepted values available here	Yes	idibu's core industry code. Must be provided as an id attribute of the <category> element.
location:id	String (enum) Accepted values available here	Yes	idibu's core two-letter country code. Must be provided as an id attribute of the <location> element.
sublocation:id	Integer Accepted values obtainable via the locations/find call	Yes	idibu's core location ID. Only locations that belong under the country code specified in the location field will be accepted. Must be provided as an id attribute of the <sublocation> element.
publish	Date and time Format: YYYY-MM-DD or YYYY-MM-DD HH:mm	No	You can queue the Posts to be sent out to Portals in the future, else it will be queued for immediate posting. Please mind the timestamp must be provided in London time.
app_url	String (URL)	No	URL of an external page to which candidates will be redirected instead of using the Portal's default application functionality. This is a Dynamic Core Field.
salaryOverride	String	No	Textual description of the salary. On most Portals, this will replace the display of the full salary information while still utilising the other salary fields for search. This is a Dynamic Core Field.
startDateOverride	String	No	Textual description of when the candidate would begin working. On most Portals, this will replace the date provided in the startdate Core Field. This is a Dynamic Core Field.
sender:id	String (enum) Accepted values obtainable via the list-users call	Yes	Either a standalone <sender> element with an id attribute (recommended); or a parent element (see the Sender info section for more details).

Editable core fields

Some of the core fields (title, reference & description) are editable.

When marked as such in the request by using the edit parameter (check the examples) all the fields that are marked as 'editables' will have a corresponding text box or text area in the PCP, with the contents sent in the request, and the consultant can change this content prior to completing the post. Take into account that setting any of these fields to editable will force the PCP to always be returned.

Sender fields

Please refer to this article for more info.

Dynamic core fields

Please refer to this article for more info