Element getOrderListRequest

Opis

Wywołanie operacji pobrania listy zarejestrowanych zleceń [niedostępne]

Element wejściowy dla operacji pobrania listy zarejestrowanych zleceń. Wywołanie nie jest obsługiwane w aktualnej wersji BIG API.

Przestrzeń nazw

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

Typ

Typ złożony OrderListRequest

Diagram

Przegląd

getOrderListRequest Typ złożony OrderListRequest

Wywołanie operacji pobrania listy zarejestrowanych zleceń [niedostępne]

Element wejściowy dla operacji pobrania listy zarejestrowanych zleceń. Wywołanie nie jest obsługiwane w aktualnej wersji BIG API.

orderId optional Typ prosty string32

Identyfikator zlecenia

Identyfikator zlecenia nadany przez System

userId optional xs:string

Identyfikator użytkownika

Identyfikator systemowy użytkownika, który zarejestrował zlecenie

limit optional xs:int

Ilość rekordów

Ilość rekordów do zwrócenia

start optional xs:int

Numer porządkowy pierwszego rekordu

Sequence

Choice

client Typ złożony Subscriber

Klient BIG IM przeprowadzający operację

Element, który zawiera identyfikatory Klienta zlecającego operację

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 Klienta

Identyfikatory Przedstawiciela klienta BIG IM, przeprowadzający operację w jego imieniu

Sequence

proxy Typ złożony Subscriber

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

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.

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

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.

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.

validityDateTime optional Typ prosty dateTime

Data i czas aktualności danych

Wskazanie daty i czasu na który aktualne są przekazywane do BIG InfoMonitor dane. Domyślnie SIBIG przyjmuje, że przekazywane dane są aktualne na moment wywołania usługi BIG InfoMonitor przez system Subskrybenta.

orderTypeFilter optional Typ złożony OrderTypeSpecificFilter

Konfiguracja filtra listy

Element opisujący filtr ze względu na typ zlecenia wraz z ewentulanymi filtrami specyficznymi dla określonego typu zlecenia

orderStatusList optional Typ złożony OrderStatusList

Konfigracja filtra statusu

Element opisujący filtr ze względu na listę statusów przetwarzania zlecenia

Sequence

orderStatus 1..7 Typ prosty orderStatusEnum

Status zlecenie

Staus zlecenia

orderDateCriterion optional Typ złożony DateCriterion

Filtr ze względu na datę zlecenia

Element opisujący filtr ze względu na datę zlecenia

Sequence

earliestDate optional Typ prosty date

Data od

Data rozpoczynająca okres w którym wyszukiwane są zlecenia

latestDate optional Typ prosty date

Data do

Data kończąca okres w którym wyszukiwane są zlecenia

processingStartCriterion optional Typ złożony DateCriterion

Filtr ze względu na datę rozpoczęcia przetwarzania zlecenia

Element opisujcy Filtr ze względu na datę rozpoczęcia przetwarzania zlecenia

Sequence

earliestDate optional Typ prosty date

Data od

Data rozpoczynająca okres w którym wyszukiwane są zlecenia

latestDate optional Typ prosty date

Data do

Data kończąca okres w którym wyszukiwane są zlecenia

Źródło

<xs:element name="getOrderListRequest" type="bs:OrderListRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Wywołanie operacji pobrania listy zarejestrowanych zleceń [niedostępne]</div>
      <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Element wejściowy dla operacji pobrania listy zarejestrowanych zleceń. Wywołanie nie jest obsługiwane w aktualnej wersji BIG API.</div>
    </xs:documentation>
  </xs:annotation>
</xs:element>

Zobacz także

Schema bimoS.v1