Obsługa błędów - CheckLists API

Podczas korzystania z API serwisu CheckLists mogą wystąpić sytuacje, gdy serwis lub rejestry wyszukiwania używane przez serwis są niedostępne. Aby prawidłowo obsłużyć takie sytuacje, należy znać następujące zasady. W odpowiedzi na żądanie serwis zwraca status HTTP. Analizując go oraz strukturę odpowiedzi, można wyróżnić następujące przypadki:

Status HTTP w zakresie 500-599 – serwis CheckLists jest niedostępny lub działa niepoprawnie.
Status HTTP w zakresie 400-499 – serwis CheckLists jest dostępny, ale nie może przetworzyć Twojego żądania. W odpowiedzi, zamiast standardowej struktury, klient otrzyma następującą strukturę błędu:
- error int
- message string

Lista błędów:

message	error
Użytkownik „użytkownik” nie istnieje.	ACCOUNT_NOTFOUND = 1;
Adres „adres IP” nie znajduje się na liście dozwolonych.	NOT_ALLOW_IP = 2;
Dostęp testowy (promocyjny): limit żądań został wyczerpany lub czas dostępu wygasł.	TEST_ACCESS_END = 3;
Użytkownik „użytkownik” ma dostęp tylko przez stronę internetową.	SITEONLY = 6;
Data rozpoczęcia korzystania z serwisu „data rozpoczęcia” jeszcze nie nadeszła.	ACCOUNT_NOT_ALLOWED_YET = 7;
Data „data zakończenia” wygasł okres dozwolonego korzystania z serwisu.	ACCOUNT_ACCESS_ENDS = 8;
Użytkownik „użytkownik” został zablokowany.	ACCOUNT_BLOCKED = 9;
Użytkownik „użytkownik” nie potwierdził rejestracji.	ACCOUNT_NOT_CONFIRM = 10;
Limit żądań („limit żądań”) został wyczerpany.	ACCOUNT_REQUEST_LIMIT_ENDS = 11;
Nieprawidłowy parametr ‘Data początkowa’ do sprawdzenia zmian w EDR osób prawnych i FOP	REQUEST_BEGINDATE_ERROR = 103;
Nieprawidłowy parametr ‘Data końcowa’ do sprawdzenia zmian w EDR osób prawnych i FOP	REQUEST_ENDDATE_ERROR = 104;
Nieprawidłowy parametr dolnej granicy lowranklimit do wyszukiwania w rejestrach sankcji	REQUEST_LOWRANKLIMIT_ERROR = 105;

Status HTTP 200 – serwis CheckLists jest dostępny i może przetwarzać żądania klientów. Struktura odpowiedzi może się różnić w zależności od dostępu do rejestrów wyszukiwania.
- Jeśli rejestr wyszukiwania działa, masz do niego dostęp, a przetwarzanie żądania nie przekracza wyznaczonego limitu czasu – serwis zawsze zwraca wynik (opisany powyżej lub pustą tablicę w przypadku braku dopasowań).
- W przeciwnym razie, w bloku odpowiedzi dla danego rejestru wyszukiwania klient może otrzymać tekstowy komunikat o błędzie. Lista komunikatów i sytuacje, w których się pojawiają:
  - “9000.Brak połączenia z serwisem” – rejestr wyszukiwania nie działa lub serwis nie ma z nim połączenia.
  - “9001.Dostęp do serwisu zabroniony” – dostęp do rejestru wyszukiwania jest zabroniony, ponieważ nie jest objęty wykupionym pakietem usług.
  - “9003.Przetwarzanie żądania przekracza wyznaczony czas. Proszę sprecyzować żądanie” – pojawia się, gdy przetwarzanie żądania do rejestru przekracza przydzielony czas.
  - “9004.Brak połączenia z bazą danych serwisu” – pojawia się, gdy serwis obsługujący rejestr jest dostępny, ale brak połączenia z bazą danych rejestru.