Dokumentace API - Aktuality

Základní informace

Základní informace k API, autentizaci, stavovým kódům, HTTP metodám, datovým typům a další najdete na API v2 základní informace

Seznam aktualit

• URI: /api/v2/news
• HTTP metoda: GET
• hlavičky:
  • Authorization: Basic dGVzdDp0ZXN0
  • Content-Type: application/json
• parametry - slouží pro filtrování výstupu:
  • creation_time_from (date) - pouze aktuality vytvořené od zadaného data
  • last_update_time_from (date) - pouze aktuality u kterých došlo ke změně od zadaného data
  • active_yn (bool) - aktivní / neaktivní
  • language (language) - jazyk
  • id (int) - id konkrétní aktuality
  • page (int) - stránka, pokud není definováno, vrací vždy stranu 1

Odpověď

Seznam aktualit je dostupný po jednotlivých stranách. Výstup je omezen na 100 položek na stránku.

• tělo:
  • current_page (int) - aktuální strana
  • current_page_items (int) - počet položek na aktuální straně
  • number_of_pages (int) - celkový počet stran
  • number_of_items (int) - celkový počet položek
  • news (array) - pole objektů s aktualitami
    • news_id (int) - ID aktuality
    • active_yn (date) - zobrazit aktualitu na webu
    • creation_time (date) - čas vytvoření aktuality
    • last_update_time (date) - čas poslední aktualizace
    • descriptions (array) - pole objektů s texty
      • language (language) - specifikace jazykové mutace
      • title (string) - nadpis aktuality
      • short_description (string) - krátký popis, bez HTML formátování
      • long_description (string) - dlouhý popis, může obsahovat formátování pouze pomocí HTML značek
      • url (string) - URL adresa aktuality
    • images (array) - pole objektů s obrázky
      • url (string) - URL adresa obrázku
      • main_yn (bool) - hlavní obrázek
      • list_yn (bool) - seznamový obrázek
      • position (int) - pozice obrázku