MPZ_IZD01A
(MPZ_IZD01A)
Služba pro import žádosti
| Název služby | MPZ_IZD01A (MPZ_IZD01A) |
|---|---|
| Popis služby | Služba pro import žádosti |
| Verze služby | 01A |
| Způsob autorizace |
PF -
služba vyžaduje autorizaci na základě WS klíče, který je možné získat po přihlášení na eAGRI. Autentizace je řešena hashovanou zprávou, kdy je do requestu vkládán unikátní HASH requestu. Postup pro generování HASHe je zde. Místo hashované zprávy je také možné použít certifikát. Veřejnou část certifikát je nutné nejdříve ve spolupráci s HD MZe do prostředí MZe importovat.
|
| Datový model služby | Datový modely služby obsahuje podrobné popisy jednotlivých elementů, které jsou na vstupu nebo výstupu služby. Před implementací služby je vhodné se s obsahem datového modelu seznámit. prod test |
| WSDL služby | prod test |
| Adresy serverů | test: https://epomzetest.gov.cz/ssl/nosso-app/EPO/WS/v2Online/vOKOsrv.ashx prod: https://epomze.gov.cz/ssl/nosso-app/EPO/WS/v2Online/vOKOsrv.ashx |
Služba pro import žádosti podporuje následující scénáře:
- Založení nové žádosti v rámci uživatelského účtu.
- Aktualizace údajů stávající žádosti, žádost musí být ve stavu umožňujícím editaci (rozpracovaná, vrácená k doplnění) a musí být evidována pod uživatelským účtem, pod kterým se autentizuje volání služby.
- Aktualizace příloh stávající žádosti, žádost musí být opět pod patřičným uživatelským účtem a dále musí být v editovatelném stavu, evidované údaje v přílohách žádosti budou přepsány údaji z dotazu.
Níže je popsána definice rozhraní, několik komentářů k návrhu:
- Rozhraní je konstruováno jako obecné, bude umožňovat import všech typů žádostí, které budou současně podporovat současný import z XML souboru.
- V rozhraní jsou navrženy všechny nezbytné parametry pro založení či aktualizaci žádosti. Parametry rokPlatnosti či identifikatorOhlaseni nemusí být využity u všech dotačních programů. Získání potřebného identifikátoru ohlášení je možné prostřednictvím služby MPZ_OLH01A.
- Aby mohlo být rozhraní služby obecné pro všechny typy dotačních programů, obsahuje parametr xmlData, ve kterém se předávají XML data žádosti či příloh žádosti, a to ve shodném formátu, který je definován pro již dostupný XML import ze souboru. Služba na základě parametru programKodUnic určí, o který dotační program se jedná a dle toho bude očekávat formát vstupu. S ohledem na to, že u některých dotačních programů může být XML žádosti veliké, podporuje služba možnost předání ve formátu zip převedeném do base64. Formát dat je třeba určit parametrem xmlDataTyp. Pokud datová zpráva přesáhne velikost 10MB, nemusí být zpracována s ohledem na nastavené velikostní limity zpráv na úrovni integračních platforem. V těchto případech je tedy využití parametru base64/zip nezbytné. Pokud je v elementu xmlData předáván řetězec base64/zip, je nezbytné řetězec zabalit do elementu <Soubor>:
<mpz:xmlData> <Soubor>base64string</Soubor> </mpz:xmlData> - Parametr guidZadosti slouží jako technický identifikátor konkrétní žádosti. Pro založení nové žádosti se neuvádí, při provádění aktualizace stávající žádosti je naopak tento parametr nezbytný.
- V odpovědi služby se vrací základní metadata žádosti a také URL odkaz na otevření dané žádosti v prostředí aplikace Modul pro žadatele. Pro otevření je nezbytné přihlášení uživatele.