Datový standard MZČR

Webové služby pro distribuci číselníků - verze 4

Popis služeb


SadyXML.aspx

Vrací seznam dostupných sad v XML tvaru

Parametry:

Název parametru Hodnota Význam
Zdroj neuvedeno nebo 0 Sady NČLP, UZIS i DS, verze DTD a hypertextu
1 Pouze sady NČLP
2 Pouze sady ÚZIS
3 Pouze sady DS
10 Verze DTD
100 Verze hypertextu
Vystup neuvedeno nebo Z Zobrazit
F Uložit do souboru
F_ZIP Uložit do souboru a komprimovaně pomocí ZIP
PouzeAktualni neuvedeno nebo N Všechny sady
A Pouze aktuální sady

Výstup:

Hlavní blok SADY

Element/Atribut

Typ

Výskyt

Význam
SADY_NCLP

E

?

Sady NČLP
SADY_DS

E

?

Sady DS
SADY_UZIS E ? Sady UZIS
DTD

E

?

Verze DTD
HYPERTEXT

E

?

Verze hypertextu
dat_gen

A

1

Datum generování
cas_gen

A

1

Čas generování
uzivatel

A

1

Uživatel který výstup vygeneroval
status

A

1

Status generování
0 - generování proběhlo bez chyb
>=1 - při generování došlo k chybě
status_text

A

1

Status generování textově
OK - generování proběhlo bez chyb
jinak text chyby

Blok SADY_NCLP

Element/Atribut

Typ

Výskyt

Význam
SADA_NCLP

E

+

Sada NČLP

Blok SADA_NCLP

Element/Atribut

Typ

Výskyt

Význam
id_sady_nclp

A

1

Číslo sady NČLP
ver_nclp

A

1

Verze NČLP
ver_ds

A

1

Verze DS
platnost_od

A

1

Platnost od
platnost_do

A

?

Platnost do
aktualni

A

?

A - sada je aktuální

Blok SADY_DS

Element/Atribut

Typ

Výskyt

Význam
SADA_DS

E

+

Sada DS

Blok SADA_DS

Element/Atribut

Typ

Výskyt

Význam
id_sady_ds

A

1

Číslo sady DS
ver_nclp

A

1

Verze NČLP
ver_ds

A

1

Verze DS
platnost_od

A

1

Platnost od
platnost_do

A

?

Platnost do
aktualni

A

?

A - sada je aktuální

Blok SADY_UZIS

Element/Atribut

Typ

Výskyt

Význam
SADA_UZIS

E

+

Sada UZIS

Blok SADA_UZIS

Element/Atribut

Typ

Výskyt

Význam
id_sady_uzis

A

1

Číslo sady UZIS
ver_nclp

A

1

Verze NČLP
ver_ds

A

1

Verze DS
uzis_verze

A

1

Verze UZIS
platnost_od

A

1

Platnost od
platnost_do

A

?

Platnost do
aktualni

A

?

A - sada je aktuální

Blok DTD

Element/Atribut

Typ

Výskyt

Význam
VERZE_DTD

E

+

Verze DTD

Blok VERZE_DTD

Element/Atribut

Typ

Výskyt

Význam
Dtd

A

1

Číslo sady DTD
ver_ds

A

1

Verze DS
platnost_od

A

1

Platnost od
platnost_do

A

?

Platnost do
aktualni

A

?

A - sada je aktuální

Blok HYPERTEXT

Element/Atribut

Typ

Výskyt

Význam
VERZE_HYPERTEXT

E

+

Verze hypertextu

Blok VERZE_ HYPERTEXT

Element/Atribut

Typ

Výskyt

Význam
Hypertext

A

1

Číslo verze hypertextu
ver_ds

A

1

Verze DS
platnost_od

A

1

Platnost od
platnost_do

A

?

Platnost do
aktualni

A

?

A - sada je aktuální
url

A

1

URL odkaz na úvodní stránku hypertextu
url_zip A 1 URL odkaz na hypertext ke stažení jako ZIP

