Response Codes and Messages
- Gary Sharpe
The table below contains a breakdown of the possible 'responseStatus' Codes and 'responseDetails' Messages
The responseStatus property contains a value of 0 on success and a custom error status code on failure. If there is a failure, responseDetails contains a diagnostic string.
Code (responseStatus) |
Message (responseDetails |
Description |
|---|---|---|
0 |
 |
General Success. Â Request Processed and Results, if any, returned to client. |
1 |
Search returned no results. |
No results were found given the search criteria (NOTE: Not currently used in Identity Store APIs. Â This is used in the Mothra API.) |
2 |
Invalid API key. |
API key is invalid, or simply does not have the permission to view the requested API. |
3 |
The system encountered an error while processing this request. |
Generic system error. Â Details will have been captured on Identity Store API server logs. |
4 |
 |
Data Error. Â (NOTE: Not currently used in Identity Store APIs. Â This is used in the Mothra API.) |
5 |
Missing search parameters (At least one parameter is required). |
 |