GET_I51_LIST

Aprašymas

Kaupiklio 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_I51_LIST
  • params :
    • list : H - gražinama tik pagrindinė informacija (I51) (default). Jeigu A - grąžinama visa susijusi informacija (I51+I52).
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės I51 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 į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_I51_LIST</method>
    <params>
        <list>H</list>
        <fil>i51_laikas='2024-01-01'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_I51_LIST",
    "params": {
        "list": "H",
        "fil": "i51_laikas='2024-01-01'"
    }
}
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ą I51_KODAS_KP

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

pvz, kai list='A':

<RET_DOK>
    <I51>
        <Row_number>1</Row_number>
        <I51_KODAS_KP>010R00000001</I51_KODAS_KP>
        <I51_KODAS_KK></I51_KODAS_KK>
        <I51_LAIKAS>2024-01-01T00:00:00</I51_LAIKAS>
        <I51_PAV>Kaupiklis 1</I51_PAV>
        <I51_PERKELTA>1</I51_PERKELTA>
        ...
        <I52>
            <I52_KODAS_KP>010R00000001</I52_KODAS_KP>
            <I52_EIL_NR>1</I52_EIL_NR>
            <I52_BAR_KODAS>000000000123</I52_BAR_KODAS>
            <I52_KIEKIS>0.0000</I52_KIEKIS>
            <I52_KAINA>0.0000</I52_KAINA>
            ...
        </I52>
        <I52>
            <I52_KODAS_KP>010R00000001</I52_KODAS_KP>
            <I52_EIL_NR>2</I52_EIL_NR>
            <I52_BAR_KODAS>000000000123</I52_BAR_KODAS>
            <I52_KIEKIS>0.0000</I52_KIEKIS>
            <I52_KAINA>0.0000</I52_KAINA>
            ...
        </I52>
    </I51>
</RET_DOK>

pvz, kai list='H'

<RET_DOK>
    <I51>
        <Row_number>1</Row_number>
        <I51_KODAS_KP>010R00000001</I51_KODAS_KP>
        <I51_KODAS_KK></I51_KODAS_KK>
        <I51_LAIKAS>2024-01-01T00:00:00</I51_LAIKAS>
        <I51_PAV>Kaupiklis 1</I51_PAV>
        <I51_PERKELTA>1</I51_PERKELTA>
        ...
    </I51>
</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/>
    <durationMs>0</durationMs>
    <errorMessage>Invalid column name 'i51_laikas1'.</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>2024-01-01T00:00:01.001+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.sKVrjWWRDJAH1c7l4LG2nOoN2K0jARkvuHDdYsss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "GET_I51_LIST",
    "params": {
        "list": "H",
        "fil": "i51_laikas1='2024-01-01'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I51

Nuoroda į lentelės aprašymą: i51

I52

Nuoroda į lentelės aprašymą: i52