GET_I63_LIST

Aprašymas

POS parametrai

Specifikacija

Address

POST https://api.manorivile.lt/client/v2

Header
  • ApiKey : Privalomas. Unikalus API raktas išduodamas užsakant paslaugą
  • Content-Type : Privalomas. Kokiu formatu paduodami parametrai ir duomenys (request):
    • application/xml
    • application/json
  • Accept: Neprivalomas. Gražinamo rezultato (response) formatas
    • application/xml(default)
    • application/json (veikia nuo Manorivile-Gateway-1.1.0 versijos)
Body
  • method : GET_I63_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės I63 nenurodant pačio where tag'o. Neprivaloma
    • pagenumber: įrašų puslapio numeris. GET_LIST metodai rezultatus grąžina puslapiais po 100 įrašų, pagenumber parametras nurodo kelintą puslapį grąžinti. Jei nenurodomas, tuomet grąžinamas pirmas puslapis su 100 naujausių įrašų. Neprivaloma

Sąraše su daugiau nei 1 įrašu informacija visada grąžinama surūšiuota pagal atitinkamos lentelės raktą (Primary Key)

GET_LIST metodų apribojima 100 įrašų, todėl norint gauti visą sąrašą, turite naudoti filtrus, kurie grąžins rezultatą dalimis per kelis kartus, filtruojant pagal paskutinio gauto įrašo rakto reikšmę.

pvz application/xml:

<body>
    <method>GET_I63_LIST</method>
    <params>
        <fil>i63_kodas_kk='POS01'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_I63_LIST",
    "params": {
        "fil": "i63_kodas_kk='POS01'"
    }
}
Response (status 200 OK)

Grąžinama informacija XML formate tarp tag'ų <RET_DOK>..</RET_DOK>. Esant daugiau nei vienam įrašui informacija rūšiuojama (order) pagal lentelės raktinį lauką I63_KODAS_KK

Jeigu įrašų nerasta pagal užduotas sąlygas, tuomet gražinama status=200 bei tuščias tag'as

pvz:

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <I63>
        <Row_number>1</Row_number>
        <I63_KODAS_KK>POS01</I63_KODAS_KK>
        <I63_TIPAS>1</I63_TIPAS>
        <I63_PAV>Padalinys 01</I63_PAV>
        <I63_KODAS>01</I63_KODAS>
        <I63_SKYR>0.00</I63_SKYR>
        <I63_ADDUSR>MASTER</I63_ADDUSR>
        <I63_USERIS>MASTER</I63_USERIS>
        <I63_R_DATE>2020-07-31T15:50:45</I63_R_DATE>
        <I63_SP_PROG></I63_SP_PROG>
        <I63_POZ_GR>0</I63_POZ_GR>
        <I63_POZ_UZT>0</I63_POZ_UZT>
        <I63_POZ_DC>0</I63_POZ_DC>
    </I63>
    <I63>
        <Row_number>2</Row_number>
        <I63_KODAS_KK>POS01</I63_KODAS_KK>
        <I63_TIPAS>2</I63_TIPAS>
        <I63_PAV></I63_PAV>
        <I63_KODAS>MASTER</I63_KODAS>
        <I63_SKYR>0.00</I63_SKYR>
        <I63_ADDUSR>MASTER</I63_ADDUSR>
        <I63_USERIS>MASTER</I63_USERIS>
        <I63_R_DATE>2020-07-31T15:50:57</I63_R_DATE>
        <I63_SP_PROG></I63_SP_PROG>
        <I63_POZ_GR>0</I63_POZ_GR>
        <I63_POZ_UZT>0</I63_POZ_UZT>
        <I63_POZ_DC>0</I63_POZ_DC>
    </I63>
    <I63>
        <Row_number>3</Row_number>
        <I63_KODAS_KK>POS01</I63_KODAS_KK>
        <I63_TIPAS>3</I63_TIPAS>
        <I63_PAV>SEB bankas</I63_PAV>
        <I63_KODAS>2710</I63_KODAS>
        <I63_SKYR>0.00</I63_SKYR>
        <I63_ADDUSR>MASTER</I63_ADDUSR>
        <I63_USERIS>MASTER</I63_USERIS>
        <I63_R_DATE>2020-07-31T15:51:12</I63_R_DATE>
        <I63_SP_PROG></I63_SP_PROG>
        <I63_POZ_GR>0</I63_POZ_GR>
        <I63_POZ_UZT>0</I63_POZ_UZT>
        <I63_POZ_DC>0</I63_POZ_DC>
    </I63>
</RET_DOK>
Response (status 400)

Klaida paduodant duomenis / SQL sintaksės klaidos / kitos DB klaidos

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id>21313695680.624ecc7e.1596200145167</id>
    <durationMs>4</durationMs>
    <errorMessage>Invalid column name 'i63_kodas_ksk'.</errorMessage>
</RET_DOK>
Response (status 401)

Blogai nurodytas adresas / neteisingai nurodytas API raktas / nenurodytas API raktas / pasibaigęs API rakto galiojimas, pvz

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>0</durationMs>
    <errorMessage>Api key is not valid</errorMessage>
</RET_DOK>
Response (status 502)

Nepaleistas MANO Rivile Gateway arba kitaip sutrikusi jo veikla

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>0</durationMs>
    <errorMessage>Rivile GAMA database is unavailable. Please check if the gateway is running and is set up correctly.</errorMessage>
</RET_DOK>
Response (status 504)

Laiku nebuvo gautas Rivile API užklausos atsakymas, pavyzdžiui, apkrauta GAMA duomenų bazė

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>0</durationMs>
    <errorMessage>No response received from client gateway</errorMessage>
</RET_DOK>
Response (status 500)

Bendrinė sistemos klaida, pvz

<?xml version='1.0' encoding='UTF-8'?>
<Map>
    <timestamp>2020-02-05T12:34:26.890+0000</timestamp>
    <status>500</status>
    <error>Internal Server Error</error>
    <message>No message available</message>
    <path>/v1</path>
</Map>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: uUCz6UD.sKVrjaWRDJAH1c7l4qL2nOoN2K0jARkvuHDdYsss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "GET_I63_LIST",
    "params": {
        "fil": "i63_kodas_kk=\'POS01\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I63

Laukas Tipas Aprašymas Pastabos naudojant EDIT metodus
I63_KODAS_KK C(12) POS kodas
I63_TIPAS N(1) Tipas:1-Padalinys,2-Vartotojas,3-Mokėjimo kodas
I63_PAV C(40) Komentaras
I63_KODAS C(12) Padalinio,vartotojo,sąskaitos kodas
I63_SKYR N(6,2) Skyrius (Kreditui)
I63_ADDUSR C(12) Kas sukūrė
I63_USERIS C(12) Kas koregavo
I63_R_DATE T(8) Kada koregavo
I63_SP_PROG C(40) Nefiskalinio kvito spausdinimo programa
I63_POZ_GR N(1) Pinigų gryninimo požymis
I63_POZ_UZT N(1) Užstatas
I63_POZ_DC N(1) DČ požymis