eOrdering API 1.3, revízia 2018-05-15
Zoznam objektov

Požiadavka

Pri požiadavke na zoznam objektov treba dbať na to, že eOrdering API pracuje vždy so stránkami objektov.

Syntax

GET /api.svc/json/{keyword}?page={cisloStranky}&pageSize={velkostStranky}

Parametre

Všetky metódy na vrátenie zoznamu objektov akceptujú tieto parametre:

Parameter Popis Povinný Typ Povolené hodnoty Predvolená hodnota
keyword typ objektu áno string suppliers, companies, pharmacies, products, orders
page požadovaná stránka nie integer 1 <= N 1
pageSize veľkosť stránky nie integer 10 <= N <= 1000 100
filter vyhľadávací reťazec nie string minimálne tri znaky

V príslušných sekciách dokumentácie je určené, v ktorých dátovych poliach sa vyhľadáva cez parameter filter. Pre zadanie viacerých slov v URI, spojte tieto slová prázndym znakom.

Poznámky
keyword je v tomto zozname uvedený ako parameter iba zo syntaktického hľadiska.
Možné chyby
Ak minimálne jeden z parametrov nespĺňa požiadavky kladené na povolené hodnoty, dostanete chybovú odpoveď s HTTP statusom 400.
keyword je povinná súčasť URI a pri "nepovolenej hodnote" ide o problém adresovania API metódy, čiže chyba s HTTP statusom 405.

Odpoveď

Požiadavku možno považovať za úspešne spracovanú, len ak odpoveď na ňu má nastavený HTTP status 200.

Syntax

{
  /* strankovanie je zapnute */
  "isPaged": true,

  /* velkost vratenej stranky */
  "pageSize": integer,

  /* cislo vratenej stranky */
  "page": integer,

  /* celkovy pocet objektov */
  "total": integer,

  /* zoznam vyziadanych objektov na stranke */
  "items": [

  	/* zoznam objektov,
  	 * ich struktura zavisi od konkretnej metody
  	 */

  ]
}

Implementované metódy