GET_A02_LIST

Aprašymas

Algos kintamųjų reikšmių 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_A02_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės A02 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ę.

Kadangi darbuotojų kortelėse gali būti saugoma konfidenciali informacija, jau egzistuojančių įrašų nuskaitymui ir koregavimui būtinas papildomas leidimas per Rivile Gama parametrą RGI_A02_FIL. Šiame parametre įvedamas papildomas filtravimas, galimų reikšmių pavyzdžiai: 1=1 (visos darbuotojų kortelės), A02_KODAS_TB='004' (tik darbuotojų kortelės su tabeliniu kodu '004'). Filtravimo sąlygose galima naudoti visus lentelės A02 laukus.

pvz application/xml:

<body>
    <method>GET_A02_LIST</method>
    <params>
        <fil>a02_kodas_lk='000000025003'</fil>
        <pageNumber>1</pageNumber>
    </params>
</body>

pvz application/json:

{
    "method": "GET_A02_LIST",
    "params": {
        "fil": "a02_kodas_lk = '000000025003'",
        "pageNumber": 1
    }
}
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ą A02_KODAS_LK

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

<RET_DOK>
    <A02>
        <Row_number>1</Row_number>
        <A02_KODAS_LK>000000025003</A02_KODAS_LK>
        <A02_TIPAS>4</A02_TIPAS>
        <A02_DATE>2025-01-01T00:00:00</A02_DATE>
        <A02_PAV>test - žmogaus padal v4 p4(darbuotojas r1 UAB "Rivilė"2     </A02_PAV>
        <A02_KODAS_TB>004         </A02_KODAS_TB>
        <A02_KODAS_IS>999999999998</A02_KODAS_IS>
        <A02_SUMA>0.000</A02_SUMA>
        <A02_PASTABOS>  </A02_PASTABOS>
        <A02_USERIS>MASTER      </A02_USERIS>
        <A02_R_DATE>2025-02-04T11:13:11</A02_R_DATE>
        <A02_KODAS_OS>           </A02_KODAS_OS>
        <A02_KODAS_LI>           </A02_KODAS_LI>
    </A02>
    <A02>
        <Row_number>2</Row_number>
        <A02_KODAS_LK>000000025003</A02_KODAS_LK>
        <A02_TIPAS>4</A02_TIPAS>
        <A02_DATE>2025-01-01T00:00:00</A02_DATE>
        <A02_PAV>test - žmogaus padal v4 p4(darbuotojas r1 UAB "Rivilė"2     </A02_PAV>
        <A02_KODAS_TB>004         </A02_KODAS_TB>
        <A02_KODAS_IS>999999999998</A02_KODAS_IS>
        <A02_SUMA>0.000</A02_SUMA>
        <A02_PASTABOS>  </A02_PASTABOS>
        <A02_USERIS>MASTER      </A02_USERIS>
        <A02_R_DATE>2025-02-05T08:42:52</A02_R_DATE>
        <A02_KODAS_OS>O_TEST      </A02_KODAS_OS>
        <A02_KODAS_LI>           </A02_KODAS_LI>
    </A02>
</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 'a02_kodas_lf'.</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: *******.*******',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "GET_A02_LIST",
    "params": {
        "fil": "a02_kodas_lk = \'25001\'",
        "pageNumber": 1
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

A02

Nuoroda į lentelės aprašymą: A02