Chybová hlášení při získávání dat přes API

Změníl(a) - Vladimír Koutný

Při zpracování požadavku na získání dat z aplikace plusPortal přes API, může docházet k různým nestandardním situacím (např. chybné heslo pro získání dat, nesprávný název požadované datové sady a podobně).

Výstup odpovědi bude v takovém případě prázdný a bude pouze zapsán kód chyby do hlavičky odpovědi v protokolu HTTP. Ve všech případech však dojde k zápisu do standardního logu aplikace plusPortal (textový soubor plusPortalAPI_log.txt ve složce App Logs):

  • neplatný nebo žádný název funkce vrátí chybu 400 a do logu bude zapsána informace: HTTP ERROR: 400, FKUser: {primární číslo uživatele v db plusPortal};
  • neplatné přihlášení vrátí chybu 401 a do logu bude zapsána informace: HTTP ERROR: 401, Login: '{zadané uživatelské jméno}';
  • anonymní přístup nebo chyba při zpracování autentizační hlavičky vrátí chybu 401 a do logu bude zapsána informace: HTTP ERROR: 401, No authentication header;
  • chyba, která nastala v průběhu zpracování požadavku, vrátí chybu 500 a do logu bude zapsána informace: HTTP ERROR: 500, FKUser: {primární číslo uživatele v databázi plusPortal}.

Pokud došlo k nějaké výjimce, bude připojen k zápisu i text této výjimky.


Jak hodnotíte článek?