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

Z BBM Dokumentace iFIS
Skočit na navigaciSkočit na vyhledávání
Jdankova (diskuse | příspěvky)
Založena nová stránka s textem „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…“
 
Jdankova (diskuse | příspěvky)
Bez shrnutí editace
 
(Není zobrazeno 9 mezilehlých verzí od stejného uživatele.)
Řá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 Smlouva DATA vzor.xml a Prilohy ke smlouve DATA vzor.xml
#REDIRECT [[Popis datového rozhraní k iFIS/Registr smluv]]
Pro validaci předávaných dat se využívá schéma ifis_smlouvy.xsd, ifis_prilohy.xsd a ifis_common.xsd.
 
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]].


===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.}}
===Možnost přes rozhraní evidovat smlouvu s vazbou na nadřízenou smlouvu===
V iFIS je umožněno vkládat či editovat [[Man08202|smlouvu]] přes rozhraní s vazbou na nadřízenou [[Man08202|smlouvu]], a to bez znalosti '''RSHIDNO''' (naše ID smlouvy):
*přes element '''T082_THLAVICKA.NADRIZ_SMLID'''
*funkcionalita umožní evidovat [[Man08202|smlouvu]] přes rozhraní, i když zakládající subjekt nezná naše ID ('''RSHIDNO''')
*dosud bylo možné realizovat pouze při vyplnění elementu '''NADRIZ''' ('''Smlouva/Hlavicka/NADRIZ''') hodnotou '''RSHIDNO''', to však bylo možné jen u '''VERSO''' s jejich propojením na ''i''FIS
*nyní se předává přes hodnotu '''SMLID''' (číslo existující smlouvy) a dle '''SMLID''' se doplní '''RSHIDNO''' (naše ID smlouvy), stejně jako se dělá při update [[Man08202|smlouvy]]
*rozhraní mění schéma ifis_smlouvy, které je využité v rozhraní pro import smluv (webová služba)
*přidána nepovinná položka, to znamená že, rozhraní je zpětně kompatibilní

Aktuální verze z 30. 8. 2024, 09:01

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.


Možnost přes rozhraní evidovat smlouvu s vazbou na nadřízenou smlouvu

V iFIS je umožněno vkládat či editovat smlouvu přes rozhraní s vazbou na nadřízenou smlouvu, a to bez znalosti RSHIDNO (naše ID smlouvy):

  • přes element T082_THLAVICKA.NADRIZ_SMLID
  • funkcionalita umožní evidovat smlouvu přes rozhraní, i když zakládající subjekt nezná naše ID (RSHIDNO)
  • dosud bylo možné realizovat pouze při vyplnění elementu NADRIZ (Smlouva/Hlavicka/NADRIZ) hodnotou RSHIDNO, to však bylo možné jen u VERSO s jejich propojením na iFIS
  • nyní se předává přes hodnotu SMLID (číslo existující smlouvy) a dle SMLID se doplní RSHIDNO (naše ID smlouvy), stejně jako se dělá při update smlouvy
  • rozhraní mění schéma ifis_smlouvy, které je využité v rozhraní pro import smluv (webová služba)
  • přidána nepovinná položka, to znamená že, rozhraní je zpětně kompatibilní