Typ złożony Report

Opis

Pozytywny rezultat przetworzenia zapytania o raport

Typ używany do przekazywania pozytywnego rezultatu przetworzenia zapytania o raport

Przestrzeń nazw

http://api.big.pl/bimoR/v1

Diagram

Przegląd

Report

Pozytywny rezultat przetworzenia zapytania o raport

Typ używany do przekazywania pozytywnego rezultatu przetworzenia zapytania o raport

Sequence

currentRequest Typ złożony GetReportRequest

Bieżące zapytanie o raport

referenceReportId optional Typ prosty string32

Identyfikator raportu referencyjnego

Identyfikator wcześniej uzyskanego raportu BIG InfoMonitor. Przekazywany w celu powiązania tego historycznego raportu ze złożonym aktualnie zapytaniem. Raporty dotyczące wyłącznie danych ze źródeł zewnętrznych (spoza BIG InfoMonitor), wymagają wskazania referencyjnego zapytania dotyczącego raportu z danymi z BIG InfoMonitor.

Powiązane reguły walidacji:

Identyfikator	Opis
RR49	W rejestrze zapytań subskrybenta składającego zapytanie powtórzone, musi być zapisane dokładnie jedno zapytanie o przekazanym numerze
RR50	Dane zapytania przekazane w zapytaniu powtórzonym musi być zgodne z zapytaniem przekazanym w zapytaniu powtarzanym zidentyfikowanym na podstawie przekazanego numeru referencyjnego. (ten sam rodzaj produktu, zestaw komponentów, danych podmiotu pytanego)
RR68	Identyfikator referencyjnego (pierwotnego) raportu z rejestru zapytań przekazany w żądaniu ponowienia pobrania raportu, musi wskazywać raport z rejestru pobrany przez subskrybenta żądającego ponowienia.
RR71	Zapytanie musi zawierać identyfikator raportu referencyjnego, jeżeli dotyczy produktu bikScoring lub bikVerification.
RR72	Brak opisu reguły.
RR73	Brak opisu reguły.

Sequence

Choice

client Typ złożony Subscriber

Subskrybent

Subskrybent BIG API składający zapytanie

Sequence

clientId Typ prosty id

Identyfikator subskrybenta

Unikalny identyfikator nadawany przez BIG InfoMonitor każdemu subskrybentowi w ramach systemu.

unitId Typ prosty id

Identyfikator jednostki organizacyjnej subskrybenta

Unikalny w ramach Klienta identyfikator nadawany przez BIG InfoMonitor każdej jednostce organizacyjnej subskrybenta.

proxy Typ złożony Proxy

Przedstawiciel innego subskrybenta

Informacje o przedstawicielu klienta BIG IM, wywołującym operację BIG API w jego imieniu.

Sequence

proxy Typ złożony Subscriber

Dane przedstawiciela klienta BIG IM, przeprowadzającego operację w jego imieniu

client Typ złożony Subscriber

Dane klienta BIG IM w imieniu, którego przeprowadzana jest operacja

Powiązane reguły walidacji:

Identyfikator	Opis
RAIG280	Subskrybent będący osobą fizyczną nie może przekazać Informacji Gospodarczej Pozytywnej i o Dokumencie Kwestionowanym

clientUserId Typ prosty string32

Identyfikator operatora

Identyfikator operatora, pracownika Klienta, nadany przez BIG InfoMonitor każdemu użytkownikowi (operatorowi) systemu. W imieniu wskazanego w tym polu operatora wywoływane są operacje w bazie BIG IM.

repeatedRequestMarker optional xs:boolean

Znacznik powtórzonej operacji

Znacznik określający, czy komunikat jest żądaniem powtórzenia zapytania

Powiązane reguły walidacji:

Identyfikator	Opis
RR49	W rejestrze zapytań subskrybenta składającego zapytanie powtórzone, musi być zapisane dokładnie jedno zapytanie o przekazanym numerze
RR50	Dane zapytania przekazane w zapytaniu powtórzonym musi być zgodne z zapytaniem przekazanym w zapytaniu powtarzanym zidentyfikowanym na podstawie przekazanego numeru referencyjnego. (ten sam rodzaj produktu, zestaw komponentów, danych podmiotu pytanego)

reportComposition Typ złożony Composition

Kompozycja raportu

Definicja kompozycji zamawianego produktu

exchangeRateTable optional Typ złożony ExchangeRateTable

Tabela kursów walut

Informacje o użytej tabeli kursów walut NBP. Występują jeśli tabela jest wykorzystywana przez conajmniej jeden komponent raportu.

Sequence

id Typ prosty string

Numer tabeli kursów walut

Numer tabeli kursów walut Narodowego Banku Polskiego.

date Typ prosty date

Data tabeli kursów walut

Data publikacji tabeli kursów walut Narodowego Banku Polskiego.

components Typ złożony ReportComponents

Komponenty raportu

Kolekcja zamówionych komponentów raportu. Każdy komponent zawiera informacje dotyczące przedmiotu zapytania w odpowiedniej dla niego strukturze komunikatu.

Sequence

reportComponent 0..∞ Typ złożony ReportComponent

Komponent raportu

Kolekcja komponentów raportu

Sequence

componentAttributes

Grupa standardowych atrybutów komponentu raportu (produktu elementarnego).

data optional Typ złożony ComponentData

Dane komponentu

Dane zwrócone w wyniku przetworzenia komponentu

customComponent 0..∞ Typ złożony CustomComponent

Dedykowany komponent raportu

Kolekcja dedykowanych komponentów raportu

Sequence

componentAttributes

Grupa standardowych atrybutów komponentu raportu (produktu elementarnego).

customComponentName optional Typ prosty string50

Nazwa komponentu dedykowanego

data optional xs:anyType

Dane komponentu dedykowanego

Dane zwrócone w wyniku przetworzenia komponentu

Używany przez

Element success
Element success

Źródło

<xs:complexType name="Report" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Pozytywny rezultat przetworzenia zapytania o raport</div>
      <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Typ używany do przekazywania pozytywnego rezultatu przetworzenia zapytania o raport</div>
    </xs:documentation>
  </xs:annotation>
  <xs:sequence>
    <xs:element name="currentRequest" type="br:GetReportRequest">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Bieżące zapytanie o raport</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="exchangeRateTable" type="br:ExchangeRateTable" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Tabela kursów walut</div>
          <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Informacje o użytej tabeli kursów walut NBP. Występują jeśli tabela jest wykorzystywana przez conajmniej jeden komponent raportu.</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="components" type="br:ReportComponents">
      <xs:annotation>
        <xs:documentation>
          <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Komponenty raportu</div>
          <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Kolekcja zamówionych komponentów raportu. Każdy komponent zawiera informacje dotyczące przedmiotu zapytania w odpowiedniej dla niego strukturze komunikatu.</div>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>

Zobacz także

Schema bimoR.v1