Popis eGON služby E171 – aiseoCtiAifo2
Název dokumentu:
Popis eGON služeb
Autor:
Správa základních registrů
Účel:
Popis eGON služeb v rámci základních registrů
Verze:
04.00
Datum aktualizace:
23.12.2013
Počet stran:
11
Obsah 1
Účel dokumentu ..................................................................................................................... 3
2
Funkcionalita služby .............................................................................................................. 3
3
Základní informace o službě ................................................................................................. 3
4
Historie služby ....................................................................................................................... 3
5
Účel služby - detailní popis ................................................................................................... 4
6
Věcná pravidla vztahující se ke zpracování služby ............................................................ 4
7
Vstupní údaje ......................................................................................................................... 4 7.1
ZadostInfo
4
7.2
AutorizaceInfo
4
7.3
MapaAifo
4
7.4
Zadost
5
8
Kontroly při volání služby ..................................................................................................... 5
9
Příklad volání služby ............................................................................................................. 5
10
Výstupní údaje ....................................................................................................................... 5 10.1
OdpovedInfo 10.1.1 Stavy
6 6
10.2
MapaAifo
6
10.3
SeznamIdAdres
6
10.4
AiseoOdpoved
6
10.5
RobOdpoved
6
11
Příklad odpovědi .................................................................................................................... 7 11.1
Úspěšné volání
7
11.2
Nenalezeno v ROB
9
12
Notifikace změn .................................................................................................................... 10
13
Chybová hlášení .................................................................................................................. 11
14
Odkazy na další dokumenty ................................................................................................ 11
Správa základních registrů Na Vápence 14 130 00 Praha 3 – Žižkov
Strana 2 z 11
tel.: +420 236 031 752 www.szrcr.cz
1 Účel dokumentu Účelem tohoto dokumentu je především poskytnout orgánům veřejné moci, obecně uživatelům Základních registrů, jednoduchý a srozumitelný popis jak používat příslušnou eGON službu, včetně informací pro IT pracovníky orgánů veřejné moci. Změny provádí SZR.
2 Funkcionalita služby Služba E171 aiseoCtiAifo2 slouží pro čtení údajů z AIS Evidence obyvatel dle AIFO. Volající dostane kompletní rozsah údajů z AIS EO podle jeho oprávnění v Evidenci obyvatel a podle požadavku i referenční údaje osoby v ROB.
3 Základní informace o službě Název služby Označení služby Verze služby Publikována v katalogu služeb od verze Platnost od Platnost do Stav služby Nahrazena službou Nahrazuje službu Třída služby Dostupnost služby, potřebná oprávnění Režim služby SLA služby
aiseoCtiAifo2 E171 V1 1.12.2013 Aktivní A1 Ověření dle registrace. Synchronní i asynchronní SLA-NA
4 Historie služby Verze Aktuální stav Publikovaná služby verze v produkčním prostředí Od Do V1 aktivní 1.12.2013
Správa základních registrů Na Vápence 14 130 00 Praha 3 – Žižkov
Popis změn oproti předchozí verzi
Prvotní verze
Strana 3 z 11
tel.: +420 236 031 752 www.szrcr.cz
5 Účel služby - detailní popis Služba je určena pro čtení referenčních údajů z ROB a nereferenčních údajů osoby z AIS EO, které přísluší subjektu údajů. Osoba musí být na vstupu identifikována pomocí AIFO. Ze služby jsou z AIS EO vždy navráceny veškeré údaje, na které má oprávnění. Žadatel může provést výběr takového rozsahu údajů z ROB, který je dostačující pro vyřízení konkrétní činnosti OVM, případně ovlivnit, zda bude čtení z ROB prováděno. Služba navrací referenční údaje z ROB pro osobu identifikovanou ve volání služby (pokud je volající požaduje), nereferenční údaje osoby z AIS EO, a pro vázané osoby (matka, otec atd.) navrací pouze nereferenční údaje z AIS EO a AIFO, pokud existuje. Pokud u vázané osoby AIFO neexistuje, pak jsou navráceny pro tuto vázanou osobu údaje z AIS EO bez AIFO. Služba umožňuje použití příznaku „Blokace“, který je předáván do ROB a AISEO. Blokací se v tomto dokumentu míní znepřístupnění údajů o využívání údajů z AIS EO a ROB.
6 Věcná pravidla vztahující se ke zpracování služby Proces vždy nejdříve vyhledá osobu v AIS EO a následně ověří její existenci v ROB. Pokud není osoba ztotožněna v ROB, pak jsou navráceny pouze nereferenční údaje z AIS EO, není navráceno AIFO ani referenční údaje z ROB. Je navrácen stav VAROVANI s informací, že osoba není ztotožnitelná v ROB.
7 Vstupní údaje Vstupní údaje obsahují standardní položky, definované v datovém typu AiseoCtiAifo2Type. Bez správného vyplnění vstupních údajů nelze transakci zpracovat.
7.1 ZadostInfo Položka ZadostInfo představuje standardní hlavičku datové zprávy dotazu, která je odesílána ke zpracování. Struktura a obsah hlavičky zprávy jsou dány datovým typem ZadostInfoType. Obsahuje údaje, které ISZR vyžaduje pro ověření přístupu ke službě. Povinné položky musí být vyplněny.
7.2 AutorizaceInfo Pomocí elementu SeznamUdaju v elementu AutorizaceInfo je možné specifikovat chování služby s ohledem na vracení hodnot z ROB. Čtení bude provedeno v případě specifikace standardní hodnoty ROBCti, hodnota ROBOver není podporována vzhledem k tomu, že ověření je prováděno implicitně vždy. Dále je možné v seznamu údajů specifikovat jednotlivé referenční údaje požadované z ROB. Neuvedení seznamu údajů z ROB značí čtení z ROB v platném rozsahu údajů.
7.3 MapaAifo Položka MapaAifo slouží k předání AIFO, které má být přečteno. Musí být specifikováno právě jedno AIFO pomoci položky seznamu typu PrevodAifoType, kde musí být vyplněno LokalniAifo a GlobalniAifo. Atributy u elementů MapaAifo, PrevodAifo a LokalniAifo se nezadávají. Správa základních registrů Na Vápence 14 130 00 Praha 3 – Žižkov
Strana 4 z 11
tel.: +420 236 031 752 www.szrcr.cz
7.4 Zadost Element Zadost slouží k předání parametrů pro zpracování. V elementu AiseoCtiAifo2Data je možné pomocí nepovinného atributu vazaneOsobyCti (pokud neuveden, předpokládá se false) specifikovat, zda budou z AIS EO vráceny i vázané osoby. Dále je možné pomocí atributu znepristupniLog definovat požadavek na blokaci (neuvedení značí false).
8 Kontroly při volání služby Na vstupu je prováděna kontrola naplnění elementu MapaAifo.
9 Příklad volání služby <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Header>
IszrAiseoCtiAifo2 <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> 2013-1207T18:05:00.2404678+01:00 Axxx CRxxx OVM 1 <Subjekt xmlns="urn:cz:isvs:reg:schemas:RegTypy:v1">subjekt uzivatel duvoducel 3beb212c-bd6847e6-b7b8-1dfe1fb48a0e <SeznamUdaju /> <MapaAifo nacistData="true" xmlns="urn:cz:isvs:iszr:schemas:IszrAbstract:v1"> 1 9bIZanB/7523gnNhElL9h4k=
10 Výstupní údaje Výstupní údaje obsahují standardní položky, definované v datovém typu AiseoCtiAifo2ResponseType. Správa základních registrů Na Vápence 14 130 00 Praha 3 – Žižkov
Strana 5 z 11
tel.: +420 236 031 752 www.szrcr.cz
10.1 OdpovedInfo Struktura položky OdpovedInfo obsahuje údaje, které ISZR ale i AIS očekává k dokončení vyřízení požadavku. Struktura a obsah hlavičky zprávy jsou dány datovým typem OdpovedInfoType.
10.1.1 Stavy Stav provedení služby je uveden v elementu Status/VysledekKod: -
OK – služba byla zpracována
-
VAROVANI - při zpracování nastala situace, na kterou je vhodné upozornit.
-
CHYBA – zpracování není možné provést
Seznam situací a výstupních stavů služby je uveden v následující tabulce: Situace Načteno z AISEO, ověřeno v ROB
AIFO pro AISEO neexistuje v ORG Nalezeno v AISEO, neověřeno v ROB
Výstup Status/VysledekKod=OK MapaAifo naplněna AiseoCtiAifo2DataResponse AiseoAplikacniStatus/VysledekAiseoKodType=OK Osoba´ vyplněna daty AISEO Status/VysledekKod=CHYBA Status/VysledekSubKod=NEVALIDNI DATA Status/VysledekDetail= Služba G27 vrátila neověřená aifa! Status/VysledekKod=VAROVANI Status/VysledekSubKod=SPECIFIKACE V POPISU Status/VysledekDetail=ROBDETAIL: PARCIALNI ZAZNAM NENALEZEN, CHYBA_0013: Pro některé hodnoty Aifo nebyly nalezeny žádné záznamy. AiseoCtiAifo2DataResponse AiseoAplikacniStatus/VysledekAiseoKodType=OK Osoba´ vyplněna daty AISEO
10.2 MapaAifo V případě úspěšného provedení služby obsahuje element MapaAifo seznam položek typu PrevodAifoType ve kterém jsou uvedeny lokální AIFO a globální AIFO která bylo možné pro volající AIS předat (tj. existují v ROB).
10.3 SeznamIdAdres Standardní seznam identifikátorů adresních míst a adresních lokalit vedených referenčními odkazy v ROB, tak jak jsou vráceny z ROB. Pokud není čtení z ROB prováděno, element není na výstupu uveden.
10.4 AiseoOdpoved Element pro výstup návratové hodnoty služby z AIS EO. V elementu AiseoCtiAifo2DataResponse obsahuje v elementu AiseoAplikacniStatus stavové informace o vykonání služby v AIS EO a dále v elementu Osoba nereferenční data z AISEO.
10.5 RobOdpoved Element pro výstup návratové hodnoty služby, pokud je požadováno čtení v ROB (ROBCti) a vyhledání v AISEO a ověření v ROB proběhlo úspěšně. Data jsou vracena v elementu RobCtiAifoDataResponse stejným způsobem, jako by bylo provedeno přímo čtení AIFO z ROB službou E03 robCtiAifo, včetně návratového stavu ROB v elementu RobAplikacniStatus.
Správa základních registrů Na Vápence 14 130 00 Praha 3 – Žižkov
Strana 6 z 11
tel.: +420 236 031 752 www.szrcr.cz
11 Příklad odpovědi 11.1 Úspěšné volání <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:autocont1="urn:cz:isvs:iszr:services:IszrRosCtiIco:v1" xmlns:abs="urn:cz:isvs:iszr:schemas:IszrAbstract:v1" xmlns:autocont2="urn:cz:isvs:iszr:schemas:IszrAiseoCtiAifo2:v1" xmlns:reg="urn:cz:isvs:reg:schemas:RegTypy:v1" xmlns:xlinl="http://www.w3.org/1999/xlink" xmlns:autocont3="urn:cz:isvs:aiseo:schemas:AiseoDotazyData:v1" xmlns:autocont4="urn:cz:isvs:aiseo:schemas:AiseoTypy:v1" xmlns:autocont5="urn:cz:isvs:aiseo:schemas:AiseoCtiAifo2:v1" xmlns:rod="urn:cz:isvs:rob:schemas:RobDotazyData:v1" xmlns:rob="urn:cz:isvs:rob:schemas:RobTypy:v1"> <soapenv:Header /> <soapenv:Body> 2014-01-09T11:04:02.6508750+01:00 OK e9293a6c-8463-44f8-baba-9f52c0737f2a 438c812b-ebef-4168-bd12-a76e026b0699 1 VM3b3/g2zdexrtrjc83dRGU= 21776733 555134 OK 1 7055040003 NOVÁKOVÁ PETRA 1970-05-04 Z NOVÁKOVÁ 1 Svobodná 04.05.1970 0 evidenční osoba 201 Česká republika 0 Platný trvalý pobyt 203 0 Ne 20531 Pardubice 3606 Pardubice 201 Česká republika 555134 CZ0532
Správa základních registrů Na Vápence 14 130 00 Praha 3 – Žižkov
Strana 7 z 11
tel.: +420 236 031 752 www.szrcr.cz
203 963 P 1 13000 O Obývaný 11346 KUBELÍKOVA 19512 Žižkov(Praha 3) 19643 Praha 3 32767 Praha 3103 Praha 3 3103 Praha 3 0 Platný trvalý pobyt 04.05.1970 500097 400106 554782 CZ0103 1103 04.05.1970 0 bez omezení Ne Ne Ne Ne NOVOTNÁ 25.04.2011 Ne N OK 21776733 H2F7sJDf8Qpwox/bPyZ13av5lVfZBXkVFcWK7y8j//sMdbUgkysY9tLJ+zSVSBqWwNA5uhbApa gN7lxIGcCGXg== 1970-05-04 PETRA
Správa základních registrů Na Vápence 14 130 00 Praha 3 – Žižkov
Strana 8 z 11
tel.: +420 236 031 752 www.szrcr.cz
555134 NOVÁKOVÁ 203
11.2 Nenalezeno v ROB <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:autocont1="urn:cz:isvs:iszr:services:IszrRobCtiAifo:v1" xmlns:abs="urn:cz:isvs:iszr:schemas:IszrAbstract:v1" xmlns:autocont2="urn:cz:isvs:iszr:schemas:IszrAiseoCtiAifo2:v1" xmlns:reg="urn:cz:isvs:reg:schemas:RegTypy:v1" xmlns:xlinl="http://www.w3.org/1999/xlink" xmlns:autocont3="urn:cz:isvs:aiseo:schemas:AiseoDotazyData:v1" xmlns:autocont4="urn:cz:isvs:aiseo:schemas:AiseoTypy:v1" xmlns:autocont5="urn:cz:isvs:aiseo:schemas:AiseoCtiAifo2:v1"> <soapenv:Header /> <soapenv:Body> 2014-01-10T12:04:10.8852500+01:00 VAROVANI SPECIFIKACE V POPISU ROBDETAIL: PARCIALNI ZAZNAM NENALEZEN, CHYBA_0013: Pro některé hodnoty Aifo nebyly nalezeny žádné záznamy. fef50140-058b-4cc9-a577-45156273233c f17f7927-b1a4-426c-bbca-b4e8cdc88f60 OK 1 6412310003 LUDVÍK LUDVÍK 1964-12-31 M LUDVÍK 1 Svobodný 31.12.1964 0 evidenční osoba 201 Česká republika 0 Platný trvalý pobyt 203 0 Ne 20531 Pardubice 3606 Pardubice
Správa základních registrů Na Vápence 14 130 00 Praha 3 – Žižkov
Strana 9 z 11
tel.: +420 236 031 752 www.szrcr.cz
201 Česká republika 555134 CZ0532 203 373 P 35 30100 O Obývaný 1479010 NAD RADBUZOU 9243 Lhota 24015 Plzeň 10-Lhota 23963 Plzeň 3405 Plzeň-město 3445 Plzeň 0 Platný trvalý pobyt 31.12.1964 557978 080942 554791 CZ0323 3209 31.12.1964 0 bez omezení Ne Ne Ne Ne Ne N
12 Notifikace změn Služba není editační, notifikace změn pro ni není relevantní. Správa základních registrů Na Vápence 14 130 00 Praha 3 – Žižkov
Strana 10 z 11
tel.: +420 236 031 752 www.szrcr.cz
13 Chybová hlášení Služba neobsahuje specifická chybová hlášení. Výstupní hodnoty a stavy jsou popsány v kapitole Výstupní údaje
14 Odkazy na další dokumenty WSDL služby: XSD služby:
Správa základních registrů Na Vápence 14 130 00 Praha 3 – Žižkov
egon/wsdl/aiseoCtiAifo2.wsdl egon/xsd/aiseoCtiAifo2.xsd
Strana 11 z 11
tel.: +420 236 031 752 www.szrcr.cz