ExportMonitoringGetLatestReport CZ
Tato webová metoda webové služby CreditCheckAktualizace umožňuje stažení vygenerovaného reportu monitoringu.
SOAP header
Code Block | ||
---|---|---|
| ||
<soap:Header> <CreditCheckHeader xmlns="http://creditcheck.cz/"> <Login>string</Login> <Password>string</Password> </CreditCheckHeader> </soap:Header> |
Popis elementů SOAP headeru.
Název | Popis |
---|---|
Login | uživatelské jméno |
Password | uživatelské heslo |
Tyto údaje jsou rozdílné pro různé uživatele systému a jsou poskytovány obchodním oddělením Credit Check, s.r.o.
Vstupní parametry webové metody
...
název | datatype | mandatory | poznámka |
reportRequest | XmlNode | yes |
|
Vstup parametru webové metody
Code Block | ||
---|---|---|
| ||
<exportMonitoringLatestReport> <monitoringType>IsirPersonal</monitoringType> <reportType>MonthlyReport</reportType> <fileType>csv</fileType> </exportMonitoringLatestReport> |
Popis elementů vstupu
Název | Popis | Specifikace |
---|---|---|
monitoringType | Typ monitoringu | V současné době pouze hodnota IsirPersonal . |
reportType | Typ reportu | V současné době pouze hodnota MonthlyReport . |
fileType | Typ souboru reportu. | V současné době pouze hodnota csv . |
...
Výstup webové metody poskytuje data o dotazu na základě kterého byl report poskytnutý, data reportu a v případě chyby informaci o chybě..
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<creditCheck version="1.0" encoding="utf-8"> <webMethod>ExportMonitoringGetLatestReportTime</webMethod> <country>CZ</country> <time>2016-07-13T13:32:49.4445760+02:00</time> <exportMonitoringLatestReport xmlns=""> <monitoringType>IsirPersonal</monitoringType> <reportType>MonthlyReport</reportType> <fileType>csv</fileType> </exportMonitoringLatestReport> <report> <reportId>6e2f3014-d798-45d3-9a9e-706790d17fad</reportId> <latestTime>2016-07-01T10:04:47.5370000+02:00</latestTime> <count>2</count> <data> <![CDATA[Jméno;Příjmení;Datum narození;Spisová značka;Poslední známý stav;Evidujeme od;Odkaz na dokument Luděk;Lacina;1.8.1979 0:00:00;INS 28399/2012;ODDLUŽENÍ;30.6.2016 21:26:58;https://isir.justice.cz/isir/ueu/vysledek_lustrace.do?nazev_osoby=&vyhledat_pouze_podle_zacatku=on&podpora_vyhledat_pouze_podle_zacatku=true&bc_vec=28399&rocnik=2012&aktualnost=AKTUALNI_I_UKONCENA&spis_znacky_obdobi=14DNI Jan;Staněk;22.3.1983 0:00:00;INS 21880/2011;ODSKRTNUTA;13.6.2016 8:28:00;https://isir.justice.cz/isir/ueu/vysledek_lustrace.do?nazev_osoby=&vyhledat_pouze_podle_zacatku=on&podpora_vyhledat_pouze_podle_zacatku=true&bc_vec=21880&rocnik=2011&aktualnost=AKTUALNI_I_UKONCENA&spis_znacky_obdobi=14DNI ]]> </data> </report> </creditCheck> |
Popis elementů výstupu
element name | datatype | mandatory | poznámka | |
webMethod | string | yes | Název webové metody, která data poskytla. | |
country | string | yes | Národní prostředí systému CreditCheck, který poskytl data. | |
time | stringDateTime | yes | Čas vygenerování výstupu XML. | |
exportMonitoringLatestReport | string | yes | Kopie dotazu, který odběratel dat poslal ve svém požadavku. | |
report |
| no | Element s daty report. Nemusí být poskytován v případě chyby. To znamená také to, že pokud nebude tento element vygenerován, nebudou zobrazeny jeho vnitřní elementy, které jsou jinak povinné. | |
reportId | Guid | latestTime | stringyes | Id reportu. Jedná se o id které patří reportu vygenerovanému z této webové metody a není to id reportu z DB který tato webová metoda vrací. Slouží k identifikaci požadavku v rámci celého systému CreditCheck. |
latestTime | DateTime | yes | Čas vygenerování reportu, který systém vrací. Tento čas je tedy časem, kdy systém CreditCheck report vygeneroval a uložil do databáze. | |
count | stringint | yes | Počet záznamů v elementu <data> | |
data | string | yes | Element s daty reportu. data jsou obalena do CData. Obsah je závislý na typu reportu, typu monitoringu a typu formátu souboru. |
...
Popis formátu dat v elementu pro typ reportu Monthly, typ monitoringu IsirPersonal a formát csv.
Element obsahuje blok dat oddělených oddělovači, která jsou obalena do CDATA. Jeden záznam reprezentuje jeden řádek. Záznamy jsou odděleny znakem newLine – nová řádka. Jeden záznam obsahuje data, která jsou oddělená středníkem.
...
Pokud se vyskytne v průběhu zpracování v systému CreditCheck chyba, je chyba vygenerována do elementu <error> . V této chvíli nemusí výstupní XML obsahovat element <report>, protože se jej nepodařilo vygenerovat.
Code Block | ||||
---|---|---|---|---|
| ||||
<creditCheck version="1.0" encoding="utf-8"> <webMethod>ExportMonitoringGetLatestReportTime</webMethod> <country>CZ</country> <time>2016-07-14T10:20:48.3883351+02:00</time> <exportMonitoringLatestReport xmlns=""> <monitoringTypes>IsirPersonal</monitoringTypes> <reportType>MonthlyReport</reportType> <fileType>csv</fileType> </exportMonitoringLatestReport> <error> <errorId>4b201297-03ab-4943-bf42-e0ba910c22a5</errorId> <message>Input validation: The element 'exportMonitoringLatestReport' has invalid child element 'monitoringTypes'. List of possible elements expected: 'monitoringType'.</message> <description /> <reportId>3d8442c3-df7d-45b5-9d11-6b9220378f89</reportId> </error> </creditCheck> |
Popis elementů error
element name | datatype | mandatory | poznámka |
errorId | GUID as string | yes | Id for matching our error db inside |
message | string | yes | Short information about error. |
description | string | no | Doplňující popis chyby. Nemusí být vyplněný. |
reportId | GUID as string | yes | id reportu, který chybu generoval. |
Seznam chybových zpráv.
error number | error description | poznámka | |
Input validation: XXX | Chyba validace vstupního XML. | ||
Monitoring is not allowed. Monitoring: XXX | Uživatel který požaduje report nemá povolený typ monitoringu pro který report požaduje. | ||
Report type is not allowed. Report type: XXX | Uživatel který požaduje report pro specifikovaný typ monitoringu nemá povolený požadovaný typ reportu. | ||
| Obtaining error report. | Chyba generovaná při problému se získáním vygenerovaného reportu ze systému CreditCheck. | |
| invalid input | Input request is not valid. |