Popis datového rozhraní k iFIS*Registr smluv: Porovnání verzí

Z BBM Dokumentace iFIS
Skočit na navigaciSkočit na vyhledávání
← Porovnání se starší verzíPorovnání s novější verzí →
VizuálníWikitext
Jdankova (diskuse | příspěvky)
24 453 editací
Bez shrnutí editace
Jdankova (diskuse | příspěvky)
24 453 editací
Bez shrnutí editace
Řádek 1: Řádek 1:
Přenos informací o smlouvách je realizován pomocí SOAP webové služby. WSDL dokumentace je k dispozici na aplikačním serveru iFIS a nebo na vyžádání u správce iFIS. Data jsou na rozhraní služby předávána ve formátu XML, přikládáme zjednodušené vzorové soubory [[Media:Smlouva DATA vzor.xml|Smlouva DATA vzor.xml]] a [[Media:Prilohy ke smlouve DATA vzor.xml|Prilohy ke smlouve DATA vzor.xml]].
Přenos informací o smlouvách je realizován pomocí SOAP webové služby. WSDL dokumentace je k dispozici na aplikačním serveru iFIS a nebo na vyžádání u správce iFIS. Data jsou na rozhraní služby předávána ve formátu XML. Přikládáme zjednodušené vzorové soubory [[Media:Smlouva DATA vzor.xml|Smlouva DATA vzor.xml]] a [[Media:Prilohy ke smlouve DATA vzor.xml|Prilohy ke smlouve DATA vzor.xml]].


Pro validaci předávaných dat se využívá schéma [[Media:ifis_smlouvy.xsd|ifis_smlouvy.xsd]], [[Media:ifis_prilohy.xsd|ifis_prilohy.xsd]] a [[Media:ifis_common.xsd|ifis_common.xsd]].
Pro validaci předávaných dat se využívá schéma [[Media:ifis_smlouvy.xsd|ifis_smlouvy.xsd]], [[Media:ifis_prilohy.xsd|ifis_prilohy.xsd]] a [[Media:ifis_common.xsd|ifis_common.xsd]].
Řádek 5: Řádek 5:
===Metody webové služby===
===Metody webové služby===


VlozSmlouvu (PozadavekRS) – metodě je při volání předáván objekt PozadavekRS. Pro jednoznačnou identifikaci smlouvy je možné použít buď fisovský interní identifikátor RSHIDNO a nebo externí identifikátor SMLID (vizualizované číslo smlouvy). V případě, že požadavek na založení smlouvy neobsahuje externí identifikátor SMLID, pak je tento identifikátor automaticky generován v iFIS*Registr smluv. Služba vrací objekt OdpovedRS, kde je uveden stav operace a identifikátory smlouvy, které byly vygenerovány v iFIS*RS. Pokud je vkládána smlouva, která již v iFIS existuje (byla vložena dříve), nedojde k žádné změně.
'''VlozSmlouvu (PozadavekRS)''' – metodě je při volání předáván objekt PozadavekRS. Pro jednoznačnou identifikaci smlouvy je možné použít buď fisovský interní identifikátor RSHIDNO a nebo externí identifikátor SMLID (vizualizované číslo smlouvy). V případě, že požadavek na založení smlouvy neobsahuje externí identifikátor SMLID, pak je tento identifikátor automaticky generován v iFIS*Registr smluv. Služba vrací objekt OdpovedRS, kde je uveden stav operace a identifikátory smlouvy, které byly vygenerovány v iFIS*Registr smluv. Pokud je vkládána smlouva, která již v iFIS existuje (byla vložena dříve), nedojde k žádné změně.




DejSmlouvu (PozadavekRS) – metodě je při volání předáván objekt PozadavekRS. V tomto objektu musí být uveden interní nebo externí identifikátor smlouvy. Metoda vrací objekt OdpovedRS, kde je uveden stav operace a výpis aktuálně evidovaných dat o smlouvě v iFIS*RS.
'''DejSmlouvu (PozadavekRS)''' – metodě je při volání předáván objekt PozadavekRS. V tomto objektu musí být uveden interní nebo externí identifikátor smlouvy. Metoda vrací objekt OdpovedRS, kde je uveden stav operace a výpis aktuálně evidovaných dat o smlouvě v iFIS*Registru smluv.




