Programátorské rozhraní Pořadače dokumentů Dokumentového serveru (API) -- Technická nápověda

Tato nápověda je určena typicky správcům webových stránek, kteří chtějí na svoje stránky buď umístit odkaz směřující do Pořadače dokumentů, nebo chtějí do svých stránek zařadit některý ze seznamu dokumentů spravovaných prostředky Pořadače dokumentů.

Pořadač dokumentů Dokumentového serveru je komponentou Vyhledávání IS MU. O Pořadači dokumentů se zmiňuje uživatelská nápověda. Provozovatel IS MU ručně označuje datem nebo pořadovým číslem, vybranými štítky a identifikací pracovišť dokumenty zaváděné do Dokumentového serveru. Každý, kdo zavádí dokumenty do Dokumentového serveru používá jiných zvyklostí v označování dokumentů, které se někdy liší i v čase. Cílem Pořadače je sjednotit přes celou školu označování dokumentů tak, aby byly přehledně dostupné bez ohledu na to, kde a jak jsou v Dokumentovém serveru zavedeny. Pořadačem se označují jen ty dokumenty, které jsou přístupné alespoň pracovníkům nebo studentům jedné fakulty.

Pořadač dokumentů Dokumentového serveru je dostupný autentizovaně i neautentizovaně. Každému jsou dostupné jenom dokumenty, u kterých je v Dokumentovém serveru nastaveno, že má právo je číst. Nejméně dokumentů bude proto přístupných přes neautentizovaný Pořadač dokumentů.

Odkaz do neautentizovaného Pořadače dokumentů může vypadat následovně:

https://is.muni.cz/poradac/akademicky-senat/mu/zapis

Odkaz do autentizovaného Pořadače dokumentů:

https://is.muni.cz/auth/poradac/mu/opatreni-rektora

Případně pro anglickou verzi nahraďte "poradac" za "binder". Pozor však, odkazované dokumenty nejsou překládány do angličtiny! Proto ani názvy štítků se nepřekládají do angličtiny.

https://is.muni.cz/binder/akademicky-senat/mu/zapis

Konstrukce odkazu je následující: za jménem aplikace "poradac" (nebo "binder") se uvádějí zkratky pracovišť a štítky oddělené lomítkem (/). Na pořadí pracovišť a štítků nezáleží. Na místě pracoviště musí být doménové jméno fakulty (z poštovní adresy), tj. med, pharm, phil, law, fss, sci, fi, ped, fsps, econ. Pro Masarykovu univerzitu se použije "mu". Pro jiná pracoviště pak zkratky pracovišť z číselníku pracovišť. Zkratky se uvádějí malými písmeny bez diakritiky. Než budete zkoušet odkazy pro různá pracoviště, ověřte si nejprve dostupnost dokumentů pro konkrétní pracoviště v interaktivním Pořadači.

Štítky jsou pojmenovány stejně jako v interaktivním Pořadači. Zapisují se malými písmeny bez diakritiky. Mezery nahraďte znakem minus (-). Použijete-li dva nebo více štítků současně, vyberou se dokumenty, které jsou označeny současně všemi štítky. Na pořadí štítků nezáleží.

Použít lze i servisní štítky, které odpovídají zaškrtávátkům:

i-mezi-prilohami

Vyhledávat i mezi přílohami.

i-mezi-podklady

Vyhledávat i mezi podklady.

i-mezi-neplatnymi

Vyhledávat i mezi již neplatnými verzemi.

i-jen-jednomu

I jen jednomu z Jaký dokument.

radit-vzestupne

Seřadit vzestupně.

xml-vystup

Výstup se předá v XML. Je popsáno dále.

Např. https://is.muni.cz/auth/poradac/opatreni-rektora/smernice-mu/mu/i-jen-jednomu

Další parametry lze zadat způsobem běžně používaným v URL. Jedná se o tyto parametry:

od=datum

Od jakého data, které je v Pořadači přiřazené dokumentu, se mají dokumenty vyhledávat. Jako datum lze zadat den měsíc rok, měsíc rok, nebo jenom rok např. 20+10+2013. Mezery nahraďte znakem plus.

do=datum

Do jakého data, které je v Pořadači přiřazené dokumentu, se mají dokumenty vyhledávat.

start=stránka

Pořadí stránky, která se má zobrazit. Čísluje se od 1. Implicitně se zobrazí 1. stránka.

nastranku=počet

Kolik maximálně záznamů se má zobrazit na stránce. Implicitně 25. Minimálně 5, maximálně 100.

Např. https://is.muni.cz/poradac/lf/akademicky-senat/zapis?start=5;nastranku=10

Chcete-li do hlavičky a patičky stránky Pořadače vložit odkaz "zpět na konkrétní stránku", použijte parametry:

zpet=url

URL, na které má odkaz ukazovat.

zpet_text=Název+odkazu

Text k odkazu.

Např. https://is.muni.cz/poradac/mu/akademicky-senat/?zpet=https://semchcijit.cz/;zpet_text=Zpátky+na+můj+web

Následující výstup má smysl jen pro programátory navazujících systémů.

Pořadač dokumentů předá výstup ve formátu XML po zadání štítku "xml-vystup", např.:

https://is.muni.cz/poradac/mu/akademicky-senat/zapis/xml-vystup?start=3

V neautentizovaném webu lze XML výstup z Pořadače dokumentů zkombinovat i s vyhledáváním následovně:

https://is.muni.cz/poradac/mu/akademicky-senat/zapis/xml-vystup?search=IS+MU

Samotné vyhledávání bez Pořadače dokumentů lze v neautentizovaném webu s XML výstupem použít následovně:

https://is.muni.cz/vyhledavani?xml_vystup=1;search=IS+MU

Následující informace má smysl jen pro programátory navazujících systémů.

K výstupu Pořadače dokumentů (XML i HTML) lze přistupovat z neosobního účtu.

Např.: wget --auth-no-challenge --user 999999 --password ABCDEFGHI https://is.muni.cz/auth/poradac/mu/rozhodnuti-rektora/xml-vystup