Příklad:
SadyXML.aspx?PouzeAktualni=A
Vrátí informace o aktuální sadě číselníků a zobrazí je.


ObsahXML.aspx

Vrací obsah jednoho číselníku v XML tvaru

Parametry :

Název parametru Hodnota Význam
Ciselnik řetězec Název číselníku jehož obsah má být vrácen
IdSadyNclp číslo Číslo sady číselníků NČLP která se má využít
neuvedeno Použije se aktuální sada číselníků NČLP
IdSadyDs číslo Číslo sady číselníků DS která se má využít
neuvedeno Použije se aktuální sada číselníků DS
IdSadyUzis číslo Číslo sady číselníků ÚZIS která se má využít
neuvedeno Použije se aktuální sada číselníků ÚZIS
IdSadyNclpPorovnej číslo Číslo sady číselníků NČLP které se využije pro porovnání - vrátí se změny proti této sadě
neuvedeno Porovnávat se nebude - vrátí se celý číselník
IdSadyDsPorovnej číslo Číslo sady číselníků DS které se využije pro porovnání - vrátí se změny proti této sadě
neuvedeno Porovnávat se nebude - vrátí se celý číselník
IdSadyUzisPorovnej číslo Číslo sady číselníků ÚZIS které se využije pro porovnání - vrátí se změny proti této sadě
neuvedeno Porovnávat se nebude - vrátí se celý číselník
Vystup neuvedeno nebo Z Zobrazit
F Uložit do souboru
F_ZIP Uložit do souboru a komprimovaně pomocí ZIP
Data neuvedeno nebo 4 Formát DS 4
A Formát DS 3 - hodnoty číselníku budou uloženy jako atributy elementu VETA
E Formát DS 3 - hodnoty číselníku budou uloženy jako elementy elementu VETA
Rozsireni A Záhlaví číselníku v XML souboru bude rozšířeno o informaci o sadě a stavu
neuvedeno nebo N Záhlaví číselníku v XML souboru nebude rozšířeno o informaci o sadě a stavu - číselník bude shodný s číselníkem generovaným z SLP/ČLP
HodnotaKlic řetězec Hodnota pro klíč - pokud je uvedena, vrátí se pouze jeden záznam odpovídající tomuto klíči. Pokud je klíčů více (složený klíč), oddělují se hodnoty pro jednotlivé klíče čárkou
neuvedeno Vrátí se celý číselník (bez filtru na klíč)
Aktual neuvedeno nebo V Vrátí všechny hodnoty
A Vrátí pouze aktuální hodnoty
N Vrátí pouze neaktuální hodnoty

Výstup:

Výstupem je číselník je stejném tvaru v jakém je distribuován na CD DS.
Kořenový blok číselníku je doplněn o následující atributy (pokud není ve volání uvedeno Rozsireni=N):

Element/Atribut

Typ

Výskyt

Význam
status

A

1

Status generování
0 - generování proběhlo bez chyb
>=1 - při generování došlo k chybě
status_text

A

1

Status generování textově
OK - generování proběhlo bez chyb
jinak text chyby
id_sady_nclp

A

?

Číslo sady číselníků NČLP (pro číselníky NČLP)
id_sady_ds A ? Číslo sady číselníků DS (pro číselníky DS)
id_sady_uzis

A

?

Číslo sady číselníků UZIS (pro číselníky UZIS)
id_sady_nclp_zmena

A

?

Číslo sady číselníků NČLP, ve které došlo naposledy ke změně v tomto číselníku (pro číselníky NČLP) 
id_sady_ds_zmena A ? Číslo sady číselníků DS, ve které došlo naposledy ke změně v tomto číselníku (pro číselníky DS)
id_sady_uzis_zmena

A

?

Číslo sady číselníků UZIS, ve které došlo naposledy ke změně v tomto číselníku (pro číselníky UZIS) 

Pokud se provádí porovnání (je uvedeno IdSadyNclpPorovnej nebo IdSadyUzisPorovnej), jsou bloky VETA číselníku doplněny o atribut:

Element/Atribut

Typ

Výskyt

Význam
typ_zmeny

