Schema bimoR.v1
Schema bimoR.v1 : Typ złożony GetStatisticResponse
Typ złożony GetStatisticResponse
Opis
Rezultat przetworzenia zamówienia wartości statystycznej
Typ elementu wyjściowego dla operacji getStatisticRequest w BIG API, zawiera listę możliwych rezultatów operacji.
Przestrzeń nazw http://api.big.pl/bimoR/v1
Typ podstawowy
Diagram
Element success Element requestError Element authorisationError Choice Typ złożony GetStatisticResponse
Przegląd
GetStatisticResponse Extension of Typ złożony ResponseAbstract
Rezultat przetworzenia zamówienia wartości statystycznej
Typ elementu wyjściowego dla operacji getStatisticRequest w BIG API, zawiera listę możliwych rezultatów operacji.
Choice
Sequence
errorType Typ prosty authErrorTypeEnum
Typ błędu autoryzacji
Typ błędu autoryzacji związany z rezultatem przetwarzania komunikatu przez system.
errorDescription Typ prosty string
Opis typu błędu autoryzacji
Opis typu błędu autoryzacji związany z rezultatem przetwarzania komunikatu przez system.
requestError Typ złożony RequestError
Błąd walidacji zamówienia
Sequence
currentRequest optional Typ złożony RequestAbstract
Bieżące zapytanie
operationType optional Typ prosty getOperationTypeEnum
Rodzaj operacji
Kod określający rodzaj wywołanej operacji, dla której system przeprowadził walidację zapytania
validationError 1..∞ Typ złożony ValidationError
Błąd walidacji
Kolekcja wykrytych przez system błędów walidacji
Sequence
orderNumber Typ prosty int6
Numer kolejny błędu
Numer kolejny błędu walidacji wykrytego w komunikacie. Numeracja zaczyna się od „1”.
validationRuleId Typ prosty string32
Kod błędu
Kod błędu walidacji
message optional Typ prosty string
Opis błędu
Opis błędu walidacji
faultyElementPath optional Typ prosty string
XPath
XPath do błędnej ścieżki komunikatu
dependentElementPath optional Typ prosty string
Xpath do pola zależnego
Xpath do pola zależnego, względem pola, do którego zgłoszony został błąd (@ValidationError.faultyElementPath)
success Typ złożony GetStatisticSuccess
Poprawny rezultat przetworzenia zamówienia
Sequence
currentRequest Typ złożony GetStatisticRequest
Bieżące zapytanie o wartość
Sequence
Choice
client Typ złożony Subscriber
Subskrybent
Subskrybent BIG API składający zapytanie
proxy Typ złożony Proxy
Przedstawiciel innego subskrybenta
Informacje o przedstawicielu klienta BIG IM, wywołującym operację BIG API w jego imieniu.
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)
Choice
propertyName Typ prosty propertiesEnum
Nazwa właściwości
Kod identyfikujący wartość pochodzącą z SIBIG, jaka ma być zwrócona w rezultacie przetworzenia operacji.
customPropertyName Typ prosty string100
Nazwa dedykowanej właściwości
Choice
property xs:anySimpleType
Zamówiona wartość
Wartość właściwości SIBIG wskazanej w zapytaniu.
Używany przez
Źródło
<xs:complexType name="GetStatisticResponse" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Rezultat przetworzenia zamówienia wartości statystycznej</div>
      <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Typ elementu wyjściowego dla operacji getStatisticRequest w BIG API, zawiera listę możliwych rezultatów operacji.</div>
    </xs:documentation>
  </xs:annotation>
  <xs:complexContent>
    <xs:extension base="bc:ResponseAbstract">
      <xs:choice>
        <xs:element name="authorisationError" type="bc:AuthorisationError">
          <xs:annotation>
            <xs:documentation>
              <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Błąd autoryzacji</div>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="requestError" type="br:RequestError">
          <xs:annotation>
            <xs:documentation>
              <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Błąd walidacji zamówienia</div>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="success" type="br:GetStatisticSuccess">
          <xs:annotation>
            <xs:documentation>
              <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Poprawny rezultat przetworzenia zamówienia</div>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>
Zobacz także