GET_K42_LIST

Aprašymas

DVS 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_K42_LIST
  • params :
    • list : H - gražinama tik pagrindinė informacija (K42) (default). Jeigu A - grąžinama visa susijusi informacija (K42+K41).
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės K42 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ę.

Nuskaitomos tik operacijos, kurioms API rakto prefiksas turi leidimus.

pvz application/xml:

<body>
    <method>GET_K42_LIST</method>
    <params>
        <list>H</list>
        <fil>k42_kodas_od='010R00000001'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_K42_LIST",
    "params": {
        "list": "H",
        "fil": "k42_kodas_od='010R00000001'"
    }
}
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ą K42_KODAS_OD

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

pvz, kai list='A':

<RET_DOK>
    <K42>
        <Row_number>1</Row_number>
        <K42_KODAS_OD>010R00000001</K42_KODAS_OD>
        <K42_TEVAS></K42_TEVAS>
        <K42_PAV></K42_PAV>
        <K42_TIPAS>5</K42_TIPAS>
        <K42_LYGIS>0</K42_LYGIS>
        <K42_KODAS_RD>SS_RA01</K42_KODAS_RD>
        <K42_OP_DATA>2024-01-01T00:00:00</K42_OP_DATA>
        ...
        <K41>
            <K41_KODAS_RD>SS_RA01</K41_KODAS_RD>
            <K41_PAV>Raštai</K41_PAV>
            <K41_TIPAS>5</K41_TIPAS>
            ...
        </K41>
    </K42>
</RET_DOK>

pvz, kai list='H'

<RET_DOK>
    <K42>
        <Row_number>1</Row_number>
        <K42_KODAS_OD>010R00000001</K42_KODAS_OD>
        <K42_TEVAS></K42_TEVAS>
        <K42_PAV></K42_PAV>
        <K42_TIPAS>5</K42_TIPAS>
        <K42_LYGIS>0</K42_LYGIS>
        <K42_KODAS_RD>SS_RA01</K42_KODAS_RD>
        <K42_OP_DATA>2024-01-01T00:00:00</K42_OP_DATA>
        ...
    </K42>
</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>25</durationMs>
    <errorMessage>Invalid column name 'k42_kodas_oo'.</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.sKVrjWWRDJAH1c7l4LL2nOoN2K0jARkvuHDdYsss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "GET_K42_LIST",
    "params": {
        "list": "H",
        "fil": "k42_kodas_od='010R00000001'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

K42

Nuoroda į lentelės aprašymą: k42