Skip to main content

Config section

The configuration block of the XML is provided as part of the <config> element. The table below lists all the available tags that can go under this element.

This block only applies to the Add, Repost, and Clone methods.

Fields description

XML elementType restrictionsRequired?Notes
utf8_enableStringYesAlways set to yes! Non-UTF-8 posting has been deprecated.
Indicates that you are sending data in the UTF-8 encoding.
lockboardsString (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
NoControls whether and when the PCP is generated, and if the user is able to select and unselect Portals on the page.
partneridStringNoOnly applicable to PCP.
Your Partner ID allows you to identify your styling to control the look and feel of the pages.
show_durationsString (enum)

Default: yes

Accepted values:
yes - display the posting duration selection field for each Portal
no - don't display the posting duration selection field (must be preselected in the Posts section)
NoOnly applicable to PCP.
See the <durations> element of the Portal's detailed information response for more info.
redirecturlString (url)NoOnly applicable to PCP.
The URL to which the user is redirected after completing the posting.
returnurlString (url)NoOnly 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
continueStringNoOnly 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.

Format

  <config>
<utf8_enable>yes</utf8_enable>
<lockboards>["yes"|"no"|"yes_pcp"]</lockboards>
<partnerid>[string]</partnerid>
<show_durations>["yes"|"no"]</show_durations>
<redirecturl>[string:url]</redirecturl>
<returnurl>[string:url]</returnurl>
<continue>[string]</continue>
</config>

Example

  <config>
<utf8_enable>yes</utf8_enable>
<lockboards>no</lockboards>
<partnerid>idibu</partnerid>
<show_durations>yes</show_durations>
<redirecturl><![CDATA[https://www.idibu.com]]></redirecturl>
<returnurl><![CDATA[https://ws.idibu.com/clients/upp/index.php?hash=1a2b3c4d5e6f7g8h9i0j&senderId=12345&partnerId=idibu]]></returnurl>
<continue>9z8y7x6w5u4t3s2r1p0o</continue>
</config>