Generování průvodního listu skotu (PLS)
(IZR_EPLS01A)
Služba umožňuje pro konkrétní zvíře či seznam zvířat vygenerovat aktuální PLS a volitelně toto PLS zaslat emailem.
| Název služby | Generování průvodního listu skotu (PLS) (IZR_EPLS01A) |
|---|---|
| Popis služby | Služba umožňuje pro konkrétní zvíře či seznam zvířat vygenerovat aktuální PLS a volitelně toto PLS zaslat emailem. |
| 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 |
Použití služby
Vstupem služby jsou údaje o hospodářství a zvířatech. Hospodářství se zadává bez hodnoty CZ. Pro hospodářství se následně uvádí ušní známky.
Výstupní formát
Na vstupu služby je možné specifikovat nepovinně výstupní formát PLS. Tento element EPLSTYP je nepovinný a může mít hodnoty:
- ZipStream (výchozí formát pokud není na vstupu element EPLSTYP uveden),
- ZipFile,
- PDF.
V elementu EPLS se poté vrací binární obsah kódovaný v BASE64.
U typu ZipFile se vrací zip soubor obsahující 1 PDF soubor, který má název dle čísla zvířete - viz ukázka.
Chyba v response
Pokud jsou vstupní údaje korektní a je platná vazba Subjekt/Chovatel > hospodářství > ušní známka zvířete, tak v response služby je hodnota Stav = Ok:
<STAV>Ok</STAV>
Pokud vstupní údaje nejsou korektní tak se vrací Stav = Chyba a dále je chyba blíže popsána:
<STAV>Chyba</STAV>
<CHYBA>Nelze generovat PLS. Zvíře nemá vhodnou polohu (přísun) u chovatele.</CHYBA>
Změny v PLS
V případě, že se dojde k vytvoření PLS je toto vráceno v response služby v elementu EPLS. PLS se nově negeneruje s každým voláním služby, ale je vytvořeno jednou a dokud nedojde ke změně u zvířete, která by měla dopad do PLS, tak služba vrací stále stejné PLS. V případě změny se vrací aktuální verze PLS a starší verze PLS služba nevrací.
Element EPLS
V response služby se vrací ZIP soubor v base64. Pro získání PDF je nutné vrácené údaje dekódovat z base64 do struktury ZIP a tento ZIP následně rozbalit. Tímto vznikne podkladové PDF. Důvodem komprese je snížení velikosti EPLS a možnost vracet v response služby větší množství EPLS.
Email na vstupu služby
Pokud je na vstupu služby uveden email, tak systém IZR nevrací EPLS v response služby, ale je EPLS zasláno na uvedený email. EPLS element v tomto případě není vůbec v response uveden. Pro všechny EPLS se zasílá jeden email, který obsahuje jeden PDF soubor, který obsahuje všechna PLS.
Omezení služby
Chování služby bude sledováno a může v budoucnu dojít k určitým omezení, aby velikost generovaných EPLS byla v určitých mezích. Pokud by byla služba volána pro velké množství hospodářství a zvířat a velikost response by se blížila jednotkám MB, tak bude omezen rozsah vstupu (např. omezení počtu zvířat na vstupu služby).