Neplatné doklady ve formátu XML
Výstup z datábázi ve formátu XML je určený hlavně programátorům, kteří chtějí začlenit výsledky vyhledávání do svých vlastních programů (například automatická kontrola dokladu při zápisu čísla do formuláře, apod.). Oproti klasickému zobrazení dat je jednodušší a jednoznačnější. Při změně grafické podoby aplikace není potřeba přepracovávat program.
Tvar dotazu
Dotaz je potřeba odeslat na adresu https://aplikace.mvcr.cz/neplatne-doklady/doklady.aspx pomocí metody GET (dotaz je součásti url adresy). Dotaz musí obsahovat následující položky:
| Položka | Popis |
|---|---|
| dotaz | Obsahuje celé číslo dokladu. Případná série dokladu je uvedena buď na začátku nebo na konci čísla. Na velikosti písma nezáleží. Mezery, pomlčky a další podobné znaky program ignoruje. |
| doklad | Udává typ dokladu. Pro občanský průkaz se používá 0 (nula). Hodnota 4 znamená centrálně vydávaný cestovní pas (fialové barvy). Číslo 6 označuje zbrojní průkaz. |
Například https://aplikace.mvcr.cz/neplatne-doklady/doklady.aspx?dotaz=123456AB&doklad=0 určuje dotaz na občanský průkaz s číslem 123456 a sérii AB. Výsledek si můžete po kliknutí na odkaz prohlédnout ve většině www prohlížečů. V některých prohlížečích po kliknutí musíte ještě navíc zadat příkaz zobrazit zdroj.
Tvar odpovědi (nedojde-li k chybě)
<?xml version="1.0" ?>
<doklady_neplatne posl_zmena="den.měsíc.rok" pristi_zmeny="stručné upozornění">
<dotaz typ="typ dokladu" cislo="číslo dokladu" serie="série dokladu"/>
<odpoved aktualizovano="den.měsíc.rok" evidovano="ano/ne"
evidovano_od="den.měsíc.rok" />
</doklady_neplatne>
| Položka | Popis |
|---|---|
| posl_zmena | Datum poslední změny v programu (nikoli v datech) ve formátu „den.měsíc.rok“. Měsíc je číslo od 1 (leden) do 12 (prosinec). Okolo teček mohou a nemusí být mezery. |
| pristi_zmeny | Velmi krátké upozornění na případnou příští známou změnu v programu. |
| typ | Typ dokladu. Hodnota „OP“ se užívá pro občanský průkaz bez označení série (nový typ občanského průkazu). Hodnota „OPs“ označuje občanský průkaz obsahující sérii (starší typ občanského průkazu). Cestovní pas vydávaný centrálně (fialový pas) má označení „CD“. Pro případné jiné typy cestovních dokladů je rezervováno označení „CDj“. |
| cislo | Číslo dokladu (bez série). |
| serie | Případná série dokladu. Pokud se pro daný typ dokladu série nepoužívá, pak je atribitu serie přiřazena pomlčka (serie="-"). |
| aktualizovano | Datum poslední aktualizace seznamu dokladů (daného typu). Datum je ve formátu „den.měsíc.rok“, kde měsíc je číslo od 1 (leden) do 12 (prosinec). Okolo teček mohou a nemusí být mezery. |
| evidovano | Určuje, zda požadovaný doklad byl nalezen v evidenci neplatných dokladů. Může nabývat hodnot „ano“ (doklad byl nalezen v evidenci neplatných dokladů) nebo „ne“ (doklad není v evidenci neplatných dokladů). |
| evidovano_od | Datum, od kdy je daný doklad evidován jako neplatný. U řady dokladů tento údaj chybí. Datum je ve stejném formátu jako položka aktualizovano. |
| Upozornění: Pro případné české znaky je použito kódování UTF-8 (Unicode). Další informace k UTF-8 naleznete v příloze. | |
Tvar odpovědi s chybou
<?xml version="1.0" ?>
<doklady_neplatne posl_zmena="den.měsíc.rok" pristi_zmeny="stručné upozornění">
<chyba spatny_dotaz="ano/ne">text chyby</chyba>
</doklady_neplatne>
| Položka | Popis |
|---|---|
| posl_zmena | Datum poslední změny v programu (nikoli v datech) ve formátu „den.měsíc.rok“. Měsíc je číslo od 1 (leden) do 12 (prosinec). Okolo teček mohou a nemusí být mezery. |
| pristi_zmeny | Velmi krátké upozornění na případnou příští známou změnu v programu. |
| spatny_dotaz | Označuje, zda je jen dotaz položen špatně, nebo zda k chybě došlo přímo v programu. Nabývá hodnot „ano“ nebo „ne“. |
| text chyby | Popis chyby ve tvaru čitelném pro člověka. |
| Upozornění: Pro případné české znaky je použito kódování UTF-8 (Unicode). Další informace k UTF-8 naleznete v příloze. | |
Tvar čísel dokladů
- občanské průkazy bez série (novější typ)
Číslo dokladu je tvořeno devíti číslicemi, první z nich nesmí být nula. Doklad nemá sérii. - občanské průkazy se sérii (starší typ)
Číslo dokladu je tvořeno šesti číslicemi, může začínat nulou. Série je tvořena dvěma písmeny (bez háčku a čárek). Některé občanské však průkazy mohou mít sérii tvořenou dvěma písmeny a dvěma číslicemi (například AB01). Na velikosti písmen nezáleží. - cestovní pasy vydávané centrálně - „fialový pas“
Číslo dokladu je tvořeno osmi číslicemi, první z nich nesmí být nula. Doklad nemá sérii. Každé dva centrálně vydané cestovní pasy mají vždy různá čísla. - zbrojní průkazy / zbrojní licence
Číslo dokladu je tvořeno dvoumístným znakem série a šestimístným číslem, které může začínat i nulou.