Errors and suggested actions

WoAG Occupation Coding Service User Guide

Glossary of common errors, explanations and solutions

Cite
Released
30/06/2025

These codes help identify issues on both the client and server sides, allowing for troubleshooting and resolution of HTTP request problems.

 

Error messageWhy this happened You should…
Generic errors possible on all API calls
Invalid request body
HTTP Status Code: 400		Something was wrong with your request body syntax. 
Example: small batch records exceed length limit of 300/you tried to code too many records at once using the synchronous small batch service.
  • check the request body syntax for the API call and try again.
  • remove any special characters from free text inputs (see Recommended text input for coding)
  • If your small batch has this error, retry with a smaller batch size, or consider using the asynchronous batch coding service.
User is not authorized to access this resource with an explicit deny
HTTP Status Code: 403		You have either not authenticated or your authentication token has expired.
Limit Exceeded
HTTP Status Code: 429		You have made too many calls to the API. 
  • wait 24 hours before calling the API again, or
  • contact us to discuss increasing your request quota.
Too Many Requests
HTTP Status Code: 429		You have made too many API calls in a short period of time.
  • space out your requests over a longer timeframe, and
  • consider using the asynchronous coding service if coding many records.
Error performing request
HTTP Status Code: 500		This happens when something unexpected goes wrong on the server. In some instances, further context is provided.
  • retry after a short delay; report persistent issues to support.
Problems selecting model/topic
The specified topic does not exist
HTTP Status Code: 404		No topics matched the provided topic parameter.
The specified model does not exist
HTTP Status Code: 404		No models matched the provided model parameter. 
You’ll see this if the system can't locate the specified model - maybe due to a typo or outdated ID.
Selected model does not match the input topic.
HTTP Status Code: 409		The given model GUID does not correspond to the specified coding topic. 
Errors on the get models endpoint
No models found for topic topic
HTTP Status Code: 500		No models are available for the provided topic parameter. 
  • reach out to your ABS contact to investigate why no model is available.
Synchronous coding errors
Malformed record found in request
HTTP Status Code: 400		The free text input did not match the expected format for the model. 
  • check what the expected format is for a given topic here.
Batch input contained no records
HTTP Status Code: 400		You tried to code a small batch of records but the records array was empty.
  • check that you have provided at least one record to be coded, and
  • check that your request body is correctly formatted.
There are record(s) outside the min or max char limit:
Record with index x has a total text length under 3 min
Record with index y has a total text length over 100 max
…
HTTP Status Code: 400		One or more records provided had too many or too few characters. 
RateLimitExceededException
HTTP Status Code: 429 
(Too Many Requests)		You’ll see this when sending too many requests too quickly. 
  • space out your requests and implement retry logic.i
Asynchronous coding errors
User is not authorised to retrieve operation GUID
HTTP Status Code: 401		The specified operation does not belong to the current user.
You may have authenticated with the wrong user or specified the wrong operation_id.
  • authenticate again and check you have the right credentials, and
  • confirm your operation id.
Unable to retrieve operation for given id
HTTP Status Code: 404		No operations were found to match the given operation_id.
This is most likely due to a typo.
  • confirm the operation ID is correct.
  • if you have lost your operation ID, you will have to create a new operation.

See more information on HTTP errors at HTTP response status codes - HTTP | MDN.