UPROSZCZONE ODPYTYWANIE KRD

Transkrypt

1 T O V I 3.0 UPROSZCZONE ODPYTYWANIE KRD SPECYFIKACJA PLIKU Wersja 1.0 Z dnia Numer dokumentu 2007/IT-P/01 Kategoria dokumentu Projekt Status dokumentu Opracowanie zewnętrzne Słowa kluczowe Biuro Informacji Gospodarczej, BIG, Rahl, Nicci, Siddin, Transza, Web Service

2 Spis treści SPIS TREŚCI... 2 SPIS TABEL... 3 WSTĘP DANE POZYSKIWANE Z BIURA, INFORMACJE NIEZBEDNE DO PRAWIDŁOWEGO ODPYTYWANIA POBIERANE INFORMACJE GOSPODARCZE... 5

3 Spis tabel Tabela 1 : Dane merytoryczne transzy z zapytaniami... 5 Tabela 2 : Pobierane informacje gospodarcze... 6

4 Wstęp Protokół Tovi jest odpowiedzią na potrzeby tych klientów, którzy chcą pobierać informacje gospodarcze z Krajowego Rejestru długów w sposób masowy i w uproszczonej formie wymiany danych, posługując się plikami tekstowymi formatu CSV. W związku z zastosowaniem powyższej, uproszczonej formy wysyłania zapytań oraz otrzymywania odpowiedzi informacje przekazywane klientowi poprzez protokół Tovi są ograniczone w stosunku do pełnych danych, jakie można pozyskać za pomocą pliku XML (przy zastosowaniu protokołu NICCI). W pliku zwrotnym protokołu Tovi przekazywane są informacje o ilości zobowiązań, ilości wszystkich informacji gospodarczych, razem z pozytywnymi oraz z podrobionymi dokumentami, ilości odnalezionych wierzycieli oraz o całkowitej kwocie zadłużenia. Ograniczenia powyższe zostały nałożone w związku z konstrukcją pliku tekstowego CSV, która uniemożliwia przekazanie pełnych danych, jakie można odnaleźć w raporcie pozyskanym poprzez protokół NICCI (plik XML) Dokument ten opisuje strukturę pliku CSV, który jest zgodny z protokołem Tovi. Komunikację z serwisem KRD zapewnia dla protokołu Tovi program Kliencki Sabar.

5 1. Dane pozyskiwane z biura, informacje niezbędne do prawidłowego odpytywania Zgodnie z ustawą o udostępnianiu informacji gospodarczej protokół Tovi 3.0 umożliwia pobieranie informacji gospodarczej zarówno o osobach fizycznych jak i o firmach. Równocześnie użycie powyższego protokołu jest ograniczone ustawowymi obostrzeniami. Aby poprawnie pobrać informację gospodarczą należy w przygotowywanym pliku transzy wprowadzić poza kodem operacji inne informacje niezbędne do prawidłowego odpytania bazy KRD. W pierwszej kolumnie należy podać typ wyszukiwania, zgodny z tabelą poniżej. Druga, trzecia i czwarta kolumna zostają puste, gdyż w nich znajdują się odpowiedzi systemowe. Gdy pożądana informacja ma dotyczyć konsumenta wymaganym jest również uzupełnienie kolumny nr 7. Przy pytaniu o sobie kolumna 6 i 7 pozostaje pusta. Tabela 1: Dane merytoryczne transzy z zapytaniami Nr Nazwa Opis W Typ danych Długość Uwagi Code Typ operacji Liczba całkowita 2 1 wyszukanie konsumenta z Polski 2 wyszukanie konsumenta z innego kraju 3 wyszukanie firmy lub instytucji z Unii Europejskiej 1 4 wyszukanie firmy lub instytucji spoza Unii Europejskiej 5 wyszukanie siebie 6 wyszukiwanie informacji o podrobionym dokumencie 2 Extensions Pole zarezerwowane dla przyszłego użycia Status Status przetwarzania Liczba całkowita 1 Kod wyniku przetwarzania zwracany po przetworzeniu zlecenia: 1 zlecenie przetworzone poprawnie 0 błąd podczas przetwarzania zlecenia Error Opis błędu, jeżeli status: 2 Tekst 512 Pełny opis błędu, jeżeli wystąpił ErrorCode Kod błędu Liczba 3 0 Nieznany błąd całkowita 1 Brak uprawnień do wykonania danej operacji 23 Błąd walidacji SearchCriteria Kryteria Tekst 16 Numer identyfikacyjny dłużnika, którego chcemy wyszukiwania wyszukać. Dla pola Code = 1 będzie to numer PESEL. Dla pola Code = 2 będzie to inny numer identyfikacyjny. Dla pola Code = 3 będzie to numer NIP. Dla pola Code = 4 będzie to inny numer identyfikacyjny. Dla pola Code = 5 pole jest ignorowane. Dla pole Code = 6 imię i nazwisko właściciela dokumentu. AuthorizationDate Data upoważnienia konsumenta Data Wymagane, gdy pole Code jest równe 1 lub 2. W przeciwnym wypadku puste. Format: rrrr-mm-dd Przykład: (1 kwietnia 2011 roku)

6 2. Pobierane informacje gospodarcze Transza Tovi, która jest wysyłana za pomocą programu Sabar do KRD poza kolumnami z punktu 1 poniższego dokumentu, zawiera 5 kolumn, które zostaną uzupełnione o odpowiednie informacje przez system, jeśli zapytanie będzie trafne. Zwracane informację stanowią sumaryczny wynik przeszukania bazy KRD. W wyniku odnalezienia w bazie numeru identyfikacyjnego transza zwrotna zawiera liczbę zobowiązań, liczbę wszystkich informacji gospodarczych, liczbę wierzycieli, całkowitą kwotę zadłużenia, ilość poszczególnych rodzajów zobowiązań (negatywne, pozytywne oraz o dokumencie), średnią wartość spłaty zobowiązania, średni czas spłaty zobowiązania (w dniach) oraz opcjonalnie sumaryczną wartość spłaconych zobowiązań. Wszystkie kwoty podawane są w walucie polskiej (PLN). Tabela 2: Pobierane informacje gospodarcze Nr Nazwa Opis Typ danych Długość Uwagi 8 CreditorCount Ilość wierzycieli dłużnika Liczba całkowita 10 9 ObligationCount Ilość zobowiązań w raporcie Liczba całkowita TotalArrears Całkowita kwota zadłużenia Liczba rzeczywista PaidObligationCreditorCount Ilość wierzycieli dłużnika dla Liczba całkowita 10 spłaconych zobowiązań 12 PaidObligationCount Ilość pozytywnych zobowiązań Liczba całkowita AveragePaidDebt Średnia wartość spłaty zobowiązania Liczba rzeczywista AveragePaymentTimeInDays Średni czas spłaty zobowiązań Liczba całkowita SumPaidDebt Suma spłaconych zobowiązań Liczba rzeczywista MaxOverdueDays Maksymalna ilość dni opóźnienia Liczba całkowita DocumentInformationCount Ilość informacji o posłużeniu się cudzym lub podrobionym dokumentem Liczba całkowita 10 KONIEC DOKUMENTU