If a fatal error is encountered while processing your request to the Web API an error response will be returned to you. The Web API returns an error condition through the use of an HTTP header response status-code of 403 Forbidden. This method ensures you can receive the response regardless of the response type you specified in the request. This form of error response also means that no portion of your request was executed.
The body of an error response is a human readable HTML response. Within the <head> section of this HTML response are <meta> tags that are machine readable that you can use to determine the cause of the error within your program. The meta tags used are:
<meta name='webapierrornumber' content=''> <meta name='webapierrordescription' content=''> <meta name='webapierrordetails' content=''>
The content value of 'webapierrornumber' will be an integer value indicating the error number. The content value of 'webapierrordescription' is a plain text description of the error that ocurred. The content value of 'webapierrordetails' is a plain text description of any details related to the error.
The possible values for 'webapierrornumber' are:
| SE_EMPTY_REQUEST | 100200 | Empty request. |
| SE_BAD_RESPONSE_TYPE | 100201 | Bad response type specified. |
| SE_AUTHENTICATION_FAILED | 100202 | Authentication failed. |
| SE_UNSUPPORTED_REQUEST | 100203 | Unsupported request. |
| SE_UNSUPPORTED_FIELD | 100204 | Unsupported field. |
| SE_HTTPS_REQUIRED | 100205 | An HTTPS connection is required. |
| SE_LIMIT_ONE_CLASS | 100206 | You can only access one class per request. |
| SE_FIELD_LIST_REQUIRED | 100207 | The "field" parameter must be specified with the requested response type. |
| SE_INVALID_XML | 100208 | The request is not valid XML. |