Skip to content

Latest commit

 

History

History
92 lines (92 loc) · 6.65 KB

sub-and-resp.md

File metadata and controls

92 lines (92 loc) · 6.65 KB
Raw

A request is submitted using an HTTP POST to the address:

http://ws.idibu.com/clients/api/REMOTE/V3/[INSERT LOGIN HASH HERE]

The client hash is part of the the url used to post the information to, and it is mandatory that the request uses the POST method. GET request will fail with an error indicating that the payload is missing. 

The xml data should be sent in a variable called:

xml_text

and must URL encoded.

Encoding guidelines

  • Make sure you post the data as application/x-www-form-urlencoded type.
  • Please use the UTF-8 encoding and always set the appropriate configuration tag (<utf8_enable>yes</utf8_enable> sub-tag, as per the documentation).
  • Preferably, please use HTML formatting and, even if you don't support it, please always send <br/> tags instead of plain-text newlines.
    Although our system will pass whatever is provided over to the job boards, it is suggested to only use basic HTML as many websites won't accept more detailed formatting. Preferably, when sending the data, please stick to the following tags and avoid additional styling parameters:
    • br
    • p
    • strong
    • i
    • ul
    • ol
    • li
  • For any free-text fields, use CDATA.
  • You can see an XML with special characters and their correct encoding in the XML examples section.

Response Messages

All messages are sent back as XML, and for succesful postings the system outputs significant logging information.

Response Messages for Successful Postings

For success posts you will receive a message similar to this one:

<?xml version="1.0" encoding="UTF-8"?>
<IDIBU>
<JOB  ID="31002849" STATUS="ADDED">
<POSTS>
<POST STATUS='PENDING' BOARDID='54' QUEUEID='846' TYPE='ADD' PUBLISH='2009-06-12 18:00' DURATION='7' />
</POSTS>
</JOB>
</IDIBU>

Depending on the data posted, the system may inform you of warnings/problems with the posting, even if it was successful:

<?xml version="1.0" encoding="UTF-8"?>
<IDIBU>
<JOB  ID="31002847" STATUS="ADDED">
<POSTS>
<POST STATUS='PENDING' BOARDID='54' QUEUEID='844' TYPE='ADD' PUBLISH='2009-06-12 18:00' DURATION='7' />
</POSTS>
</JOB>
<LOG>
<WARNING FIELD='SCR_City' TYPE='text' BOARDID='54'>Field 'SCR_City' is missing, an empty string, or contains only whitespace.</WARNING>
</LOG>
</IDIBU>

Response Messages for Failed Postings

In event of a posting issue you will be informed of the error. You can find below several different examples:

Core Field missing

<?xml version="1.0" encoding="UTF-8"?>
<IDIBU>
<JOB  STATUS="FAILED">
<ERROR FIELD="TITLE">Value was missing</ERROR>
__posts__</JOB>
</IDIBU>

Incorrect Sender

<?xml version="1.0" encoding="UTF-8"?><IDIBU>
<JOB  STATUS="FAILED">
<ERROR FIELD="SENDPROFILE">6028 is not a valid sender for you.</ERROR>
</JOB>
</IDIBU>

Required Extra Field missing or with incorrect value

<?xml version="1.0" encoding="UTF-8"?>
<IDIBU>
<JOB STATUS="FAILED"><ERROR>There were errors in the data supplied. Please check the message log.</ERROR></JOB>
<LOG>
<ERROR FIELD='SCRlocation' TYPE='doublemultiselect' BOARDID='54'>Field 'SCRlocation' was not supplied, or was supplied with an option that is an empty string or contains only whitespace.</ERROR>
</LOG>
</IDIBU>

Response messages for delayed postings

Most often the system will respond with a Post Completion Page URL - this can be passed back via the XML, or sent to the person responsible for completing the advert via email. The url links to the page where idibu asks for the remaining data to complete the posting.

<?xml version="1.0" encoding="UTF-8" ?>
<idibu>
 <job status="delayed" id="31003254" postingid="235">
  <postcompletionurl>http://adpost.idibu.com/cBzdX.html</postcompletionurl>
 </job>
 <log>
 <errors>
  <error field='sco_sector' type='select' boardid='214'>Field 'sco_sector' is missing, an empty string, or contains only whitespace.</error>
 </errors>
 <warnings>
  <warning>The provided team id doesn't exists or is wrong(ID provided: 33000169)</warning>
  <warning field='sco_location' type='doubleSelect' boardid='214'>Field 'sco_location' was missing from the payload, but was mapped internally by the system</warning>
  <warning field='sco_featured' type='select' boardid='214'>Field 'sco_featured' is missing, an empty string, or contains only whitespace.</warning>
  <warning field='idibudts_cat' type='select' boardid='517'>Field 'idibudts_cat' was missing from the payload, but was mapped internally by the system</warning>
 </warnings>
 </log>
</idibu>

We offer a great deal of configuration in this area:

  • We can setup a private domain with full rebranding for your users to post jobs out from
  • The system can be configured to use any SMTP email account to provide seamless branding.
  • The system can send out a branded confirmation email to let users know the post was successful.
Click here to learn about quick reposting.