GET_A24_LIST

Aprašymas

Algos 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_A24_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės A24 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_A24_LIST</method>
    <params>
        <list>A</list>
        <fil>A24_DOK_NR='LI0000000006'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_A24_LIST",
    "params": {
        "list": "A",
        "fil": "A24_DOK_NR='LI0000000006'"
    }
}
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ą A24_KODAS_LI

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

pvz.:

<RET_DOK>
    <A24>
        <row_number>1</row_number>
        <A24_KODAS_LI>000R00000030</A24_KODAS_LI>
        <A24_KODAS_TB>004         </A24_KODAS_TB>
        <A24_DOK_NR>LI0000000006</A24_DOK_NR>
        <A24_DATE>2024-11-18T00:00:00</A24_DATE>
        <A24_DATE_PB>2024-11-18T00:00:00</A24_DATE_PB>
        <A24_TIPAS>1</A24_TIPAS>
        <A24_PAV>v4                                                          </A24_PAV>
        <A24_VID_TIP>1</A24_VID_TIP>
        <A24_TB_KOR>1</A24_TB_KOR>
        <A24_KODAS_LG>           </A24_KODAS_LG>
        <A24_PASTABOS></A24_PASTABOS>
        <A24_SUMAM>0.00</A24_SUMAM>
        <A24_VIDUR>0.00</A24_VIDUR>
        <A24_LIG_TIP_POZ>0</A24_LIG_TIP_POZ>
        <A24_LIG_TIP>1</A24_LIG_TIP>
        <A24_KODAS_LS_1>           </A24_KODAS_LS_1>
        <A24_KODAS_LS_2>           </A24_KODAS_LS_2>
        <A24_KODAS_LS_3>           </A24_KODAS_LS_3>
        <A24_KODAS_LS_4>           </A24_KODAS_LS_4>
        <A24_EIL1>                                                 </A24_EIL1>
        <A24_EIL2>                                                 </A24_EIL2>
        <A24_EIL3>                                                 </A24_EIL3>
        <A24_EIL4>                                                 </A24_EIL4>
        <A24_EIL5>                                                 </A24_EIL5>
        <A24_NUM1>0.00</A24_NUM1>
        <A24_NUM2>0.00</A24_NUM2>
        <A24_NUM3>0.00</A24_NUM3>
        <A24_NUM4>0.00</A24_NUM4>
        <A24_NUM5>0.00</A24_NUM5>
        <A24_PERKELTA>1</A24_PERKELTA>
        <A24_USERIS>abcdef          </A24_USERIS>
        <A24_ADDUSR>abcdef          </A24_ADDUSR>
        <A24_R_DATE>2024-11-18T00:00:00</A24_R_DATE>
        <A24_KODAS_IS>           </A24_KODAS_IS>
        <A24_DOK_DATE>2024-11-18T00:00:00</A24_DOK_DATE>
        <A24_KODAS_GS>           </A24_KODAS_GS>
        <A24_BUSENA>1</A24_BUSENA>
        <A24_DATE_PR>2024-11-18T00:00:00</A24_DATE_PR>
        <A24_LAIKAS_MOK>0.00</A24_LAIKAS_MOK>
    </A24>
</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.370318fa.1736409498852</id>
    <durationMs>2</durationMs>
    <errorMessage>Invalid column name 'A24_DOKR_NR'.</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_A24_LIST",
    "params": {
        "list": "A",
        "fil": "A24_DOK_NR=\'LI0000000006\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

A24

Nuoroda į lentelės aprašymą: A24