Rozhraní pro výměnu dat o vzdělávacích akcích

Transkript

1 (Informačně poradenský systém) Verze června 2008 Konsorcium pro Informačně poradenský systém 2008 Konsorcium pro Informačně poradenský systém

2 Kontrola a schválení dokumentu Provedené revize Verze Autor Datum Revize 1.0 Tomáš Šafařík Jiří Skřivánek Jiří Skřivánek Tento dokument byl zkontrolován Tento dokument byl schválen Kontrolu provedl/a Datum kontroly Jméno Podpis Datum schválení i 2007 Konsorcium pro Informačně poradenský systém

3 Obsah Úvod 3 Seznam výsledků response data-provider course-list course occurrences occurrence 7 Komplexní dotaz query count-to-return Podmínka 8 Zjednodušený dotaz 10 Obecné poznámky o formátu datových položek 10 Číselníky 11 Tab. 1: číselník NUTS 3 (region). 11 Tab. 2: číselník LAU_OKRES (district) 11 Tab. 3: část tabulky z normy ISO (learning-language) 13 Tab. 4: Typ vzdělávací akce (Course-type) 13 Tab. 5: Forma výuky (study-type) 14 Tab. 6: Profesní obor (branch_id) 14 Tab. 7: Profese (profession_id) 16 Tab. 8.: Úroveň řízení (management_level_id) 16 Kontakty 16 ii 2007 Konsorcium pro Informačně poradenský systém

4 Úvod Tento dokument popisuje datové rozhraní pro výměnu informací o vzdělávacích kurzech. Datové rozhraní bylo připraveno Informačně-poradenský systém (IPSYS), projekt financovaný z prostředků ESF a MPSV. Popis formátu předávaných dat je ale obecný, nezávislý na konkrétní aplikaci. Navržený formát dat umožňuje výměnu informací (dotaz/odpověď) protokolem POX, případně předání kompletních dat (Upload). Výběr protokolu je závislý na aplikaci, tento dokument se jím proto podrobněji nezabývá. Popisuje především aplikačně nezávislý formát vyměňovaných dat: Zjednodušený dotaz (relevantní pouze pro metodu POX) Komplexní dotaz (relevantní pouze pro metodu POX) Seznam výsledků (relevantní pro POX i Upload) Data se předávají ve formátu XML. Přílohou tohoto dokumentu je definice XML formátu v souboru.dtd (Document Type Definition) a příklady: Data Formát Příklad Zjednodušený dotaz query.dtd simplequery.xml Komplexní dotaz query.dtd (stejný) complexquery.xml Seznam výsledků response.dtd response.xml Tento dokument dále popisuje podrobněji jednotlivé datové entity. V poslední kapitole najde čtenář přehled použitých číselníků. XML formát byl odvozen od formátu pro výměnu informací o vzdělávacích kurzech, který vznikl v rámci projektu PLOTEUS. 3

5 Seznam výsledků Seznam výsledků obsahuje popis vyhledaných kurzů, případně metadata kompletní databáze kurzů. Soubor obsahuje tyto hlavní elementy: response data-provider course-list error course occurrences occurrence 1.1 response Každý soubor začíná kořenovým elementem response. Má tyto atributy: Atribut Popis Povinný Formát version Číslo verze formátu. Ano Zatím vždy 1.0 created Datum vytvoření souboru Ano hh.mm.ss dd.mm.yyyy course-count Počet kurzů vyhovujících dotazu Ano Číslo retcode Návratový kód Ano 0 proběhlo v pořádku Element response obsahuje tyto podřízené elementy: data-provider (povinný) course-list (musí být uveden jeden z elementů: course-list nebo error) error Jiné číslo chyba. 1.2 data-provider Element nese textový popis tvůrce XML dokumentu. 4

6 Atribut Popis Povinný Formát ic Identifikační číslo organizace. Ano číslo 1.3 course-list Element course-list obsahuje seznam kurzů. Vyskytuje se v odpovědi v případě, že dotaz byl úspěšně zpracován. Parametr response.retcode nese hodnotu 0. Atribut Popis Povinný Formát returned-course-count Počet skutečně předávaných kurzů. Může se lišit od atributu response.coursecount, který obsahuje počet všech nalezených kurzů. Aplikace se může na základě dotazu nebo podle své vlastní politiky rozhodnout, že nepředá všechny kurzy, pokud je seznam příliš obsáhlý. Ano číslo Element obsahuje seznam elementů course. 1.4 course Element course popisuje jeden konkrétní kurz. Kurzem se rozumí vzdělávací akce jednotným obsahem, která se může konat na různých místech v různých termínech. Vlastnosti kurzu společné pro všechny termíny jsou popsány těmito elementy: Název Popis Povinný Povinný formát Formát title Název kurzu ANO NE course-id Identifikace kurzu vzdělavatelem NE NE course-type Typ vzdělávací akce NE ANO Číselník 5

