API - Basic Response

All API resources (excluding PDF-generators) respond with below basic components as part of the response structure. It is vital to the quality of your application that you process the response and flag possible warnings, errors and unforseen status numbers.

Response

<?xml version="1.0" encoding="UTF-8"?>
<warnings>
    <warning>
        <code></code>
        <codetag></codetag>
        <message></message>
    </warning>
    <warning>
        ...
    </warning>
    <countwarnings></countwarnings>
</warnings>
<errors>
    <error>
        <code></code>
        <codetag></codetag>
        <message></message>
    </error>
    <error>
        ...
    </error>
    <counterrors></counterrors>
</errors>
<status></status>
code
Usually a number 4xx, 5xx or 6xx.


codetag
Unique reference for the error or warning.


message
Description of the error or warning.


counterrors
Total number of errors as part of the process.


countwarnings
Total number of warnings as part of the process.


status
Process indicator

Output format
0
Success. No errors or warnings.
1
Failed. Errors.
2
Success. Including warnings.
3
Exception. Please contact Acumulus technical support.