Type01 Request
Úvod
Tato sekce popisuje strukturu xml požadavku zasílaného na naší webovou službu Searching services. Konkrétně se jedná o požadavek na vyhledávací službu Search Type 01. Níže jsou popsány jednotlivé elementy xml dokumentu, které klient musí vyplnit, aby byl požadavek zpracován jako korektní. Podrobný popis jednotlivých typů filtrů a jejich hodnot můžete nalézt zde.
Podmínky využití
Pro domluvu konkrétních podmínek využití jako je například výběr filtrů, aplikace ve které bude search dostupný, předpokládaný počet dotazů apod. kontaktujte Pavel Macek.
Elementy sekce
Struktura xml elementu
V sekci se může vyskytovat 0 až n filtrů. Z tohoto důvodu je celá sekce zabalena do elementu s názvem searchingFilters. Tento element potom obsahuje n záznamů searchingFilter, které představují jednotlivé filtry. Účinky jednotlivých filtrů jsou kombinovány a vrácen je pouze výsledek, který splňuje všechny zadaná kritéria.
Struktura daného XML kódu potom vypadá například takto :
<requestSubject>
<searchingFilters>
<searchingFilter>
<filterName>Name</filterName>
<filterValue>Vladimír</filterValue>
</searchingFilter>
<searchingFilter>
<filterName>ActivityType</filterName>
<filterValue>A</filterValue>
</searchingFilter>
<searchingFilter>
<filterName>CategoryNACE</filterName>
<filterValue>0-000000</filterValue>
</searchingFilter>
</searchingFilters>
</requestSubject>
Elementy záznamu v sekci
| Název elementu | Datový typ | Popis |
|---|---|---|
| filterName | string | Název filtru, který chceme aplikovat na hledanou množinu dat. |
filterValue | string | Hodnota filtru, které mají hledané záznamy splňovat. (Například základ jména, druh činnosti apod.) |
filterTag | string | U některých filtrů je potřeba uvést ještě tag (doplňující podmínky pro filtrování). Tento element není povinný. |
Hodnoty v elementech
Podporované názvy filtrů, jejich stručný popis a očekávané hodnoty/tagy můžete nalézt zde.
Pokud máte dotazy, napište nám na api@creditcheck.cz