A

?

Typ změny
"-" - věta byla v číselníku vymazána
"+" - věta byla do číselníku přidána
"x" - věta byla v číselníku změněna

Příklad:
ObsahXML.aspx?Ciselnik=ODDEL&Data=A&Vystup=Z&Rozsireni=A&IdSadyUzisPorovnej=200430
Vrátí rozdíly v obsahu číselníku ODDEL - porovná aktuální sadu se sadou 200430. Hodnoty budou uvedeny jako atributy, výstup bude na obrazovku, do XML budou přidány informace o sadě a stavu.


ObsahXMLMulti.aspx

Vrací obsah více číselníků v XML tvaru

Parametry :

Název parametru Hodnota Význam
Ciselniky řetězec Seznam číselníků jejichž obsah má být vrácen. Číselníky se oddělují čárkou
1 Vrátí všechny číselníky NČLP
2 Vrátí všechny číselníky ÚZIS
IdSadyNclp číslo Číslo sady číselníků NČLP která se má využít
neuvedeno Použije se aktuální sada číselníků NČLP
IdSadyDs číslo Číslo sady číselníků DS která se má využít
neuvedeno Použije se aktuální sada číselníků DS
IdSadyUzis číslo Číslo sady číselníků ÚZIS která se má využít
neuvedeno Použije se aktuální sada číselníků ÚZIS
IdSadyNclpPorovnej číslo Číslo sady číselníků NČLP které se využije pro porovnání - vrátí se změny proti této sadě
neuvedeno Porovnávat se nebude - vrátí se celý číselník
IdSadyDsPorovnej číslo Číslo sady číselníků DS které se využije pro porovnání - vrátí se změny proti této sadě
neuvedeno Porovnávat se nebude - vrátí se celý číselník
IdSadyUzisPorovnej číslo Číslo sady číselníků ÚZIS které se využije pro porovnání - vrátí se změny proti této sadě
neuvedeno Porovnávat se nebude - vrátí se celý číselník
Vystup neuvedeno nebo Z Zobrazit
F Uložit do souboru
F_ZIP Uložit do souboru a komprimovaně pomocí ZIP
Data neuvedeno nebo 4 Formát DS 4
A Formát DS 3 - hodnoty číselníku budou uloženy jako atributy elementu VETA
E Formát DS 3 - hodnoty číselníku budou uloženy jako elementy elementu VETA
Rozsireni A Záhlaví číselníku v XML souboru bude rozšířeno o informaci o sadě a stavu
neuvedeno nebo N Záhlaví číselníku v XML souboru nebude rozšířeno o informaci o sadě a stavu - číselník bude shodný s číselníkem generovaným z SLP/ČLP
IPrazdne neuvedeno nebo A Vrátí i prázdné číselníky
N Prázdné číselníky budou vynechány
Aktual neuvedeno nebo V Vrátí všechny hodnoty
A Vrátí pouze aktuální hodnoty
N Vrátí pouze neaktuální hodnoty

Výstup:

Výstup je totožný s výstupem služby ObsahXML.aspx

Příklad:
ObsahXMLMulti.aspx?Ciselniky=1,AGENS,ANAMNEZA,ANONE&IdSadyUzis=200440&Data=E&Vystup=F_ZIP&Rozsireni=A&IPrazdne=N
Vrátí obsah číselníků AGENS,ANAMNEZA,ANONE a všech číselníků NČLP. Pro číselníky ÚZIS se použije sada 200440, pro číselníky NČLP aktuální sada. Hodnoty budou uvedeny jako elementy, výstup bude do souboru ZIP, do XML budou přidány informace o sadě a stavu, prázdné číselníky nebudou vráceny.


PrehledCiselnikuXML.aspx

Vrací seznam dostupných číselníků v XML tvaru

Parametry :

