Kody odpowiedzi protokołu HTTP

Każda metoda w WebAPI zwraca status odpowiedzi HTTP oraz w przypadku niepowodzenia zwraca wyjątek z komunikatem i szczegółową informacją o błędzie.

 

Poniżej przykładowe statusy:

•OK (200), Created (201) lub No content (204) – zapytanie zostało poprawnie przetworzone (wiadomość zwrotna może zawierać informacje, np. w przypadku wystawienia zamówienia zawiera obiekt wystawionego zamówienia);

•Bad Request (400) – zapytanie zostało odrzucone (zazwyczaj błąd walidacji lub błąd wykonania metody wewnętrznej Handlu), w tych przypadkach zostaje zwrócony wyjątek z krótką informacją na temat błędu oraz ModelState ze szczegółowymi informacjami na temat zaistniałych problemów;

•Unauthorized (401) – nieautoryzowany dostęp (występuje w przypadkach podania niepoprawnego tokenu aplikacji, sesji, a także w przypadku, gdy sesja wygasła lub przekroczono limit otwartych sesji);

•Not Found (404) – nie odnaleziono żądanego zasobu (zazwyczaj występuje podczas pobrania zasobu, który nie istnieje np. kontrahenta o id, który nie występuje w bazie);

•Conflict (409) – konflikt (obiekt jest edytowany przez innego użytkownika aplikacji Handel);

•Internal Server Error (500) – błąd wewnętrzny serwera (jest to błąd nieobsłużony, oznacza, że w WebAPI wystąpił nieoczekiwany wyjątek, zawiera krótką informację
o błędzie oraz StackTrace wyjątku) – w szczególności takie przypadki należy zgłaszać wraz z opisem sytuacji i logami błędu.

 

Komunikaty 400, 401. 404, 409, 500 oprócz tego, że są zwracane przez WebAPI, to są również zapisywane do logów.