Skip to main content
When a client accesses the CheckLists service via the API, situations may arise where the service itself or the search registers used by the service are unavailable. To correctly handle such situations, the following should be considered. In response to a request, the service returns an HTTP response status. By analyzing this status and the response structure, the following operating scenarios can be identified:
  • HTTP status codes in the range 500–599 — the CheckLists service is unavailable or operating incorrectly.
  • HTTP status codes in the range 400–499 — the CheckLists service is available but cannot process your request. In this case, instead of the response structure described above, the client will receive the following error structure:
    • error (int)
    • message (string)
List of errors:
  • HTTP status code 200 — the CheckLists service is available and can process client requests. The response structure may vary depending on access to specific search registers.
    • If the search register you are querying is operational, you have access to it, and the request processing time does not exceed the allocated limit, the service always returns a result (the structure described above or an empty array if no matches are found).
    • Otherwise, in the response block for the respective search register, instead of the expected data structure, the client may receive a textual error message. The list of such messages and the situations in which they occur is as follows:
      • "9000.No connection to the service" — the search register is not operational or the service has no connection to it.
      • "9001.Access to the service is denied" — access to the search register is denied because it is not included in the service package you have paid for.
      • "9003.Request processing time exceeded. Please refine your query" — occurs when processing a request to a search register exceeds the allocated time limit.
      • "9004.No connection to the service database" — occurs when the service that maintains the register is available, but there is no connection to the register’s database.