(350).png){kind=logo}
API Response XML Package
- 1 Minute to read
- Print
- DarkLight
API Response XML Package
- 1 Minute to read
- Print
- DarkLight
Article Summary
Share feedback
Thanks for sharing your feedback!
After an API call has been completed, a response will be sent back in the same format regardless of the method being called. Below is an example of this response.
<SmarterU>
<Result></Result>
<Info></Info>
<Errors>
<Error>
<ErrorID></ErrorID>
<ErrorMessage></ErrorMessage>
</Error>
</Errors>
</SmarterU>Result
The Result tag indicates whether the API method call was successful and returns one of the following:
- Success - All operations successfully completed.
- Failed - All operations failed, or a processing error occurred.
Info
The Info tag contains information about the method being completed. The contents of this tag is specific to each API method.
Errors
The Errors tag contains information for errors that occurred during the API call. The tag contains the following.
| Tag | Description |
|---|---|
| ErrorID | The error code. |
| ErrorMessage | The error's description. |
Below are the general error codes when sending a package to the SmarterU API.
| Error Code | Message |
|---|---|
| SU:01 | No POST data detected. |
| SU:02 | Package parameter not found. |
| SU:03 | Package data is not properly formatted XML. |
| SU:04 | SmarterU root tag not found in Package data. |
| SU:05 | AccountAPI tag not found in Package data. |
| SU:06 | UserAPI tag not found in Package data. |
| SU:07 | Method tag not found in Package data. |
| SU:08 | Parameters tag not found in Package data. |
| SU:09 | Parameters tag contains no information. |
| SU:10 | User and Account API keys are invalid. |
| SU:11 | Requested method does not exist. |
| SU:12 | Incorrect/Missing Structure/Parameters. |
| SU:13 | Element %TAG_Name% was found where it should not exist. |
| SU:9999 | Unknown method call failure. |
Was this article helpful?