GET_I47_LIST

Aprašymas

Algos - pareigų 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_I47_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės I47 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_I47_LIST</method>
    <params>
        <list>A</list>
        <fil>I47_KODAS_IF = '000000000010'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_I47_LIST",
    "params": {
        "list": "A",
        "fil": "I47_KODAS_IF = '000000000010'"
    }
}
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ą I47_KODAS_IF

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

pvz.:

<RET_DOK>
    <I47>
        <Row_number>1</Row_number>
        <I47_KODAS_IF>000000000010</I47_KODAS_IF>
        <I47_KODAS_IV>000000000010</I47_KODAS_IV>
        <I47_KODAS_IS>999999999999</I47_KODAS_IS>
        <I47_OP_DATA>2024-12-12T00:00:00</I47_OP_DATA>
        <I47_PASTABOS>                                       </I47_PASTABOS>
        <I47_PERKELTA>2</I47_PERKELTA>
        <I47_USERIS>MASTER      </I47_USERIS>
        <I47_R_DATE>2024-12-12T11:04:29</I47_R_DATE>
        <I47_ADDUSR>MASTER      </I47_ADDUSR>
        <I47_KODAS_SM>           </I47_KODAS_SM>
        <I47_BUSENA>1</I47_BUSENA>
        <I48_IVFD>
            <I48>
                <I48_KODAS_IF>000000000010</I48_KODAS_IF>
                <I48_EIL_NR>1</I48_EIL_NR>
                <I48_KODAS_PS>545         </I48_KODAS_PS>
                <I48_PAV>Mažų likučių prekė                      </I48_PAV>
                <I48_KODAS_US>VNT         </I48_KODAS_US>
                <I48_FRAKCIJA>1</I48_FRAKCIJA>
                <I48_KIEKIS>545</I48_KIEKIS>
                <I48_KAINA>0.0000</I48_KAINA>
                <I48_KODAS_OS>           </I48_KODAS_OS>
                <I48_SERIJA>              </I48_SERIJA>
                <I48_USERIS>MASTER      </I48_USERIS>
                <I48_R_DATE>2024-12-12T11:04:23</I48_R_DATE>
                <I48_ADDUSR>MASTER      </I48_ADDUSR>
            </I48>
        </I48_IVFD>
    </I47>
</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>4641133481.86fdf0ea.1736410135240</id>
    <durationMs>2</durationMs>
    <errorMessage>Invalid column name 'I47_KODASS_IF'.</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: abcdef.12345',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "GET_I47_LIST",
    "params": {
        "list": "A",
        "fil": "I47_KODAS_IF = \'000000000010\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I47

Nuoroda į lentelės aprašymą: I47