Rozhranie REST API možno použiť na spracovanie používateľských dotazov bežným spôsobom(/c/company/user-query). Okrem toho je možné vyvolať aj dotaz používateľa.

Najjednoduchší dotaz, t. j. taký, ktorý nemá žiadne parametre (alebo všetky parametre majú dostatočné predvolené hodnoty), možno zavolať takto: /c/company/user-query//call.xml (.json je tiež možné ). Fungujú bežné parametre úrovne detailu alebo stránkovania.

Ak má dotaz parametre, musíte v adrese URL určiť parameter pre každý parameter dotazu. T. j. ak má dotaz parameter dátum, jeho vyvolanie vyzerá takto: /c/company/user-query//call.xml?date=2012-01-01.

Ak má parameter dopytu kardinalitu N, t. j. je možné zadať viacero hodnôt, stačí zopakovať parameter v adrese URL. Napríklad na výber viacerých spoločností: /c/company/user-query//call.xml?company=code:COMPANY1&company=code:COMPANY2. Potom použite operátor IN (<<firm>>) v uloženom dotazu.

Hodnoty parametrov sa zapisujú obvyklým spôsobom, nie v úvodzovkách. Nezabudnite na správne kódovanie v adrese URL.

Okrem metódy GET možno na vyvolanie dotazu použiť aj metódu POST, ktorá umožňuje odovzdať v tele požiadavky veľký počet parametrov.

Uložené dotazy je možné aj vytlačiť. Pre každý uložený dotaz je potrebné vytvoriť vlastnú tlač a vybrať ju pre uložený dotaz. Tlač je potom možné vyvolať prostredníctvom rozhrania REST API.

Did this answer your question?