JSON API a chybové kódy
Odpovede JSON API majú tvar:
errorcode: 0, message: No error
Kód nula značí úspech, tzn. že nedošlo ku žiadnej chybe. Kód nie je povinný, ale odporúča sa ho uvádzať aj v úspešných odpovediach.
Skupina 1-10 (general)
Kódy s číslami 1-10 sú určené pre všeobecné a spoločné chyby - chyby, ktoré nie sú špecifické pre žiadne API a nie sú zviazané s žiadnou konkrétnou operáciou. Momentálne sú to tieto:
errorcode: 1, message: Authentication required
Používateľ chce vykonať akciu na ktorú je potrebné overenie menom a heslom, ale neposkytol žiadne meno a heslo.
errorcode: 2, message: Username or password incorrect
Používateľ zadal nesprávne, alebo neplatné prihlasovacie údaje. Ak nezadal žiadne prihlasovacie údaje, mal by dostať chybu s kódom 1.
errorcode: 8, message: Invalid or missing argument
Požiadavka neobsahuje potrebné parametre, alebo poskytnuté parametre majú nesprávny tvar, alebo sú v danom kontexte nedovolené. Myslia sa týmto parametre okrem loginu a hesla, ktoré už sú pokryté chybami s kódmi 1 a 2.
errorcode: 9, message: Unknown API call
Požadovaná akcia neexistuje. Pridanie akéhokoľvek parametra to nezlepší a výsledok vždy bude len chyba.
errorcode: 3
errorcode: 4
errorcode: 5
errorcode: 6
errorcode: 7
errorcode: 10
rezervované pre budúce použitie
errorcode: 11
errorcode: 12
errorcode: 13
errorcode: 14
rezervované pre budúce použitie
errorcode: 15, message: Unsupported file format
Bol zadaný súbor, s ktorým si faxový systém nevie poradiť, vlastne ani nevie kde začať. To sa líši od chybového kódu 16, ktorý znamená, že formát je podporovaný, ale s daným súborom je napriek tomu nejaký problém.
errorcode: 16, message: PDF conversion failed
Poskytnutý súbor sa nedarí konvertovať na taký tvar, aký faxový systém potrebuje. Chyba sa vráti vtedy, ak sa systém o konverziu pokúsil a zlyhal v nej.
errorcode: 17, message: Fax storage failure
Poskytnuté údaje sú v poriadku, ale faxový systém nevie pokračovať, pretože mu nefunguje sieťové úložisko, nedá sa do neho zapisovať, alebo alebo je plné.
errorcode: 18, message: Fax database error
Poskytnuté údaje sú v poriadku, ale faxový systém nevie pokračovať, pretože nevie záznam uložiť do databázy.
errorcode: 19, message: TIFF file error
Používateľ dodal TIFF súbor, ktorý nespĺňa požiadavky, alebo je poškodený.
errorcode: 20, message: Fax message to retry was not found or is not yet considered undelivered. API call ignored.
Pri pokuse o znovuzaslanie faxovej správy sa táto správa nenašla, alebo ešte stále je vo fronte na doručenie. Volanie je možné opakovať až keď správa bude považovaná faxovým systémom za v danej chvíli nedoručiteľnú.
{
"success": false, // alebo true, ak volanie prebehlo úspešne (povinná položka)
"message": "Invalid or missing argument", // správa je povinná
"errorcode": 8, // číslo chyby, ak existuje - nepovinne
"hint": "recipient", // nepovinne údaj, ktorý volajúceho navedie ku riešeniu jeho problému
... // ďalšie údaje, ktoré chceme klientovi poskytnúť
... // napríklad počet strán u FAX-u, alebo ID pod ktorým bola položka prijatá na spracovanie
}Chybové kódy v JSON poskytuje FAX cez API. V budúcnosti by chybové kódy v ďalších API mali byť zjednotené s týmito. Message ku jednotlivým kódom sú uvádzané len orientačne a skutočná chybová hláška vrátená používateľovi môže znieť inak, špecifickejšie. Napríklad pri chybe s kódom 2 - "Username or password incorrect", môže hláška znieť "Session token incorrect", či "Account disabled" ak to v danom prípade lepšie zodpovedá skutočnosti.errorcode: 0, message: No error
Kód nula značí úspech, tzn. že nedošlo ku žiadnej chybe. Kód nie je povinný, ale odporúča sa ho uvádzať aj v úspešných odpovediach.
Skupina 1-10 (general)
Kódy s číslami 1-10 sú určené pre všeobecné a spoločné chyby - chyby, ktoré nie sú špecifické pre žiadne API a nie sú zviazané s žiadnou konkrétnou operáciou. Momentálne sú to tieto:errorcode: 1, message: Authentication required
Používateľ chce vykonať akciu na ktorú je potrebné overenie menom a heslom, ale neposkytol žiadne meno a heslo.
errorcode: 2, message: Username or password incorrect
Používateľ zadal nesprávne, alebo neplatné prihlasovacie údaje. Ak nezadal žiadne prihlasovacie údaje, mal by dostať chybu s kódom 1.
errorcode: 8, message: Invalid or missing argument
Požiadavka neobsahuje potrebné parametre, alebo poskytnuté parametre majú nesprávny tvar, alebo sú v danom kontexte nedovolené. Myslia sa týmto parametre okrem loginu a hesla, ktoré už sú pokryté chybami s kódmi 1 a 2.
errorcode: 9, message: Unknown API call
Požadovaná akcia neexistuje. Pridanie akéhokoľvek parametra to nezlepší a výsledok vždy bude len chyba.
errorcode: 3
errorcode: 4
errorcode: 5
errorcode: 6
errorcode: 7
errorcode: 10
rezervované pre budúce použitie
Skupina 11-20 (fax)
Kódy s číslami 11-20 pokrývajú chyby pri zasielaní a prijímaní faxových správ.errorcode: 11
errorcode: 12
errorcode: 13
errorcode: 14
rezervované pre budúce použitie
errorcode: 15, message: Unsupported file format
Bol zadaný súbor, s ktorým si faxový systém nevie poradiť, vlastne ani nevie kde začať. To sa líši od chybového kódu 16, ktorý znamená, že formát je podporovaný, ale s daným súborom je napriek tomu nejaký problém.
errorcode: 16, message: PDF conversion failed
Poskytnutý súbor sa nedarí konvertovať na taký tvar, aký faxový systém potrebuje. Chyba sa vráti vtedy, ak sa systém o konverziu pokúsil a zlyhal v nej.
errorcode: 17, message: Fax storage failure
Poskytnuté údaje sú v poriadku, ale faxový systém nevie pokračovať, pretože mu nefunguje sieťové úložisko, nedá sa do neho zapisovať, alebo alebo je plné.
errorcode: 18, message: Fax database error
Poskytnuté údaje sú v poriadku, ale faxový systém nevie pokračovať, pretože nevie záznam uložiť do databázy.
errorcode: 19, message: TIFF file error
Používateľ dodal TIFF súbor, ktorý nespĺňa požiadavky, alebo je poškodený.
errorcode: 20, message: Fax message to retry was not found or is not yet considered undelivered. API call ignored.
Pri pokuse o znovuzaslanie faxovej správy sa táto správa nenašla, alebo ešte stále je vo fronte na doručenie. Volanie je možné opakovať až keď správa bude považovaná faxovým systémom za v danej chvíli nedoručiteľnú.