Response Element

For response payloads, the ses-payload root element contains one or more ses-response elements after the ses-header element with which each result of the operations performed by the server is returned.

If a request payload has been completely recognized and processed by the server, each ses-response element in the response payload corresponds to a ses-request element in the request payload. In this case, the ses-response elements contain messages which refer to the contents of the requests (Request Level Message).

If, on the other hand, the Search Engine Server receives an invalid request payload (e.g. without a ses-header element or with unrecognizable ses-request elements), it returns a response payload containing only one ses-response element with which the general error is reported (see Payload Errors). In this case, the ses-response element refers to the payload (Payload Level Message). A ses-response element is constructed as follows.

<!ELEMENT ses-response (ses-code*)>
<!ATTLIST ses-response
  response-id CDATA #REQUIRED
  payload-id CDATA #IMPLIED
  request-id CDATA #IMPLIED
  success (true | false) #REQUIRED>

The individual responses to the requests are returned in ses-code elements.

<!ELEMENT ses-code ANY>
<!ATTLIST ses-code numeric CDATA #REQUIRED phrase CDATA #REQUIRED>

The attributes of the ses-response element have the following meanings:

  • response-id
    Response ID. This ID is set by the creator of the response payload. It must be unique within all payloads that are exchanged in a particular communication context.
  • payload-id
    Request payload ID. It corresponds to the payload-id attribute of the request payload. This attribute is added by the server only when the ses-response element contains a payload level message in the first ses-code element. A client can recognize by the occurrence of this attribute whether its request payload could be interpreted as such by the server (independently of the requests contained in it).
  • request-id
    Request ID. It corresponds to the receiver-id attribute of the ses-request element in the request payload. This attribute is only present when the ses-code element contains a request level message.
  • success
    The value of this attribute is true when the request could be successfully processed. Otherwise, it is false.

The results of the operations performed are returned by means of ses-code elements within the ses-response element. The ses-code elements contain a success or error message and other XML elements which represent the result of the operation or, if necessary, error information.

The attributes of the ses-code element have the following meanings:

  • numeric
    Error number (or success message number). The messages corresponding to the numbers are described in section Error Handling.
  • phrase
    The description of the error.

The content of the ses-code element depends on the operation indicated in the request. In operations which could not be performed successfully, the content of the ses-code element depends on the error which occurred. The possible contents of the ses-code element are listed for each operation in the following sections.