Troubleshooting
The Data API returns an HTTP response code per request. In the event of a validation error, an application specific code is returned in the meta packet.
The following HTTP response codes may be sent by the application.
| Response Code | Title | Message for developers |
|---|---|---|
| 200 | OK | A successful request. |
| 400 | Bad Request | Most likely due to missing or erroneous request parameters. |
| 403 | Forbidden | Typically for incorrect authentication details. Could also be returned for attempting to access endpoints over HTTP instead of HTTPS. |
| 405 | Method Not Allowed | Invalid request method. |
| 409 | Conflict | Request could not be completed due to a conflict with current state of the resource. |
| 410 | Gone | The URL requested is no longer available. |
| 429 | Too Many Requests | Too many requests has been received. See rate limiting. |
| 500 | Internal Server Error | A server error occurred while processing the request. |
A successful request (200 OK) may still fail for reasons such as request data validation. The table below describes the different application error codes that could be returned in the meta response packet.
| Error | Message for users | Message for developers |
|---|---|---|
Error code: 10000Response code: 500 | An error has occurred | An internal error has occurred. It has been logged and Learnosity is probably already looking into it. |
Error code: 20000Response code: 400 | Missing mandatory parameter(s) | Specify the required parameters. |
Error code: 20001Response code: 400 | Invalid parameter length | Ensure your request parameters match the expected length. |
Error code: 20002Response code: 400 | Too many parameters passed | Ensure your request parameters match the expected length. If specifying a search filter with many values, you may need to batch the values into separate requests and union the separate results. |
Error code: 20003Response code: 400 | Invalid parameter type | Ensure your request parameters match the expected type. |
Error code: 20004Response code: 400 | Invalid parameter value | Ensure your request parameters match one of the supported values. |
Error code: 20009Response code: 400 | JSON failed to validate against schema | Check the response message for details on the specific validation errors in the request. |
Error code: 20010Response code: 400 | XML failed to validate against schema | Check the response message for details on the specific validation errors in the request. |
Error code: 20011Response code: 409 | Conflict | Check the error message for details on why the operation could not be completed. |
Error code: 20012Response code: 404 | Not Found | Check the endpoint URL. |
Error code: 20013Response code: 400 | Item not found in database | Check the response message for details on which Items couldn't be found. Verify those Items exist in the desired Item bank and retry your request. |
Error code: 20014Response code: 400 | Tag not found | Verify the specified Tag exists in the desired Item bank. |
Error code: 20015Response code: 400 | Tag type not found | Verify the specified Tag type exists in the desired Item bank. |
Error code: 20016Response code: 400 | Session not found | Verify a Session exists with the specified session_id. |
Error code: 20017Response code: 400 | Dynamic content data missing or incomplete | Check the format of dynamic content data provided in the request. |
Error code: 20018Response code: 500 | An adaptive assessment error has occurred. | An internal error has occurred. It has been logged and Learnosity is probably already looking into it. |
Error code: 20027Response code: 400 | Response size too large | The response that has been generated is too large - try reducing the amount of data requested. See the article Managing Memory in Data API Calls for more information. |
Error code: 30000Response code: 400 | Duplicate entry in database | Ensure the identifiers in your request are unique. |
Error code: 30001Response code: 400 | Database value missing (typically foreign key constraint) | Check the response message for details on which records couldn't be found. Verify those records exist in the desired Item bank and retry your request. |
Error code: 30003Response code: 400 | Items in activities need to be unique | Verify the specified Items are unique and retry the request. |
Error code: 40000Response code: 400 | Access denied | Verify your consumer credentials and endpoint URL are correct. |
Error code: 40001Response code: 405 | Method not allowed | Verify your consumer credentials and endpoint URL are correct. |
Error code: 40002Response code: 403 | Consumer is not associated with an organisation | An internal error has occurred. It has been logged and Learnosity is probably already looking into it. |
Error code: 40003Response code: 403 | Consumer does not have sufficient access rights to current organisation (typically attempting write operation with read only access) | Verify you have specified the correct consumer credentials and org_id in your request. |
Error code: 41000Response code: 400 | Missing security parameters | Verify you have specified your consumer credentials according to the Data API security pattern. |
Error code: 41001Response code: 403 | Invalid parameter length | Verify the provided security signature is a valid md5 hash. |
Error code: 41002Response code: 403 | Not a valid consumer | Verify the provided consumer key is correct. |
Error code: 41003Response code: 403 | Signatures do not match | Verify the provided security signature was generated correctly. |
Error code: 41004Response code: 403 | Timestamp out of valid range | Resign the request with a new signature and retry. |
Error code: 41005Response code: 403 | Invalid domain | Verify the domain used to sign the request is correct. In the case of Data API requests sent from the browser, the domain used to the sign the request must match the browser's domain when it sends the request. |
Error code: 41006Response code: 400 | Expired parameter must be a GMT date of format YYYYMMDD-HHMM | Verify the expires parameter used to sign the request is in YYYYMMDD-HHMM format.
|
Error code: 41007Response code: 400 | Request after the expire timestamp | Resign the request with a new expires parameter and retry.
|
Error code: 41008Response code: 403 | Service is disabled | This service is disabled. Verify that the account details are correct or contact support for assistance. |
Error code: 41009Response code: 403 | Consumer exists but is no longer active | This consumer exists but is no longer active. Verify that the account details are correct or contact support for assistance. |
Error code: 42000Response code: 429 | Too many requests | Reduce the number of requests. Further reading: Rate limiting with the Data API |
Error code: 42001Response code: 410 | The endpoint is no longer available | Browse our other endpoints for a suitable alternative. |
Error code: 43000Response code: 400 | Requested version is lower than consumer minimum | Specify a newer version in your endpoint URL. |
Error code: 44000Response code: 400 | Unrecognised dataset_type | Verify the dataset_type specified in your request. |
Error code: 50000Response code: 400 | Report Dataset is missing some required data | Upload the required dataset files before attempting to commence the dataset generation. See our implementation guide for details. |
Error code: 50100Response code: 500 | An error occurred | An internal error has occurred. It has been logged and Learnosity is probably already looking into it. |