Název parametru Hodnota Význam
Ciselniky řetězec Seznam číselníků jejichž seznam má být vrácen. Číselníky se oddělují čárkou
1 Vrátí přehled všech číselníků NČLP
2 Vrátí přehled všech číselníků ÚZIS
3 Vrátí přehled všech číselníků DS
neuvedeno Vrátí přehled všech číselníků
IdSadyNclp číslo Číslo sady číselníků NČLP která se má využít
neuvedeno Použije se aktuální sada číselníků NČLP
IdSadyDs číslo Číslo sady číselníků DS která se má využít
neuvedeno Použije se aktuální sada číselníků DS
IdSadyUzis číslo Číslo sady číselníků ÚZIS která se má využít
neuvedeno Použije se aktuální sada číselníků ÚZIS
Vystup neuvedeno nebo Z Zobrazit
F Uložit do souboru - výstup bude uložen do souboru TXT - jednotlivé číselníky v XML za sebou
F_ZIP Uložit do souboru a komprimovaně pomocí ZIP

Výstup:

Hlavní blok DSCIS_PREHLED

Element/Atribut

Typ

Výskyt

Význam
CISELNIK

E

*

Popis číselníku
dat_gen

A

1

Datum generování
cas_gen

A

1

Čas generování
uzivatel

A

1

Uživatel který výstup vygeneroval
status

A

1

Status generování
0 - generování proběhlo bez chyb
>=1 - při generování došlo k chybě
status_text

A

1

Status generování textově
OK - generování proběhlo bez chyb
jinak text chyby

Blok CISELNIK

Element/Atribut

Typ

Výskyt

Význam
Nazev

A

1

Název číselníku
Popis

A

1

Popis číselníku
id_sady_nclp

A

?

Číslo sady číselníků NČLP (pro číselníky NČLP)
id_sady_ds A ? Číslo sady číselníků DS (pro číselníky DS)
id_sady_uzis

A

?

Číslo sady číselníků UZIS (pro číselníky UZIS)
id_sady_nclp_zmena

A

?

Číslo sady číselníků NČLP, ve které došlo naposledy ke změně v tomto číselníku (pro číselníky NČLP) 
id_sady_ds_zmena A ? Číslo sady číselníků DS, ve které došlo naposledy ke změně v tomto číselníku (pro číselníky DS)
id_sady_uzis_Zmena

A

?

Číslo sady číselníků UZIS, ve které došlo naposledy ke změně v tomto číselníku (pro číselníky UZIS) 
Zdroj

A

1

Zdroj - 1 - číselníky NČLP, 2 - číselníky UZIS, 3 - číselníky DS
ZdrojNazev

A

1

Zdroj textově
Aktualizace

A

1

Datum aktualizace číselníků ve webové službě
ver_nclp

A

1

Verze NČLP
ver_ds

A

1

Verze DS
uzis_verze

A

?

Verze UZIS
platnost_od

A

1

Platnost od
platnost_do

A

?

Platnost do

Příklad:
PrehledCiselnikuXML.aspx
Vrátí přehled všech dostupných číselníků pro aktuální sadu.


Dtd.aspx

Vrací jednoho nebo více DTD

Parametry :


Název parametru Hodnota Význam
Dtd řetězec Seznam verzí DTD které mají být vráceny. Jednotlivé verze se oddělují čárkou
0 Vrátí všechny verze DTD
neuvedeno Vrátí aktuální verzi DTD
Vystup neuvedeno nebo Z Zobrazit
F Uložit do souboru - pokud je požadována pouze jedna verze, bude výstup uložen do souboru DTD, pokud bude požadováno více verzí, výstup bude uložen do souboru TXT - jednotlivé DTD za sebou
F_ZIP Uložit do souboru a komprimovaně pomocí ZIP

Výstup:

Výstup je DTD ve formátu totožném jako je na CD DS

Příklad:
Dtd.aspx?Dtd=030201
Vrátí DTD verze 030201.


Služby se volají odkazem na výše uvedenou stránku a předáním parametrů. Parametry je možné předávat v záhlaví dotazu (pomocí GET) nebo v těle dotazu (pomocí POST). Výstup je vždy v XML.

V záhlaví dotazu se parametry předávají takto:

služba.aspx[?param1=hodnota1[&param2=hodnota2[&param2=hodnota3...]]]