Chyby API

Chybu vrací API ve formátu Problem Details. Pole type odpovědi je adresa stránky, která chybu vysvětluje. Pole code a status jsou určená pro programy, text v polích title a detail se může měnit.

• bad-request HTTP 400
  Požadavek nemá správný tvar: obsahuje neznámý nebo chybně zapsaný parametr, neplatný kurzor stránkování nebo tělo, které není platný JSON.
• authentication-required HTTP 401
  Požadavek neobsahuje přístupový token.
• invalid-token HTTP 401
  Přístupový token neplatí: je zrušený, vypršel, patří k jiným stránkám, člen už nemá přístup nebo stránky nemají placenou verzi.
• forbidden HTTP 403
  Token je platný, ale člen, ke kterému patří, nemá na stránkách k tomuto obsahu nebo akci oprávnění.
• insufficient-scope HTTP 403
  Token je platný, ale přístup zvolený při jeho vytvoření tuto akci nezahrnuje.
• not-found HTTP 404
  Požadovaný záznam neexistuje, byl smazán, nebo ho člen nesmí vidět.
• method-not-allowed HTTP 405
  Adresa existuje, ale nepodporuje použitou metodu HTTP.
• not-acceptable HTTP 406
  API neumí odpovědět ve formátu, který požadavek uvádí v hlavičce Accept.
• conflict HTTP 409
  Akce se nedá provést kvůli současnému stavu záznamu, například proto, že se mezitím změnil nebo je použitý jinde.
• precondition-failed HTTP 412
  Záznam se od načtení změnil: hodnota v hlavičce If-Match už neodpovídá jeho současné verzi.
• payload-too-large HTTP 413
  Odesílaný obsah, například soubor přílohy, je větší, než API přijme.
• unsupported-media-type HTTP 415
  API nepřijímá typ obsahu, který požadavek uvádí v hlavičce Content-Type.
• validation-failed HTTP 422
  Požadavek má správný tvar, ale některá hodnota neodpovídá pravidlům stránek.
• role-not-allowed HTTP 422
  Člen, ke kterému token patří, nesmí přidělit požadovanou roli.
• idempotency-key-required HTTP 400
  Akce, kterou je bezpečné opakovat jen s klíčem, nemá hlavičku Idempotency-Key.
• invalid-idempotency-key HTTP 400
  Hodnota hlavičky Idempotency-Key nemá povolený tvar.
• idempotency-key-reused HTTP 422
  Stejný klíč Idempotency-Key už byl použit pro jiný požadavek.
• precondition-required HTTP 428
  Změna záznamu vyžaduje hlavičku If-Match s verzí záznamu.
• rate-limited HTTP 429
  Token poslal v krátké době příliš mnoho požadavků.
• internal-error HTTP 500
  Požadavek se nepodařilo dokončit kvůli chybě na straně stránek.
• service-unavailable HTTP 503
  Stránky jsou dočasně nedostupné, například kvůli údržbě.
• idempotency-unavailable HTTP 503
  Změnu se nyní nepodařilo bezpečně provést a nic se neuložilo.
• pagination-temporarily-unavailable HTTP 503
  Další stránku výpisu se nyní nepodařilo připravit.
• rate-limit-temporarily-unavailable HTTP 503
  Stránky nyní nemohou ověřit limit požadavků, a proto požadavek nepřijaly.
• mutation-temporarily-unavailable HTTP 503
  Změnu se nyní nepodařilo bezpečně provést a nic se neuložilo.
• attachment-content-temporarily-unavailable HTTP 503
  Soubor přílohy je nyní dočasně nedostupný.
• gallery-image-content-temporarily-unavailable HTTP 503
  Soubor fotografie je nyní dočasně nedostupný.
• document-content-temporarily-unavailable HTTP 503
  Soubor dokumentu je nyní dočasně nedostupný.
• email-history-temporarily-unavailable HTTP 503
  Historie odeslaných e-mailů je nyní dočasně nedostupná.

Úplnou dokumentaci API najdete po přihlášení na stránkách svého SVJ v profilu v části „API přístupy“. Pokud stránky teprve zvažujete, napište podpoře a pošleme Vám na dokumentaci odkaz. Co API umí, shrnuje přehled API.