DejPoradoveCislo (PozadavekRS) – metodě je při volání předáván objekt PozadavekRS. V tomto objektu musí být v poli identifikátorů uvedeny další parametry rozhodující pro vygenerované číslo SMLID (ULOHA, ROK, MESIC, EJ,  STREDISKO a TYP_SMLOUVY). V poli identifikátorů je každý parametr jednoznačně popsán názvem parametru (element zdroj_id) a hodnotou parametru (element hodnota_id). Metoda vrací objekt OdpovedRS, kde je uveden stav operace a číslo smlouvy SMLID vygenerované v závislosti na vstupních parametrech.
'''DejPoradoveCislo (PozadavekRS)''' – metodě je při volání předáván objekt PozadavekRS. V tomto objektu musí být v poli identifikátorů uvedeny další parametry rozhodující pro vygenerované číslo SMLID (ULOHA, ROK, MESIC, EJ,  STREDISKO a TYP_SMLOUVY). V poli identifikátorů je každý parametr jednoznačně popsán názvem parametru (element zdroj_id) a hodnotou parametru (element hodnota_id). Metoda vrací objekt OdpovedRS, kde je uveden stav operace a číslo smlouvy SMLID vygenerované v závislosti na vstupních parametrech.




CheckWs() – metoda vrací řetězec s výsledkem operace, slouží pouze pro testovací účely.
'''CheckWs()''' – metoda vrací řetězec s výsledkem operace, slouží pouze pro testovací účely


{{Poznamka|Funkcionalita umožňující vložení dokumentu ke smlouvě je obsažena ve webové službě BbmFileWs v metodě VlozObecPril(). Popis této metody je obsahem jiného dokumentu.}}
{{Poznamka|Funkcionalita umožňující vložení dokumentu ke smlouvě je obsažena ve webové službě BbmFileWs v metodě VlozObecPril(). Popis této metody je obsahem jiného dokumentu.}}

Verze z 28. 5. 2021, 15:08

Přenos informací o smlouvách je realizován pomocí SOAP webové služby. WSDL dokumentace je k dispozici na aplikačním serveru iFIS a nebo na vyžádání u správce iFIS. Data jsou na rozhraní služby předávána ve formátu XML. Přikládáme zjednodušené vzorové soubory Smlouva DATA vzor.xml a Prilohy ke smlouve DATA vzor.xml.

Pro validaci předávaných dat se využívá schéma ifis_smlouvy.xsd, ifis_prilohy.xsd a ifis_common.xsd.

Metody webové služby

VlozSmlouvu (PozadavekRS) – metodě je při volání předáván objekt PozadavekRS. Pro jednoznačnou identifikaci smlouvy je možné použít buď fisovský interní identifikátor RSHIDNO a nebo externí identifikátor SMLID (vizualizované číslo smlouvy). V případě, že požadavek na založení smlouvy neobsahuje externí identifikátor SMLID, pak je tento identifikátor automaticky generován v iFIS*Registr smluv. Služba vrací objekt OdpovedRS, kde je uveden stav operace a identifikátory smlouvy, které byly vygenerovány v iFIS*Registr smluv. Pokud je vkládána smlouva, která již v iFIS existuje (byla vložena dříve), nedojde k žádné změně.


DejSmlouvu (PozadavekRS) – metodě je při volání předáván objekt PozadavekRS. V tomto objektu musí být uveden interní nebo externí identifikátor smlouvy. Metoda vrací objekt OdpovedRS, kde je uveden stav operace a výpis aktuálně evidovaných dat o smlouvě v iFIS*Registru smluv.


DejPoradoveCislo (PozadavekRS) – metodě je při volání předáván objekt PozadavekRS. V tomto objektu musí být v poli identifikátorů uvedeny další parametry rozhodující pro vygenerované číslo SMLID (ULOHA, ROK, MESIC, EJ, STREDISKO a TYP_SMLOUVY). V poli identifikátorů je každý parametr jednoznačně popsán názvem parametru (element zdroj_id) a hodnotou parametru (element hodnota_id). Metoda vrací objekt OdpovedRS, kde je uveden stav operace a číslo smlouvy SMLID vygenerované v závislosti na vstupních parametrech.


CheckWs() – metoda vrací řetězec s výsledkem operace, slouží pouze pro testovací účely

Poznámka Poznámka
Funkcionalita umožňující vložení dokumentu ke smlouvě je obsažena ve webové službě BbmFileWs v metodě VlozObecPril(). Popis této metody je obsahem jiného dokumentu.
Citováno z „https://wiki.bbm.cz/index.php?title=Popis_datového_rozhraní_k_iFIS*Registr_smluv&oldid=89358“