Payload Errors

A payload error is generated if a request payload is illformed. If such an error occurs, all the requests contained in the payload are ignored. In the case of an error, the Search Engine Server returns a response payload containing a single ses-response element. Instead of the request-id attribute the opening tag of this element contains a payload-id attribute whose value is the ID of the invalid payload.

The ses-response element contains an ses-code element in whose opening tag the attributes numeric and phrase are set to the error number and the message text, respectively. The following example shows a response payload containing an error message.

<?xml version="1.0" encoding="UTF-8">
<!DOCTYPE ses-payload SYSTEM "https://www.example.com/ses.dtd">
<ses-payload payload-id="B3BWPOIU" timestamp="20100906100205" version="2.1">
  <ses-header>
    <ses-sender sender-id="U2JWUE09" name="SES"/>
  </ses-header>
  <ses-response response-id="BR12TI5X"
        payload-id="AHZ97I28" success="false">
    <ses-code numeric="1"
        phrase="Payload incomplete / cannot parse">
    </ses-code>
  </ses-response>
</ses-payload>

On the payload level the following errors can occur:

• Payload incomplete / Cannot Parse
  This is the error response to request payloads containing invalid XML code.
• Not well-formed Payload Request payloads that contain valid XML code but do not represent a valid request payload are answered with this message.
• Incompatible Version
  This error is returned for request payloads formulated in a version of the XML interface protocol not supported by the server. The behaviour of the server in such cases is described in section Payloads.
• Authentication Failed
  The information in the ses-authentication element is invalid.