GET_I06_LIST

Aprašymas

Pirkimų, pardavimų dokumentų sąrašas

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_I06_LIST
params :
- list : H - gražinama tik pagrindinė informacija (I06) (default). Jeigu A - gražinama visa susijusi informacija (I06+I07+I08+I13).
- fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės I06 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_I06_LIST</method>
    <params>
        <list>H</list>
        <fil>i06_kodas_po='010000001252'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_I06_LIST",
    "params": {
        "list": "H",
        "fil": "i06_kodas_po='010000001252'"
    }
}

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ą I06_KODAS_PO

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

Tagai DOKUMENTAS, DOKUMENTAI skirti prisegtų prie operacijos dokumentų ar dokumentų nuorodų skaičiui gauti.

Jei perduosite metoduose EDIT_I06 arba EDIT_I06_FULL tagą NUORODA su nuorodą į failą ar katalogą, tuomet gausite grąžiname rezultate <DOKUMENTAS>1</DOKUMENTAS> ir <NUORODA>https://www....lt/nuoroda</NUORODA>.

pvz, kai list='A':

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <I06>
        <Row_number>1</Row_number>
        <I06_KODAS_PO>010000001252</I06_KODAS_PO>
        <I06_OP_TIP>51</I06_OP_TIP>
        <I06_VAL_POZ>0</I06_VAL_POZ>
        <I06_PVM_TIP>0</I06_PVM_TIP>
        <I06_DOK_NR>DOK-001</I06_DOK_NR>
        <I06_OP_STORNO>0</I06_OP_STORNO>
        <I06_OP_DATA>2020-01-30T00:00:00</I06_OP_DATA>
        <I06_DOK_DATA>2020-01-30T00:00:00</I06_DOK_DATA>
        <I06_KODAS_MS></I06_KODAS_MS>
        <I06_KODAS_KS>121411842</I06_KODAS_KS>
        <I06_KODAS_SS></I06_KODAS_SS>
        <I06_PAV>UAB "Rivilė"</I06_PAV>
        <I06_ADR>Geležinio Vilko 5-48, Vilnius</I06_ADR>
        <I06_SUMA>1500.00</I06_SUMA>
        <I06_SUMA_PVM>315.00</I06_SUMA_PVM>
        ...
        <DOKUMENTAS>1</DOKUMENTAS>
        <DOKUMENTAI>0</DOKUMENTAI>
        <NUORODA>https://www....lt/nuoroda</NUORODA>
        <I13>
            <I13_KODAS_PO>010000001252</I13_KODAS_PO>
            <I13_EIL_NR>1</I13_EIL_NR>
            <I13_KODAS_SS>2721</I13_KODAS_SS>
            <I13_SUMA>1815.00</I13_SUMA>
            <I13_SUMA_VAL>0.00</I13_SUMA_VAL>
            ...
        </I13>
        <I08_PART>
            <I08_KODAS_PO>010000001252</I08_KODAS_PO>
            <I08_EIL_NR>1</I08_EIL_NR>
            <I08_NUOL_D>0</I08_NUOL_D>
            <I08_NUOL_P>0.00000</I08_NUOL_P>
            <I08_MOK_D>10</I08_MOK_D>
            <I08_MOK_P>100.00000</I08_MOK_P>
            ...
        </I08>
        <I07>
            <I07_KODAS_PO>010000001252</I07_KODAS_PO>
            <I07_EIL_NR>1</I07_EIL_NR>
            <I07_TIPAS>1</I07_TIPAS>
            <I07_KODAS>004</I07_KODAS>
            <I07_PAV>Kompiuteris</I07_PAV>
            <I07_KODAS_TR></I07_KODAS_TR>
            <I07_KODAS_IS>01</I07_KODAS_IS>
            <I07_KODAS_OS></I07_KODAS_OS>
            <I07_KODAS_OS_C></I07_KODAS_OS_C>
            <I07_SERIJA></I07_SERIJA>
            <I07_KODAS_US>VNT</I07_KODAS_US>
            <I07_KIEKIS>1</I07_KIEKIS>
            <I07_FRAKCIJA>1</I07_FRAKCIJA>
            <I07_KODAS_US_P>VNT</I07_KODAS_US_P>
            <I07_KODAS_US_A>VNT</I07_KODAS_US_A>
            <I07_ALT_KIEKIS>1</I07_ALT_KIEKIS>
            <I07_ALT_FRAK>1</I07_ALT_FRAK>
            <I07_KAINA_BE>1000.0000</I07_KAINA_BE>
            <I07_KAINA_SU>1210.0000</I07_KAINA_SU>
            <I07_PVM>210.00</I07_PVM>
            <I07_SUMA>1000.00</I07_SUMA>
            ...
        </I07>
        <I07>
            <I07_KODAS_PO>010000001252</I07_KODAS_PO>
            <I07_EIL_NR>2</I07_EIL_NR>
            <I07_TIPAS>1</I07_TIPAS>
            <I07_KODAS>005</I07_KODAS>
            <I07_PAV>HDD</I07_PAV>
            ...
        </I07>
    </I06>
</RET_DOK>

pvz, kai list='H'

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <I06>
        <Row_number>1</Row_number>
        <I06_KODAS_PO>010000001252</I06_KODAS_PO>
        <I06_OP_TIP>51</I06_OP_TIP>
        <I06_VAL_POZ>0</I06_VAL_POZ>
        <I06_PVM_TIP>0</I06_PVM_TIP>
        <I06_DOK_NR>DOK-001</I06_DOK_NR>
        <I06_OP_STORNO>0</I06_OP_STORNO>
        <I06_OP_DATA>2020-01-30T00:00:00</I06_OP_DATA>
        <I06_DOK_DATA>2020-01-30T00:00:00</I06_DOK_DATA>
        <I06_KODAS_MS></I06_KODAS_MS>
        <I06_KODAS_KS>121411842</I06_KODAS_KS>
        <I06_KODAS_SS></I06_KODAS_SS>
        <I06_PAV>UAB "Rivilė"</I06_PAV>
        <I06_ADR>Geležinio Vilko 5-48, Vilnius</I06_ADR>
        <I06_SUMA>1500.00</I06_SUMA>
        <I06_SUMA_PVM>315.00</I06_SUMA_PVM>
        ...
    </I06>
</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>3451ded.be556121580910178112</id>
    <durationMs>25</durationMs>
    <errorMessage>Invalid column name 'i06_kodas_pob'.</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_I06_LIST",
    "params": {
        "list": "H",
        "fil": "i06_kodas_po=\'010000001252\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I06

Nuoroda į lentelės aprašymą: I06

I07

Nuoroda į lentelės aprašymą: I07

I08

Nuoroda į lentelės aprašymą: I08

I13

Nuoroda į lentelės aprašymą: I13