7 Rozsah kurzu (v hodinách) NE ANO Číslo description Bližší popis kurzu NE NE branch-id profession-id durationinformation managementlevel-id Kód oboru, pro který je daný kurz určen Kód profese, pro kterou je kurz určen Kód úrovně řízení, pro kterou je kurz určen NE ANO Číselník NE ANO Číselník NE ANO Číselník provider-name Název vzdělavatele NE NE provider-id Jednoznačný identifikátor vzdělavatele na straně poskytovatele dat NE NE provider-ic Identifikační číslo vzdělavatele NE ANO Číslo grants Je kurz dotován NE ANO A/N certification Je kurz certifikován NE ANO A/N accreditation Je kurz akreditován NE ANO A/N study-type Forma výuky kurzu NE ANO Číselník specific-targetgroup Popis skupin osob, pro které je kurz vhodný NE NE occurrences Informace o jednotlivých termínech kurzu. ANO ANO Složený element 1.5 occurrences Element occurrences obsahuje seznam jednotlivých termínů kurzu. Termín je popsán elementem occurrence. 6

8 1.6 occurrence Element occurrence popisuje jeden termín kurzu jedno konání kurzu na určitém místě v určitém čase. Obsahuje pouze specifické informace pro termín. Společné informace pro celý kurz obsahuje element course. Vlastnosti termínu jsou popsány těmito elementy: Název Popis Povinný Povinný formát Formát start-date Začátek výuky kurzu NE ANO dd.mm.yyyy end-date Konce výuky kurzu NE ANO dd.mm.yyyy region Kraj, ve kterém se kurz koná region nebo district ANO Číselník NUTS-3 district Okres, ve kterém se kurz koná region nebo district ANO Číselník OKRES_LAU location Bližší popis místa konání kurzu NE NE learninglanguage Jazyk kurzu NE ANO Zkratka podle formátu ISO cost Cena kurzu v Kč NE NE free-places url Počet volných míst v kurzu Odkaz na bližší informace o kurzu NE ANO Číslo ANO ANO Odkaz Komplexní dotaz 1.7 query Komplexní dotaz popisuje podmínku pro vyhledání kurzů. Skládá se z těchto elementů: Kořenový element dotazu. Obsahuje tyto atributy: Atribut Popis Povinný Formát 7

9 version Číslo verze formátu. Ano Zatím vždy 1.0 created Datum vytvoření souboru Ano hh.mm.ss dd.mm.yyyy type Typ dotazu Ano complex/simple Obsahuje dva elementy: count-to-return Podmínka (textová nebo logická) 1.8 count-to-return Obsahuje číslo, které omezuje počet vrácených kurzů. 1.9 Podmínka Podmínku tvoří kombinace terminálních podmínek a logických podmínek. Logické podmínky mohou obsahovat další podřízené elementy podmínky. Terminální podmínky vyjadřují omezení na datum, číslo nebo text. Nemohou obsahovat podřízené elementy. Terminální elementy mohou obsahovat atribut relation, který udává operátor porovnání. Elementy pro terminální podmínky: Název Popis obsahu Povinný formát Tvar povinného formátu Povolené operátory Implicitní hodnota course-type keyword start-date end-date Typ vzdělávací akce Klíčové slovo, které se hledá v názvu nebo v popisu kurzu. Datum začátku kurzu Datum konce kurzu ANO Číslo eq eq NE like like ANO dd.mm.yyyy lt,le,gt,ge,eq eq ANO dd.mm.yyyy lt,le,gt,ge,eq eq 8

