GET_I11_LIST

Aprašymas

Atsargų operacijų 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_I11_LIST
  • params :
    • list : H - gražinama tik pagrindinė informacija (I11) (default). Jeigu A - gražinama visa susijusi informacija (I11+I12).
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės I11 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_I11_LIST</method>
    <params>
        <list>H</list>
        <fil>i11_kodas_in='010000000104'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_I11_LIST",
    "params": {
        "list": "H",
        "fil": "i11_kodas_in='010000000104'"
    }
}
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ą I11_KODAS_IN

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

pvz, kai list='A':

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <I11>
        <Row_number>1</Row_number>
        <I11_KODAS_IN>010000000104</I11_KODAS_IN>
        <I11_TIPAS>1</I11_TIPAS>
        <I11_DOK_NR>000000000067</I11_DOK_NR>
        <I11_PAV>                                       </I11_PAV>
        <I11_OP_DATA>2020-01-17T00:00:00</I11_OP_DATA>
        <I11_KODAS_IS>01</I11_KODAS_IS>
        <I11_PERKELTA>2</I11_PERKELTA>
        ...
        <I12>
            <I12_KODAS_IN>010000000104</I12_KODAS_IN>
            <I12_EIL_NR>1</I12_EIL_NR>
            <I12_TIPAS>1</I12_TIPAS>
            <I12_KODAS_PS>005</I12_KODAS_PS>
            <I12_KODAS_SS>6000</I12_KODAS_SS>
            <I12_KODAS_OS></I12_KODAS_OS>
            <I12_SERIJA></I12_SERIJA>
            <I12_KODAS_US>VNT</I12_KODAS_US>
            <I12_FRAKCIJA_A>1</I12_FRAKCIJA_A>
            <I12_KIEKIS_A>10</I12_KIEKIS_A>
            <I12_PAV>HDD</I12_PAV>
            <I12_KIEKIS>10</I12_KIEKIS>
            <I12_FRAKCIJA>1</I12_FRAKCIJA>
            <I12_PIRK_KAINA>150.0000</I12_PIRK_KAINA>
            <I12_SAV_SUMA>1500.00</I12_SAV_SUMA>
            ...
        </I12>
        <I12>
            <I12_KODAS_IN>010000000104</I12_KODAS_IN>
            <I12_EIL_NR>2</I12_EIL_NR>
            <I12_TIPAS>1</I12_TIPAS>
            <I12_KODAS_PS>006</I12_KODAS_PS>
            ...
        </I12>
    </I11>
</RET_DOK>

pvz, kai list='H'

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <I11>
        <Row_number>1</Row_number>
        <I11_KODAS_IN>010000000104</I11_KODAS_IN>
        <I11_TIPAS>1</I11_TIPAS>
        <I11_DOK_NR>000000000067</I11_DOK_NR>
        <I11_PAV>                                       </I11_PAV>
        <I11_OP_DATA>2020-01-17T00:00:00</I11_OP_DATA>
        <I11_KODAS_IS>01</I11_KODAS_IS>
        <I11_PERKELTA>2</I11_PERKELTA>
        ...
    </I11>
</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 'i11_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_I11_LIST",
    "params": {
        "list": "H",
        "fil": "i11_kodas_in=\'010000000104\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I11

Nuoroda į lentelės aprašymą: I11

I12

Nuoroda į lentelės aprašymą: I12