JobFeed Push Services

Transcription

1 JobFeed Push Services

2 Introduction This document describes the technical aspects of the Push Services supported by JobFeed. In general, two types of Push-Services are supported, both serving as a transport mechanism for XML. The first is the simpler HTTP Post interface and the second is the SOAP WS interface supported by JobFeed. 2

3 HTTP Post The HTTP Post interface, as the name already suggests, represents an interface to which StepStone customer can post their listings to via plain HTTP. A HTTP post request is to be made to URL below with the all the post parameters set accordingly. Interface URL Post Parameters Name Type Description username String (UTF-8) The username as provided by StepStone pwd String (UTF-8) The password as provided by StepStone xmlresponse Boolean Possible values: true or false Indicates if the system is to respond with an XML or plain text response xmlfile String (UTF-8) The customer XML to process. The XML format is customer dependant. XML Response <jobfeedresponse><senderid></senderid><organisationid></organisationid><reference> </reference><listingid></listingid><action></action><status></status><statuscode></st atuscode><comments/><contract><enddate></enddate><credits></credits></contract> </jobfeedresponse> Field Type Description senderid String StepStone internal company id the listing was posted against organisationid String StepStone internal user id the listing was posted under reference String Customer reference number listingid numeric StepStone internal listing id action String The type of request processed. INSERT, UPDATE, IGNORE, OFFLINE status String A status message statuscode String The status code contract/enddate Iso date time The end date of the contract, not always returned contract/credits The remaining count of credits, not always returned 3

4 SOAP The SOAP interface represents a web service hosted by StepStone to post listings to the job board. The core service represents nothing more than transport mechanism for customer XML to JobFeed. WSDL The WSDL of the SAOP interface can be publicly obtained from following URL: SOAP Parameters Name Type Description user String The username as provided by StepStone pwd String The password as provided by StepStone xml String The customer XML to process. The XML format is customer dependant. SOAP Response The response of the SOAP request is XML in the following format. <StepStoneJobFeedWS><Response><ErrorId></ErrorId><ErrorMsg></ErrorMsg><Acti on></action><listingid></listingid></response></stepstonejobfeedws> Field Type Description ErrorId Numeric Status code ErrorMsg String A status message Action String The type of request processed. INSERT, UPDATE, IGNORE, OFFLINE Listingid numeric StepStone internal listing id 4

5 Modus Operandi Regardless of the choice of the transport medium (be it HTTP or SOAP), the modus operandi for the push services remains as follows. A request is posted to the system. The system then processes the request and returns with a response. If the request was successfully processed, the workflow finishes. Otherwise, the request has to be reposted to the system with a time delay for up to a defined amount of times. If the request still fails after all repost attempts, the request is to be classified as unsuccessful and manual intervention has to take place. The most common causes for a failure are expired contracts, insufficient amount of credits or missing company mappings. 5

6 Customer XML Format The XML format to be used for the request is customer dependant. In general, StepStone supports all XML formats assuming it is applicable and is domain specific enough for interchanging job postings. The required information in the request XML is as follows: Name Required Description Action Mandatory The action requested. Is the listing to be inserted, updated or placed offline (e.g. deleted) Unique reference Mandatory The unique customer reference number of the listing number Job title Mandatory The title of the listing HTML Mandatory The HTML of the listing. Can be text fragments, if a template is to be used, or a link to a HTML representation of the listing. Job location Optional The physical job location Subsidiary/department Optional Some information towards the subsidiary or department to which this listing belongs to Mandatory for resellers! 6

7 Response Codes Code Description 100 OK 101 Missing username 102 Missing password 103 Unknown customer 104 Cannot save file 200 Successful posting 201 problem with including settings file 202 bad xml the string given its not valid xml document (here link about valid xml document) 203 first sender_id and organization_id validation fail this error occurs when sender_id or organization_id is missing or the value inside is not numeric 204 title is missing xml node jobfeed.jobdetails.jobtitle is missing 205 language is missing xml node jobfeed.jobdetails.language is missing 206 reference node missing in xml action node missing in xml invalid action or reference not founds 209 no valid contract contract expired or real start date was set for future 210 no credits found - number of credits needed for this offer is less than credits available on contract 212 db error when processing actions dealing with database to manipulate offers inside databases - bad categorization numbers 215 settings file not found for this sender_id for this country jobfeeed settings file not set in backoffice 216 contact does not allow automatic renew 301 problem with invoking credits for this customer 302 problem with writing file I/O error 303 xml required field is missing this is default error for all undefined xml fields 304 problem with checking offer validity 305 problem with invoking external url 306 problem with checking renew for germany 307 missing content remote method called without content 308 error when invoking JF using credits 309 error listing contract id 310 xml field should be numeric 500 internal server error 7