10 region Kraj, ve kterém se má kurz vyskytovat ANO Číselník NUTS-3 eq eq district Okres, ve kterém se má kurz vyskytovat ANO Číselník OKRES_LAU eq eq branch-id profession-id Kód oboru, pro který je daný kurz určen Kód profese, pro kterou je kurz určen ANO Číselník eq eq ANO Číselník eq eq managementlevel-id Kód úrovně řízení, pro kterou je kurz určen ANO Číselník eq eq Operátor se zadává pomocí nepovinného atributu relation. Atribut relation může nabývat následující hodnoty (omezeno podle jednotlivých elementů): Název operátorů lt le gt ge eq like Význam Hodnota u kurzu je menší než hodnota v dotazu (podle povinného formátu: např. datum, text nebo číslo) Hodnota u kurzu je menší nebo rovna hodnotě v dotazu Hodnota u kurzu je větší než hodnota v dotazu Hodnota u kurzu je větší nebo rovna hodnotě v dotazu Hodnota u kurzu je rovna textové v dotazu Text v položce u kurzu obsahuje text zadaný v dotazu, nezáleží přitom na malých a velkých písmenech. Příklad: programování obsahuje text ÁNÍ. 9

11 V případě že atribut relation není zadán, tak se vyhledávání chová podle implicitní hodnoty u každého z atributů. Zjednodušený dotaz XML formát zjednodušeného dotazu vychází z formátu komplexního dotazu. Má ale omezenější vyjadřovací možnosti (proto je také snadněji implementovatelný). Od komplexního dotazu se odlišuje hodnotou atributu query.type=simple. Omezení spočívá v tom, že vyhledávací podmínka má fixní strukturu: Na první úrovni je element and. Pod ním následují v pevném pořadí tyto nepovinné elementy: o course-type o branch-id o profession-id o management-level-id o or spojuje několik elementů keyword o or obsahuje alespoň jeden z elementů region nebo district (kraj nebo okres, ve kterých se kurz má konat) o start-date o start-date Obecné poznámky o formátu datových položek Tato kapitola obsahuje informace o obecném formátu dat používaných při dotazech a odpovědích nad kurzy. Datum se posílá jako řetězec s následujícím formátem: dd.mm.rrrr. První dva znaky určují den, třetí je znak tečka, čtvrtý a pátý znak určují měsíc, šestý znak je opět tečka a sedmý až desátý znak nese informaci o roku. Například řetězec určuje Nový rok. Pro kódování krajů v dotazech a odpovědích se používá číselník krajů NUTS 3, bližší informace je možné nalézt na internetové stránce: Tabulka pro převod krajů na kódy se nachází v kapitole Přílohy. Pro kódování okresů v dotazech a odpovědích se používá číselník okresů OKRES_LAU, bližší informace je možné nalézt na internetové stránce: Tabulka pro převod okresů na kódy se nachází v kapitole Přílohy. 10

12 Číselníky Pro kódování jazyků se používá norma ISO Její vybranou část je možné nalézt v kapitole přílohy, celou pak na této internetové stránce: Pro kódování formy kurzu (element study-type) se použije číselník v tabulce 5. Pro určení kódu oboru kurzu (element branch-id) se použije tabulka číslo 6. Pro určení kódu profese (element profession-id) se použije tabulka 7. Pro určení kódu úrovně řízení, pro kterou je kurz určen (element management-level-id), se určí pomocí tabulky 8. Tab. 1: číselník NUTS 3 (region). CZ010 Hlavní město Praha CZ053 Pardubický kraj CZ020 Středočeský kraj CZ063 Vysočina CZ031 Jihočeský kraj CZ064 Jihomoravský kraj CZ032 Plzeňský kraj CZ071 Olomoucký kraj CZ041 Karlovarský kraj CZ072 Zlínský kraj CZ042 Ústecký kraj CZ080 Moravskoslezský kraj CZ051 Liberecký kraj CZZZZ Značení, že se nejedná ani o jeden z krajů (zahraničí). CZ052 Královéhradecký kraj Tab. 2: číselník LAU_OKRES (district) CZ0100 Praha CZ0513 Liberec CZ0201 Benešov CZ0514 Semily CZ0202 Beroun CZ0521 Hradec Králové CZ0203 Kladno CZ0522 Jičín 11

