API Error Codes
The following error codes (not http status code) can be returned in an error response on the errorCodes property. It is encouraged that you check these error codes and use them to inform the action to take.
| Error Code | Description | Notes |
|---|---|---|
| AM1 | EID header is not a number or some other error | Ensure that a numeric EID header is supplied |
| AM2 | EID header is missing | Ensure that a numeric EID header is supplied |
| AU1 | Authentication failed | The machine account is incorrectly configured. Please contact your admin |
| AU2 | Authentication failed | Token or ESL Fault |
| CV1 | Payload does not match schema | Ensure that the payload matches the json schema |
| DS1 | Request prevented by already running request for EID/Dataset | Only make 1 request per EID/Dataset at a time |
| DS2 | Request prevented by already running request for EID/Dataset | Only make 1 request per EID/Dataset at a time |
| DS3 | Request prevented by already running request for EID/Dataset | Only make 1 request per EID/Dataset at a time |
| GM1 | Compressed payload stream could not be read | Client gzip/compression related |
| MP1 | Payload exceeded maximum allowed number of records | Limit payload to the number indicated in the token response |
| PR1 | Pagination property is less than 0 | Ensure pagination properties are correct |
| PR2 | Pagination page request is outside available data | Ensure pagination properties are correct |
| R1 | Bad reference year | Ensure that the reference year is within reasonable bounds. |
| SC1 | The submission token for the EID can not be found | There is no record for submission token/EID combination, Request a new token for the return period |
| SC10 | The submission token for the EID can not be found | There is no record for submission token/EID combination, Request a new token for the return period |
| SC2 | The submission token for the EID can not be found | There is no record for submission token/EID combination, Request a new token for the return period |
| SC3 | The submission token for the EID can not be found | There is no record for submission token/EID combination, Request a new token for the return period |
| SC4 | The submission token for the EID can not be found | There is no record for submission token/EID combination, Request a new token for the return period |
| SC5 | The submission token for the EID can not be found | There is no record for submission token/EID combination, Request a new token for the return period |
| SC6 | The submission token for the EID can not be found | There is no record for submission token/EID combination, Request a new token for the return period |
| SC7 | The submission token for the EID can not be found | There is no record for submission token/EID combination, Request a new token for the return period |
| SC8 | The submission token for the EID can not be found | There is no record for submission token/EID combination, Request a new token for the return period |
| SC9 | The submission token for the EID can not be found | There is no record for submission token/EID combination, Request a new token for the return period |
| SS1 | The submission token has expired | Request a new token for the return period |
| SS2 | The submission extension has expired | Contact TEC |
| SS3 | The return period associated with the token is invalid | Ensure that the return period id is correct |
| SS4 | No return period for the given id | Ensure that the return period id is correct |
| SS5 | Can not validate without uploading records | Upload at least 1 record to perform validation |
| SS6 | Can not validate without uploading records for each dataset | Upload at least 1 record for each dataset |
| SS7 | The submission token for the EID can not be found | There is no record for submission token/EID combination, Request a new token for the return period |
| SS8 | Validation prevented by submission status | Submission must not be queued or processing to request validation |
| SS9 | Action prevented by submission status | Submission must not be queued or processing to request action |
| U1 | EID header is 0 or empty | Ensure that a numeric EID header is supplied |
| U2 | EID header is not a number or some other error | Ensure that a numeric EID header is supplied |
| U3 | Authorization header is not set correctly | Ensure that the Authorization header is set with a Bearer value |
| UC1 | The user can not be found, ensure the current user has been registered | Ensure that the user has been registered |