1. Wstęp
  2. Corporate Node
  3. Operacje SOAP
  4. getHistoryReport

getHistoryReport

Operacja getHistoryReport zwraca historię węzła CNode z zadanego przedziału czasowego.

Odpowiedź zawiera podsumowanie wszystkich transakcji danym okresie, stan konta węzła CNode, ostrzeżenia o terminie ważności monet oraz pełną listę wszystkich transakcji w danym okresie. To ostatnie może także zostać zapisane do arkusza CSV na serwerze węzła CNode o podanej nazwie. Zwracana lista transakcji domyślnie jest w formacie CSV, można zmienić ją na format JSON.

Przykładowe zapytanie SOAP:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:ns="ns1">
 <SOAP-ENV:Body  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
  <ns:getHistoryReport>
   <filename>test.csv</filename>
   <fromDate>2018/01/17 12:00:00</fromDate>
   <toDate>2018/07/17 12:41:33</toDate>
   <onlyTransactions>false</onlyTransactions>
   <disableMonexCheck>false</disableMonexCheck>
   <format>JSON</format>
  </ns:getHistoryReport>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Przykładowa odpowiedź SOAP:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:ns="ns1">
 <SOAP-ENV:Body  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
  <ns:getHistoryReportResponse>
   <return>
    <summary>Last transfers summary (2018-01-17 12:00:00 to 2018-07-17 12:41:33):

	total:  0
	in:  0
	out:  0
	passed transfers: 0 (0%)
	failed transfers: 3 (100%)
	ongoing transfers: 0 (0%)


Current balance:
	freeBalance:  5.760PLN
	lockedBalance:  0.000PLN
	vaultBalance:  0.200PLN

Technical transaction summary:
	(100%) FINISHED_ERR x 3

    </summary>
    <history>
Type;StartDate;StartTime;Date;Time;Amount;CommissionAmount;Comment;Service;Payer;PayerId;RecipientName;RecipientId;RecipientBestName;IPEorARId;UniqueTransferId;TransferId;State;Status;MachineName;MachineBalance;VaultBalance
First soap received;;;16-07-2018;13:33:38;;;"";;;;;;;;;;MTS_END_OK;LOGIN_SUCCESS;;;
User logged in;;;16-07-2018;13:34:00;;;"";;;;;;;;;;MTS_END_OK;LOGIN_SUCCESS;vui 127.0.0.1;;
Vui ready;;;16-07-2018;13:34:14;;;"";;;;;;;;;;MTS_END_OK;LOGIN_SUCCESS;vui 127.0.0.1;;
Bank transfer;16-07-2018;13:49:00;16-07-2018;13:49:22;-5.000PLN;;"";;;;;;;3SA1PCQKM184MJ9241U8MV343H;;JFuYWNXae5EVEwa31bS37a;MTS_END_FAILURE;BORG_CODE_UNINITIALIZED;vui 127.0.0.1;0.760PLN;-
    </history>
    <requestStatus>SUCCESS</requestStatus>
    <requestStatusDescription>Request succeeded.</requestStatusDescription>
   </return>
  </ns:getHistoryReportResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Parametry zapytania:

ParametrTypOpisWymagane?Specyfikacja
filenamestringNazwa pliku na serwerze węzła CNode, do którego ma zostać zapisana historia w formacie CSV; jeśli nie zostanie podane, to operacja nie zapisze pliku i zwróci dane w formacie JSONNieMusi być krótszy niż 1000 znaków
fromDatestringData, od której ma zostać pobrana historiaNieData musi być w formacie YYYY/MM/DD HH:MM:SS
toDatestringData, do której ma zostać pobrana historiaNieData musi być w formacie YYYY/MM/DD HH:MM:SS
onlyTransactionsstring„true”, jeśli zapytanie ma pobierać jedynie operacje, które są transakcjamiNie
disableMonexCheckstring„true”, jeśli operacja ma sprawdzać daty ważności monetNie
formatstringformat, w jakim ma zostać zwrócona historiaNieJSON lub CSV

Parametry odpowiedzi:

NazwaTypOpis
sumarystringpodsumowanie transakcji i informacje o stanie konta cNode
historystringlista wszystkich operacji węzła CNode w danym okresie, w formacie JSON lub CSV
requestStatusDescriptionstringopis statusu
requestStatusstringstatus wykonania zapytania
Czy ten artykuł jest dla Ciebie pomocny? Tak Nie

Jak możemy pomóc?