13 CZ0204 Kolín CZ0523 Náchod CZ0205 Kutná Hora CZ0524 Rychnov nad Kněžnou CZ0206 Mělník CZ0525 Trutnov CZ0207 Mladá Boleslav CZ0531 Chrudim CZ0208 Nymburk CZ0532 Pardubice CZ0209 Praha-východ CZ0533 Svitavy CZ020A Praha-západ CZ0534 Ústí nad Orlicí CZ020B Příbram CZ0631 Havlíčkův Brod CZ020C Rakovník CZ0632 Jihlava CZ0311 České Budějovice CZ0633 Pelhřimov CZ0312 Český Krumlov CZ0634 Třebíč CZ0313 Jindřichův Hradec CZ0635 Žďár nad Sázavou CZ0314 Písek CZ0641 Blansko CZ0315 Prachatice CZ0642 Brno-město CZ0316 Strakonice CZ0643 Brno-venkov CZ0317 Tábor CZ0644 Břeclav CZ0321 Domažlice CZ0645 Hodonín CZ0322 Klatovy CZ0646 Vyškov CZ0323 Plzeň-město CZ0647 Znojmo CZ0324 Plzeň-jih CZ0711 Jeseník CZ0325 Plzeň-sever CZ0712 Olomouc CZ0326 Rokycany CZ0713 Prostějov CZ0327 Tachov CZ0714 Přerov 12

14 CZ0411 Cheb CZ0715 Šumperk CZ0412 Karlovy Vary CZ0721 Kroměříž CZ0413 Sokolov CZ0722 Uherské Hradiště CZ0421 Děčín CZ0723 Vsetín CZ0422 Chomutov CZ0724 Zlín CZ0423 Litoměřice CZ0801 Bruntál CZ0424 Louny CZ0802 Frýdek-Místek CZ0425 Most CZ0803 Karviná CZ0426 Teplice CZ0804 Nový Jičín CZ0427 Ústí nad Labem CZ0805 Opava CZ0511 Česká Lípa CZ0806 Ostrava-město CZ0512 Jablonec nad Nisou Tab. 3: část tabulky z normy ISO (learning-language) cs sk en de fr Czech Slovak English German French Tab. 4: Typ vzdělávací akce (Course-type) Číselník vzdělávání byl navržen v rámci projektu Informačně-poradenský systém. Třídí vzdělávací kurzy, školení a další vzdělávací akce do základních skupin. Číselník vzdělávání je návrhem na sjednocení různých klasifikací vzdělávacích akcí, které používají vzdělavatelé ve svých katalozích nebo provozovatelé internetových portálů pro základní členění svých stránek. Pokud poskytovatel dat používá interně vlastní klasifikaci, musí připravit převodní tabulku. 13

15 Číselník Vzdělávání je v příloze Vzdelavani.xls. Tab. 5: Forma výuky (study-type) Kód Název 1 denní 2 prezenční 3 večerní 4 dálkové 5 distanční 6 kombinované 7 e-learning Tab. 6: Profesní obor (branch_id) Kód Popis 1 Administrativa, správní řízení 2 Bankovnictví, peněžnictví 3 Bezpečnost 4 Dobývání a úprava surovin, užitá geologie 5 Doprava a logistika 6 Dřevozpracující průmysl 7 Ekonomika 8 Elektrotechnika 9 Energetika 14

16 10 Chemie, plasty 11 Informační služby, publicistika 12 Informační technologie 13 Kožedělná výroba 14 Obchod, marketing 15 Ochrana životního prostředí 16 Papír, polygrafie, vydavatelství 17 Pohostinství, gastronomie, cest.ruch 18 Pojišťovnictví 19 Potravinářská výroba 20 Požární ochrana 21 Právní služby 22 Sklářská, keramická výroba 23 Služby 24 Sociální péče 25 Státní správa a samospráva 26 Stavebnictví 27 Strojírenství 28 Telekomunikace 29 Textilní výroba, oděvní výroba 30 Řemeslná výroba 31 Umění, kultura, sport 32 Věda a výzkum 15

17 33 Výchova, vzdělávání, lidské zdroje 34 Zdravotnictví, veterinářství, farmacie 35 Zemědělství, lesnictví, rybářství, vod.hosp. 36 nerozlišeno - ostatní Tab. 7: Profese (profession_id) Číselník profesí umožňuje přiřadit kurzy konkrétním profesím nebo profesním skupinám. Kurzy, které nemají žádnou profesi přiřazenou, se považují za profesně nezávislé. Používá se zjednodušený číselník profesí připravený v projektu Informačně-poradenský systém. Číselník profesí je v příloze Profese.xls. Tab. 8.: Úroveň řízení (management_level_id) Kód Popis 1 vrcholový management 2 střední management 3 prvoliniový management 4 specialista, odborník 5 samostatný pracovník 6 pracovník 7 ostatní Kontakty RNDr. Jiří Skřivánek analytik OKsystem s.r.o. Na Pankráci 125, Praha 4 tel

18 mobil: Tomáš Šafařík programátor OKsystem s.r.o. Na Pankráci 125, Praha 4 tel safarik@oksystem.cz 17