Error Handling

As soon as something goes wrong when processing a request, an error is generated and put into the response document. The status of the response will be set to "Error" or "Warning" depending on the severity of the error. In case of an error, processing will abort immediately, while in case of a warning processing continues.

An error has the following format:

<Error Id=”12345”>
  <Severity>Error/Warning</Severity>
  <Description>Short description</Description>
  <ExternalDescription>An external error text if available</ExternalDescription>
</Error>

Example response when trying to retieve a non-existent document:

<ProLinga>
  <Repository Version="1.0">
    <Command Name="Get" Mode="Response" Status="Warning">
      <Object Application="MyOrder" Type="Constant" Name="Standard">
        <Error Id="10006">
          <Severity>Warning</Severity>
          <Description>Document not found</Description>
          <ExternalDescription/>
        </Error>
      </Object>
    </Command>
  </Repository>
</ProLinga>

The "External" element will contain any error text passed on from the O/S or 3rd party products.

The following initial errors are defined:

Table 1. Errors

Error IdSeverityDescription
10000OkNo Error
10001ErrorError parsing document
10002ErrorEmpty Document
10003ErrorInvalid root element
10004ErrorInvalid repository XML file
10005WarningNo document match
10006WarningDocument not found
10007WarningDocument already deleted
10008ErrorCan not parse return string