SbalitRozbalit
  • 1.K čemu je API poznámkových bloků?

    API (Application Programming Interface) poznámkových bloků je rozhraní, které slouží k bezpečné manipulaci s poznámkovými bloky jednotlivých předmětů prostřednictvím aplikací externích systémů. Jeho hlavním úkolem je úprava obsahu poznámkových bloků. Dovoluje však poznámkové bloky i zakládat nebo zjišťovat základní informace o předmětu, jeho seminárních skupinách, zápisu studentů apod.

  • 2.Popis API poznámkových bloků.

    Před používáním API je nezbytné nejprve v aplikaci Povolení API poznámkových bloků vytvořit a povolit nový klíč k API, který se vždy vztahuje k jednomu celému předmětu ve zvoleném období.

    Osobní administrativa → Učitel → „výběr předmětu“ → Poznámkové bloky → Povolení API poznámkových bloků

    Povolení API poznámkových bloků

    Kliknutím na „Vytvořit nový klíč“ zobrazíte formulář. Textovými poli „Platí od“ a „Platí do“ nastavíte platnost klíče. Pro nastavení data použijte kalendář vpravo od textového pole nebo datum vkládejte ve tvaru „DD MM YYYY HH24 MI“ (například 1. září 2016 v 18 hodin 10 minut vložíte jako „01 09 2016 18 10“). „Platí do“ je povinný údaj. Ve formuláři dále musíte nastavit IP adresu, ze které bude API používáno. Bez povolení alespoň jedné IP adresy nelze API s příslušným klíčem aktivně využívat. Adres lze zadat i více a lze je doplnit nebo upravit i později. Aby bylo možné klíč ve vlastních skriptech či programech aktivně používat, je nutné kromě nastavení platného časového intervalu jej také povolit. Po uložení nového klíče se zobrazí veškeré klíče, které jsou ke zvolenému předmětu k dispozici.

    Ke každému klíči můžete také zobrazit kliknutím na „historie provedených operací“ informace, kdy a z jakých IP adres byly provedeny které operace a zda proběhly úspěšně.

    Uživatel, který založí nový klíč k API, je pak uváděn jako ten, kdo skrze API změnil data v poznámkových blocích.


    API poznámkových bloků

    API implementuje aplikace dostupná na adrese https://is.muni.cz/export/pb_blok_api. Při volání je nutné předat následující povinné parametry.

    Povinný parametrVýznam
    klic Hodnotou je unikátní autentizační řetězec, jenž získáte přes aplikaci Povolení API poznámkových bloků.
    fakulta Hodnotou je identifikační číslo fakulty dle číselníku.
    kodHodnotou je kód zpracovávaného předmětu.
    operace Specifikace operace, kterou chcete provést. Dle typu operace pak mohou být zapotřebí další povinné či nepovinné parametry. Jednotlivé operace jsou podrobněji popsány níže.

    Příklad požadavku, který vrátí XML s informacemi o předmětu.
    Pozor! Příklad je čistě ukázkový, nelze jej použít, neboť neobsahuje platný klíč.

    https://is.muni.cz/export/pb_blok_api?klic=VasVytvorenyKlic;fakulta=1433;kod=Etech69;operace=predmet-info

    Pozor! Aplikace vyžaduje použití protokolu HTTPS.


    Reakce na chyby

    V případě úspěšného dotazu vrátí skript stavový kód 200 s XML odpovědí. Pokud nastala chyba, vrátí skript odpovídající stavový kód bez XML. Dostupná je i dříve používaná varianta, kdy vždy vrací XML s popisem chyby kód 200, do parametrů je ale nutné přidat no_http_error=a.

    Stavový kód HTTPVýznam chyby/Zobrazovaný text v XMLPřípadný podrobnější popis chyby
    426 Použijte protokol https.
    403 Nebyl zadán povinný parametr. Povinné parametry jsou fakulta, kod, klic, operace. Různé operace pak mohou určovat další povinné parametry.
    403 Při zpracování nastala chyba. Nenalezeno api_id – např. při neexistujícím klíči; fakulta a kód předmětu spolu nesedí; nějaká neznámá chyba.
    403 Neoprávněný přístup. Nepovolená IP adresa.
    403 API není pro zvolený klíč povoleno. Existuje-li klíč, ale v aplikaci Povolení API poznámkových bloků není povolen.
    403 Aktuálně není použitý klíč povolen. Existuje-li klíč, ale v aplikaci Povolení API poznámkových bloků je nastavený jiný časový interval, než ve kterém byl klič použit.
    404 Nepovolená operace. Zobrazuje se při pokusu o spuštění operace, která není uvedena v tomto návodu.

    Operace

    Povinný parametr operace může nabývat hodnot uvedených v následující tabulce. Detaily k jednotlivým operacím jsou uvedeny dále.

    Hodnota parametru operaceVýznam
    predmet-info Vrátí XML s informacemi o předmětu, včetně seminárních skupin, pokud existují.
    blok-dej-obsah Vrátí XML s obsahem vybraného poznámkového bloku.
    predmet-seznam Vrátí XML se seznamem studentů, kteří mají předmět zapsaný.
    seminar-seznam Vrátí XML se studenty, kteří jsou zapsáni ve vybraném semináři.
    seminar-cvicici-seznam Vrátí XML se cvičícími, kteří vedou vybrané semináře.
    bloky-seznam Vrátí XML s informacemi o všech poznámkových blocích předmětu.
    blok-novy Založí nový poznámkový blok v příslušném předmětu.
    blok-pis-student-obsah Vloží nebo změní obsah poznámkového bloku konkrétnímu studentovi.
    terminy Vrátí XML s informacemi o zkušebních termínech.
    terminy-seznam Vrátí XML s informacemi o zkušebních termínech a přihlášených studentech.
    terminy-seznam-omez Vrátí XML s informacemi o zkušebních termínech a přihlášených studentech, kteří splňují podmínku.

    Operace predmet-info

    Vrátí XML s informacemi o předmětu, včetně seminárních skupin, pokud existují.

    Příklad požadavku:
    Pozor! Příklad je čistě ukázkový, nelze jej použít, neboť neobsahuje platný klíč.

    https://is.muni.cz/export/pb_blok_api?klic=VasVytvorenyKlic;fakulta=1433;kod=PB161;operace=predmet-info

    Příklad výstupu:

    <PREDMET_INFO>
     <FAKULTA_ID>1433</FAKULTA_ID>
     <FAKULTA_ZKRATKA_DOM>fi</FAKULTA_ZKRATKA_DOM>
     <KOD_PREDMETU>PB161</KOD_PREDMETU>
     <KRATKY_NAZEV_PREDMETU>Programování v jazyce C++</KRATKY_NAZEV_PREDMETU>
     <KRATKY_NAZEV_PREDMETU_ANGL>C++ Programming</KRATKY_NAZEV_PREDMETU_ANGL>
     <NAZEV_PREDMETU>Programování v jazyce C++</NAZEV_PREDMETU>
     <NAZEV_PREDMETU_ANGL>C++ Programming</NAZEV_PREDMETU_ANGL>
     <NEVYPISUJE_SE>0</NEVYPISUJE_SE>
     <OBDOBI_ID>6383</OBDOBI_ID>
     <OBDOBI_NAZEV>podzim 2015</OBDOBI_NAZEV>
     <OBDOBI_NAZEV_ANGL>Autumn 2015</OBDOBI_NAZEV_ANGL>
     <OBDOBI_ZKRATKA_PRO_URL>podzim2015</OBDOBI_ZKRATKA_PRO_URL>
     <OBDOBI_ZKRATKA_PRO_URL_ANGL>autumn2015</OBDOBI_ZKRATKA_PRO_URL_ANGL>
     <POCET_ZAPSANYCH_STUDENTU>174</POCET_ZAPSANYCH_STUDENTU>
     <POCET_ZAREG_STUDENTU>180</POCET_ZAREG_STUDENTU>
     <PREDMET_ID>869944</PREDMET_ID>
     <SEMINARE>
      <SEMINAR>
       <LIMIT_ID>365290</LIMIT_ID>
       <LIMIT_LZE_SDILET>ne</LIMIT_LZE_SDILET>
       <MAX_STUDENTU>15</MAX_STUDENTU>
       <NASOBNE_PRIHLASENI>ne</NASOBNE_PRIHLASENI>
       <ODHLASIT_DO>20151004000000</ODHLASIT_DO>
       <OZNACENI>01</OZNACENI>
       <POCET_STUDENTU_VE_SKUPINE>15</POCET_STUDENTU_VE_SKUPINE>
       <PORADI/>
       <POZNAMKA/>
       <PRIHLASIT_DO>20151004000000</PRIHLASIT_DO>
       <PRIHLASIT_OD>20150901180000</PRIHLASIT_OD>
       <SEMINAR_ID>365290</SEMINAR_ID>
       <VCETNE_NEAKTIVNICH>ne</VCETNE_NEAKTIVNICH>
       <ZMENENO>20150819215850</ZMENENO>
       <ZMENIL>118152</ZMENIL>
      </SEMINAR>
      <SEMINAR>
       ...
      </SEMINAR>
       ...
     </SEMINARE>
     <VYUCUJICI_SEZNAM>
      <VYUCUJICI>
       <CELE_JMENO>Leoš Otáhal</CELE_JMENO>
       <JMENO>Leoš</JMENO>
       <OSOBA_TEXTOVE>ne</OSOBA_TEXTOVE>
       <PRIJMENI>Otáhal</PRIJMENI>
       <ROLE>přednášející</ROLE>
       <UCO>445324</UCO>
       <ZASTUPCE/>
      </VYUCUJICI>
      <VYUCUJICI>
       <CELE_JMENO>RNDr. Jaroslav Bayer</CELE_JMENO>
       <JMENO>Jaroslav</JMENO>
       <OSOBA_TEXTOVE>ne</OSOBA_TEXTOVE>
       <PRIJMENI>Bayer</PRIJMENI>
       <ROLE>přednášející</ROLE>
       <UCO>72873</UCO>
       <ZASTUPCE>
        <CELE_JMENO>Bc. Martina Durkošová</CELE_JMENO>
        <JMENO>Martina</JMENO>
        <PRIJMENI>Durkošová</PRIJMENI>
        <UCO>395879</UCO>
       </ZASTUPCE>
      </VYUCUJICI>
       ...
     </VYUCUJICI_SEZNAM>
    </PREDMET_INFO>

    Značka SEMINARE je ve výstupu zahrnuta, jen pokud předmět má nějaké semináře vypsány.


    Operace blok-dej-obsah

    Vrátí XML s obsahem vybraného poznámkového bloku.

    Povinný parametrVýznam
    zkratka Hodnotou je zkratka poznámkového bloku, jehož obsah chcete získat.
    Tip: Operace bloky-seznam vrací seznam poznámkových bloků.
    Nepovinný parametrVýznam
    uco Omezí obsah poznámkového bloku na konkrétního studenta. Pro omezení na více studentů lze zadat více hodnot parametru uco, např. ?uco=72873;uco=139544.
    zareg Pokud je nastaveno na „a“, do výstupu budou zahrnuti i studenti, kteří mají předmět pouze zaregistrovaný (nemají jej zapsaný).
    vcukonc Pokud je nastaveno na „a“, do výstupu budou zahrnuti i studenti, kteří mají ukončené studium.
    vcneaktiv Pokud je nastaveno na „a“, do výstupu budou zahrnuti i studenti, kteří mají neaktivní studium.

    Příklad požadavku:
    Pozor! Příklad je čistě ukázkový, nelze jej použít, neboť neobsahuje platný klíč ani existující poznámkový blok.

    https://is.muni.cz/export/pb_blok_api?klic=VasVytvorenyKlic;fakulta=1433;kod=Etech69;operace=blok-dej-obsah;zkratka=TestAPI;vcukonc=a;uco=72873;uco=395879

    Příklad výstupu:

    <BLOKY_OBSAH>
     <STUDENT>
      <OBSAH>25 bodů</OBSAH>
      <UCO>72873</UCO>
      <ZMENENO>20160111104208</ZMENENO>
      <ZMENIL>395879</ZMENIL>
      <STAV_STUDIA>aktivní</STAV_STUDIA>
      <STAV_ZAPISU>zapsáno</STAV_ZAPISU>
     </STUDENT>
      ...
     <STUDENT>
      <NEMA_POZN_BLOK>1</NEMA_POZN_BLOK>
      <UCO>143277</UCO>
      <STAV_STUDIA>ukončené</STAV_STUDIA>
      <STAV_ZAPISU>zapsáno</STAV_ZAPISU>
     </STUDENT>
      ...
    </BLOKY_OBSAH>
    Stavový kód HTTPVýznam chyby/Zobrazovaný text v XMLPřípadný podrobnější popis chyby
    403 Nebyl zadán povinný parametr, který vyžaduje zvolená operace. Poviný parametr je zkratka.
    404 Neexistující poznámkový blok. Ke zvolenému předmětu neexistuje poznámkový blok.
    404 Student s učem $uco nemá zapsaný předmět, nebo takový student neexistuje.

    Operace predmet-seznam

    Vrátí XML se seznamem studentů, kteří mají předmět zapsaný. Seznam lze rozšířit i na studenty, kteří mají předmět pouze zaregistrovaný nebo mají ukončené či neaktivní studium.

    Nepovinný parametrVýznam
    zareg Pokud je nastaveno na „a“, do výstupu budou zahrnuti i studenti, kteří mají předmět pouze zaregistrovaný (nemají jej zapsaný).
    vcukonc Pokud je nastaveno na „a“, do výstupu budou zahrnuti i studenti, kteří mají ukončené studium.
    vcneaktiv Pokud je nastaveno na „a“, do výstupu budou zahrnuti i studenti, kteří mají neaktivní studium.

    Příklad požadavku:
    Pozor! Příklad je čistě ukázkový, nelze jej použít, neboť neobsahuje platný klíč.

    https://is.muni.cz/export/pb_blok_api?klic=VasVytvorenyKlic;fakulta=1433;kod=Etech69;operace=predmet-seznam;zareg=a;vcukonc=a;vcneaktiv=a

    Příklad výstupu:

    <PREDMET_STUDENTI_INFO>
     <STUDENT>
      <CELE_JMENO>Mgr. Ondrej Šebela</CELE_JMENO>
      <JMENO>Ondrej</JMENO>
      <PRIJMENI>Šebela</PRIJMENI>
      <SEMINARE/>
      <STAV_STUDIA>aktivní</STAV_STUDIA>
      <STAV_ZAPISU>zapsáno</STAV_ZAPISU>
      <STUDENT_NEMA_SEMINAR>1</STUDENT_NEMA_SEMINAR>
      <STUDIA>
       <STUDIUM_IDENTIFIKACE>FI C-CV EL celoživ.</STUDIUM_IDENTIFIKACE>
       ...
      </STUDIA>
      <UCO>172888</UCO>
      <UKONCENI>z</UKONCENI>
     </STUDENT>
     <STUDENT>
      ...
     </STUDENT>
    </PREDMET_STUDENTI_INFO>

    Operace seminar-seznam

    Vrátí XML se studenty, kteří jsou zapsáni ve vybraném semináři.

    Povinný parametrVýznam
    seminar Hodnotou je označení semináře. Lze zadat i více hodnot parametru seminar, např. ?seminar=prvni_ozn;seminar=druhe_ozn.
    Tip: Označení semináře lze zjistit pomocí operace predmet-info.
    Nepovinný parametrVýznam
    vcukonc Pokud je nastaveno na „a“, do výstupu budou zahrnuti i studenti, kteří mají ukončené studium.
    vcneaktiv Pokud je nastaveno na „a“, do výstupu budou zahrnuti i studenti, kteří mají neaktivní studium.

    Příklad požadavku:
    Pozor! Příklad je čistě ukázkový, nelze jej použít, neboť neobsahuje platný klíč.

    https://is.muni.cz/export/pb_blok_api?klic=VasVytvorenyKlic;fakulta=1433;kod=Etech69;operace=seminar-seznam;seminar=01;vcukonc=a;vcneaktiv=a

    Příklad výstupu:

    <SEMINAR_STUDENTI_INFO>
     <SEMINAR>
      <OZNACENI>01</OZNACENI>
      <SEMINAR_ID>109252</SEMINAR_ID>
      <STUDENT>
       <CELE_JMENO>RNDr. Jaroslav Bayer</CELE_JMENO>
       <JMENO>Jaroslav</JMENO>
       <PRIJMENI>Bayer</PRIJMENI>
       <STAV_STUDIA>ukončené</STAV_STUDIA>
       <STUDIA>
        <STUDIUM_IDENTIFIKACE>FI B-AP BcAP (abs.) (ukonč.)</STUDIUM_IDENTIFIKACE>
        ...
       </STUDIA>
       <UCO>72873</UCO>
       <UKONCENI>z</UKONCENI>
      </STUDENT>
      <STUDENT>
       ...
      </STUDENT>
     </SEMINAR>
      ...
    </SEMINAR_STUDENTI_INFO>
    Stavový kód HTTPVýznam chyby/Zobrazovaný text v XMLPřípadný podrobnější popis chyby
    403 Nebyl zadán povinný parametr, který vyžaduje zvolená operace. Povinný parametr je seminar
    404 Nebyl nalezen semiář se zkratkou $seminar.

    Operace seminar-cvicici-seznam

    Vrátí XML se cvičícími, kteří vedou vybrané semináře.

    Povinný parametrVýznam
    seminar Hodnotou je označení semináře. Lze zadat i více hodnot parametru seminar, např. ?seminar=prvni_ozn;seminar=druhe_ozn.
    Tip: Označení semináře lze zjistit pomocí operace predmet-info.

    Příklad požadavku:
    Pozor! Příklad je čistě ukázkový, nelze jej použít, neboť neobsahuje platný klíč.

    https://is.muni.cz/export/pb_blok_api?klic=VasVytvorenyKlic;fakulta=1433;kod=Etech69;operace=seminar-cvicici-seznam;seminar=01;

    Příklad výstupu:

    <SEMINAR_CVICICI_INFO>
     <SEMINAR>
      <CVICICI>
       <CELE_JMENO>RNDr. Mgr. Jaroslav Bayer</CELE_JMENO>
       <JMENO>Jaroslav</JMENO>
       <PRIJMENI>Bayer</PRIJMENI>
       <UCO>72873</UCO>
      </CVICICI>
      <CVICICI>
       ...
      </CVICICI>
      <OZNACENI>01</OZNACENI>
      <SEMINAR_ID>123456</SEMINAR_ID>
     </SEMINAR>
     ...
    </SEMINAR_CVICICI_INFO>
    Stavový kód HTTPVýznam chyby/Zobrazovaný text v XMLPřípadný podrobnější popis chyby
    403 Nebyl zadán povinný parametr, který vyžaduje zvolená operace. Povinný parametr je seminar
    404 Nebyl nalezen semiář se zkratkou $seminar.

    Operace bloky-seznam

    Vrátí XML s informacemi o všech poznámkových blocích předmětu.

    Příklad požadavku:
    Pozor! Příklad je čistě ukázkový, nelze jej použít, neboť neobsahuje platný klíč.

    https://is.muni.cz/export/pb_blok_api?klic=VasVytvorenyKlic;fakulta=1433;kod=Etech69;operace=bloky-seznam

    Příklad výstupu:

    <POZN_BLOKY_INFO>
     <POZN_BLOK>
      <BLOK_ID>440720</BLOK_ID>
      <JMENO>Test X</JMENO>
      <NEDOPLNOVAT_CHYBEJICI_STUDIA>a</NEDOPLNOVAT_CHYBEJICI_STUDIA>
      <STUDENTOVI_ZOBRAZIT_STATISTIKU>a</STUDENTOVI_ZOBRAZIT_STATISTIKU>
      <STUDENT_SMI_NAHLIZET>a</STUDENT_SMI_NAHLIZET>
      <TYP_ID>1</TYP_ID>
      <TYP_NAZEV>obecný blok</TYP_NAZEV>
      <ZKRATKA>tst_x</ZKRATKA>
      <ZMENENO>20160112115151</ZMENENO>
      <ZMENIL>395879</ZMENIL>
     </POZN_BLOK>
     <POZN_BLOK>
      ...
     </POZN_BLOK>
    </POZN_BLOKY_INFO>

    Operace blok-novy

    Založí nový poznámkový blok v příslušném předmětu.

    Povinný parametrVýznam
    jmeno Hodnotou je jméno nového poznámkového bloku. Toto jméno nesmí v rámci předmětu již existovat, v opačném případě vrátí operace chybu.
    zkratka Hodnotou je zkratka nového poznámkového bloku. Tato zkratka nesmí v rámci předmětu již existovat, v opačném případě vrátí operace chybu. Zkratka musí být zadána malými písmeny, číslicemi nebo podtržítkem. Některé prefixy jsou rezervovány pro automaticky vytvářené bloky (prez_, ode_, b_, p_, t_). V případě užití nepovolených znaků vrátí operace chybu. Další variantou nepovolených znaků je tato chyba.
    Nepovinný parametrVýznam
    nahlizi Není-li parametr uveden, nebo je jeho hodnota rovna „a“, pak student smí nahlížet do poznámkového bloku.
    nedoplnovat Není-li parametr uveden, nebo je jeho hodnota rovna „a“, pak při validaci bloku nejsou doplňována chybějící studia.
    statistika Není-li parametr uveden, nebo je jeho hodnota rovna „a“, pak student smí zobrazit statistiku poznámkového bloku.

    Příklad požadavku:
    Pozor! Příklad je čistě ukázkový, nelze jej použít, neboť neobsahuje platný klíč.

    https://is.muni.cz/export/pb_blok_api?klic=VasVytvorenyKlic;fakulta=1433;kod=Etech69;operace=blok-novy;jmeno=Nový poznámkový blok;zkratka=blok4

    Úspěšné vytvoření bloku vrátí XML ve tvaru:

    <BLOK_NOVY>Úspěšně uloženo.</BLOK_NOVY>
    Stavový kód HTTPVýznam chyby/Zobrazovaný text v XMLPřípadný podrobnější popis chyby
    403 Nebyl zadán povinný parametr, který vyžaduje zvolená operace. Povinné parametry jsou jmeno a zkratka
    404 Zkratka 'nazev_zkratky' obsahuje nepovolený znak. Smíte použít pouze malá písmena anglické abecedy, číslice a podtržítko.
    404 Zkratka nesmí začínat číslicí ani podtržítkem.
    409 Jméno poznámkového bloku musí být unikátní.
    409 Zkratka poznámkového bloku musí být unikátní.

    Operace blok-pis-student-obsah

    Vloží nebo změní obsah poznámkového bloku konkrétnímu studentovi.

    Povinný parametrVýznam
    zkratka Hodnotou je zkratka poznámkového bloku, jehož obsah chcete měnit.
    uco Hodnotou je učo studenta, jehož výsledky chcete měnit.
    obsah Konkrétní text, který chcete přiřadit studentovi do poznámkového bloku.
    Nepovinný parametrVýznam
    poslzmeneno Hodnotou je datum ve tvaru „YYYYMMDDHH24MISS“ (například 1. září 2016 v 18 hodin 10 minut 30 sekund vložíte jako „20160901181030“). Toto datum určuje poslední předpokládanou změnu záznamu. Pokud se liší hodnota poslzmeneno a datum poslední změny záznamu, obsah poznámkového bloku se nepřepíše. V takovém případě operace vrátí chybu. Pokud při použití poslzmeneno neexistuje v databázi záznam, je vrácena chyba.
    Tip: Potřebnou hodnotu parametru poslzmeneno (též ve formátu „YYYYMMDDHH24MISS“) získáte pomocí operace blok-dej-obsah.
    prepis Pokud je nastaveno na „a“, operace vloží nebo přepíše obsah poznámkového bloku bez ohledu na původní obsah a parametr poslzmeneno.

    Operace blok-pis-student-obsah umí pracovat ve dvou „režimech“:

    1. Pokud nechci řešit případný obsah poznámkového bloku ani souběh, ale pouze vždy zapsat moje data, doplním ke každému volání operace blok-pis-student-obsah parametr ?prepis=a.
    2. Pokud se chci vyhnout přepsání neznámého obsahu nebo souběhu, volám operaci blok-pis-student-obsah:
      • bez parametrů poslzmeneno a prepis pro iniciální naplnění dosud neexistujícího záznamu studentova poznámkového bloku,
      • s parametrem poslzmeneno, který udává datum poslední změny.
      V tomto případě budu informován, pokud stav poznámkového bloku je jiný, než jsem očekával.

    Stavový kód HTTPVýznam chyby/Zobrazovaný text v XMLPřípadný podrobnější popis chyby
    403 Nebyl zadán povinný parametr, který vyžaduje zvolená operace. Povinné parametry jsou zkratka, uco a obsah.
    403 Parametr "parametr" byl zadán vícekrát. Upozorňujeme na násobnost parametrů zkratka, uco a obsah.
    404 Neexistující poznámkový blok nebo nepovolený typ bloku.
    404 Student neexistuje, nebo nemá předmět zapsaný.
    404 Pro zvolený poznámkový blok a vybranou osobu neexistuje záznam.
    409 Datum změny záznamu neodpovídá datu v parametru.
    409 Pro zvolený poznámkový blok a vybranou osobu již existuje záznam.

    Příklad požadavku:
    Pozor! Příklad je čistě ukázkový, nelze jej použít, neboť neobsahuje platný klíč ani existující poznámkový blok.

    https://is.muni.cz/export/pb_blok_api?klic=VasVytvorenyKlic;fakulta=1433;kod=Etech69;operace=blok-pis-student-obsah;zkratka=TestAPI;uco=395879;obsah=10 bodů;poslzmeneno=20160201102035

    Pokud provedete operaci bez parametrů poslzmeneno a prepis s hodnotou a, pak pokud není u studenta v poznámkovém bloku záznam, obsah bude vložen. V opačném případě operace nic neuloží a vrátí se chyba:

    409 – Pro zvolený poznámkový blok a vybranou osobu již existuje záznam.

    Po úspěšném vložení nebo změně obsahu poznámkového bloku je vráceno potvrzující XML ve tvaru:

    <ZAPIS>Úspěšně uloženo.</ZAPIS>

    API umožňuje upravit pouze obsahy poznámkových bloků obecného typu, tzn. nelze jím upravit například obsahy autosumarizačních bloků.
    Pokud ke zvolenému předmětu neexistuje poznámkový blok s požadovanou zkratkou nebo blok existuje, ale je nepovoleného typu, pak je vrácena chyba:

    404 – Neexistující poznámkový blok nebo nepovolený typ bloku.

    Operace terminy

    Vrátí XML s informacemi o zkušebních termínech.

    Příklad požadavku:
    Pozor! Příklad je čistě ukázkový, nelze jej použít, neboť neobsahuje platný klíč.

    https://is.muni.cz/export/pb_blok_api?klic=VasVytvorenyKlic;fakulta=1433;kod=Etech69;operace=terminy

    Příklad výstupu:

    <TERMINY>
     <SERIE>
      <ID>27935</ID>
      <NAZEV>zkušební termíny</NAZEV>
      <TERMIN>
        <ID>66073</ID>
        <KAPACITA>123</KAPACITA>
        <KONANI>20150710133500</KONANI>
        <OPRAVNY>ak</OPRAVNY>
        <PRIHLASENY_TENTO>1</PRIHLASENO_TENTO>
        <RADNY>a</RADNY>
        <SPECIALNI/>
        <UCEBNA>A112</UCEBNA>
        <VC_NEAKTIVNICH/>
        <ZAPISUJE_SE>a</ZAPISUJE_SE>
      </TERMIN>
      ...
     </SERIE>
      ...
     </TERMINY>

    Operace terminy-seznam

    Vrátí XML s informacemi o zkušebních termínech a přihlášených studentech.

    Nepovinný parametrVýznam
    vcukonc Pokud je nastaveno na „a“, do výstupu budou zahrnuti i studenti, kteří mají ukončené studium.
    vcneaktiv Pokud je nastaveno na „a“, do výstupu budou zahrnuti i studenti, kteří mají neaktivní studium.

    Příklad požadavku:
    Pozor! Příklad je čistě ukázkový, nelze jej použít, neboť neobsahuje platný klíč.

    https://is.muni.cz/export/pb_blok_api?klic=VasVytvorenyKlic;fakulta=1433;kod=Etech69;operace=terminy-seznam

    Příklad výstupu:

    <TERMINY>
     <SERIE>
      <ID>27935</ID>
      <NAZEV>zkušební termíny</NAZEV>
      <TERMIN>
        <ID>66073</ID>
        <KAPACITA>123</KAPACITA>
        <KONANI>20150710133500</KONANI>
        <OPRAVNY>ak</OPRAVNY>
        <PRIHLASENY_TENTO>1</PRIHLASENO_TENTO>
        <RADNY>a</RADNY>
        <SPECIALNI/>
        <STUDENT>
        <CELE_JMENO>Mgr. Ondrej Šebela</CELE_JMENO>
        <JMENO>Ondrej</CELE_JMENO>
        <PRIJMENI>Šebela</PRIJMENI>
        <STAV_STUDIA>aktivní</STAV_STUDIA>
        <STUDIA>
         <STUDIUM_IDENTIFIKACE>FI C-CV EL celoživ.</STUDIUM_IDENTIFIKACE>
        </STUDIA>
        <UCO>172888</UCO>
        <UKONCENI>z</UKONCENI>
        </STUDENT>
        <UCEBNA>A112</UCEBNA>
        <VC_NEAKTIVNICH/>
        <ZAPISUJE_SE>a</ZAPISUJE_SE>
      </TERMIN>
      ...
     </SERIE>
      ...
     </TERMINY>

    Operace terminy-seznam-omez

    Vrátí XML s informacemi o zkušebních termínech a přihlášených studentech, kteří splňují podmínku.

    Povinný parametrVýznam
    zkratka Hodnotou je zkratka poznámkového bloku, podle kterého se omezí výběr.
    podminka || podminka_neg Nemůže být zároveň podmínka a podmínka_neg! Podminka_neg je negace podminka. Hodnotou může být číslo, pokud má být obsah poznámkového bloku větší/menší, nebo slovo, které má/nemá obsah poznámkového bloku obsahovat.
    Nepovinný parametrVýznam
    vcukonc Pokud je nastaveno na „a“, do výstupu budou zahrnuti i studenti, kteří mají ukončené studium.
    vcneaktiv Pokud je nastaveno na „a“, do výstupu budou zahrnuti i studenti, kteří mají neaktivní studium.
    zareg Pokud je nastaveno na „a“, do výstupu budou zahrnuti i studenti, kteří mají předmět pouze zaregistrovaný (nemají jej zapsaný).

    Příklad požadavku:
    Pozor! Příklad je čistě ukázkový, nelze jej použít, neboť neobsahuje platný klíč.

    https://is.muni.cz/export/pb_blok_api?klic=VasVytvorenyKlic;fakulta=1433;kod=Etech69;operace=terminy-seznam-omez;podminka=10;zkratka=TestAPI

    Příklad výstupu:

    <TERMINY>
     <SERIE>
      <ID>27935</ID>
      <NAZEV>zkušební termíny</NAZEV>
      <TERMIN>
        <ID>66073</ID>
        <KAPACITA>123</KAPACITA>
        <KONANI>20150710133500</KONANI>
        <OPRAVNY>ak</OPRAVNY>
        <PRIHLASENY_TENTO>1</PRIHLASENO_TENTO>
        <RADNY>a</RADNY>
        <SPECIALNI/>
        <STUDENT>
        <CELE_JMENO>Mgr. Ondrej Šebela</CELE_JMENO>
        <JMENO>Ondrej</CELE_JMENO>
        <PRIJMENI>Šebela</PRIJMENI>
        <STAV_STUDIA>aktivní</STAV_STUDIA>
        <STUDIA>
         <STUDIUM_IDENTIFIKACE>FI C-CV EL celoživ.</STUDIUM_IDENTIFIKACE>
        </STUDIA>
        <UCO>172888</UCO>
        <UKONCENI>z</UKONCENI>
        </STUDENT>
        <UCEBNA>A112</UCEBNA>
        <VC_NEAKTIVNICH/>
        <ZAPISUJE_SE>a</ZAPISUJE_SE>
      </TERMIN>
      ...
     </SERIE>
      ...
     </TERMINY>
  • 3.Lze automatizovaně stahovat data z Odpovědníků?

    Stahování dat z Odpovědníků lze realizovat přes aplikaci pro pokročilý export, kterou lze spouštět z neosobního účtu. Aplikace pro automatizované stahování dat je určená zejména pro IT zdatnější uživatele, kteří chtějí data dál strojově zpracovávat (běžnému uživateli bude pravděpodobně více vyhovovat export přímo v aplikaci Odpovědníky, kde si podobu požadovaného výstupu může vyklikat a kde se nevyžadují žádné pokročilejší znalosti – viz nápověda Chci sebrané odpovědi dále sám zpracovávat – export odpovědí z odpovědníku).

    Aplikace pro automatizované stahování dat je dostupná na adrese:
    https://is.muni.cz/auth/elearning/test_export

    Pomocí této aplikace je možné exportovat data z jednoho odpovědníku (odkaz na odpovědník je jedním ze dvou povinných parametrů). Dostupný je export xml (průchody osob se zněním otázek), pdf (průchody osob se zněním otázek), simple (seznam osob se získanými body) a advance (odpovědi k jednotlivým otázkám). Další parametry (nepovinné), s jakými lze aplikaci volat, jsou popsány v nápovědě přímo v aplikaci (https://is.muni.cz/auth/elearning/test_export?help=1).

SbalitRozbalit

Nenašli jste odpověď? Pošlete nám svůj dotaz na istech(zavináč/atsign)fi(tečka/dot)muni(tečka/dot)cz.