4.2 getFreeUnitsHistory

Souhrný výpis cerpání volných jednotek.

VSTUP:

filter
- array number (nepovinný) – čísla, pro která omezit výpis. Bez filtru vypíše volné jednotky pro všechna čísla
int year – rok výpisu
int month – měsíc výpisu (1-12)

VÝSTUP:

string history – výpis ve formátu CSV
- array item – jeden záznam pro každé číslo
  - string number – telefonní číslo, pro které platí tato sekce
  - array units – jeden záznam pro každou kategorii volných jednotek
    - string description – popis kategorie (dle aktuálního nastavení v ceníku čísla)
    - int available – počet volných jednotek, které mělo číslo na daný měsíc k dispozici
    - int remain – počet jednotek, které číslu zbyly na konci měsíce
    - int transfer – počet jednotek, které se prevádí do dalšího měsíce

int result - kód chyby
string resultText - textový popis chyby

CHYBY:

0 - OK
< 0 – Interní chyba. Popis chyby je v resultText.
> 0 – Chyba vstupních parametrů. Popis chyby je v resultText.

PŘÍKLAD XML ŽÁDOSTI

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:apiipex:providermanagement">
<soapenv:Header>
    <prov:verifyAccess>
    <accessToken></accessToken>
    </prov:verifyAccess>
</soapenv:Header>
<soapenv:Body>
    <urn:getFreeUnitsHistory>
      <filter/>
        <year>2015</year>
        <month>03</month>
    </urn:getFreeUnitsHistory>
</soapenv:Body>
</soapenv:Envelope>

PŘÍKLAD XML ODPOVĚDI

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:apiipex:providermanagement">
<SOAP-ENV:Body>
    <ns1:getFreeUnitsHistoryResponse>
      <history>
        <item>
          <number>777777777</number>
          <units>
            <description>Volné minuty 1</description>
            <available>40</available>
            <remain>38</remain>
            <transfer>20</transfer>
          </units>
          <units>
            <description>Volné minuty 2</description>
            <available>10</available>
            <remain>2</remain>
            <transfer>2</transfer>
          </units>
          <units>
            <description>Volné SMS</description>
            <available>100</available>
            <remain>100</remain>
            <transfer>50</transfer>
          </units>
        </item>
      </history>
      <result>0</result>
      <resultText/>
    </ns1:getFreeUnitsHistoryResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>