GET_L01_LIST

Aprašymas

Filtravimo lentelių sąrašas

Specifikacija

Informacija apie autorizaciją, bendruosius parametrus ir klaidų kodus: Rivile API v2 naudojimo pagrindai

Body
  • method : GET_L01_LIST
  • params :
    • list : H - gražinama tik pagrindinė informacija (L01) (default). Jeigu A - grąžinama visa susijusi informacija (L01+L02).
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės L01 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_L01_LIST</method>
    <params>
        <fil>L01_KODAS_FS='FS_TEST_FULL'</fil>
        <list>A</list>
    </params>
</body>

pvz application/json:

{
    "method": "GET_L01_LIST",
    "params": {
        "fil": "L01_KODAS_FS='FS_TEST_FULL'",
        "list": "A"
    }
}
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ą L01_KODAS_DH

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

pvz, kai list='A':

<RET_DOK>
    <L01>
        <Row_number>1</Row_number>
        <L01_KODAS_FS>FS_TEST_FULL</L01_KODAS_FS>
        <L01_PAV>                                       </L01_PAV>
        <L01_TIPAS>1</L01_TIPAS>
        <L01_ADDUSR>ABCDEFG     </L01_ADDUSR>
        <L01_USERIS>ABCDEFG     </L01_USERIS>
        <L01_R_DATE>2026-03-10T11:44:41</L01_R_DATE>
        <L01_AR_GALI>0</L01_AR_GALI>
        <L01_POZ_DATE>0</L01_POZ_DATE>
        <L01_BEG_DATE>2026-03-10T11:44:41</L01_BEG_DATE>
        <L01_END_DATE>2026-03-10T11:44:41</L01_END_DATE>
        <L02>
            <L02_KODAS_FS>FS_TEST_FULL</L02_KODAS_FS>
            <L02_KODAS_FIL>001         </L02_KODAS_FIL>
            <L02_ADDUSR>ABCDEFG     </L02_ADDUSR>
            <L02_USERIS>ABCDEFG     </L02_USERIS>
            <L02_R_DATE>2026-03-10T11:44:41</L02_R_DATE>
            <L02_PAV>                   </L02_PAV>
        </L02>
    </L01>
</RET_DOK>

pvz, kai list='H'

<RET_DOK>
    <L01>
        <Row_number>1</Row_number>
        <L01_KODAS_FS>FS_TEST_FULL</L01_KODAS_FS>
        <L01_PAV>                                       </L01_PAV>
        <L01_TIPAS>1</L01_TIPAS>
        <L01_ADDUSR>ABCDEFG     </L01_ADDUSR>
        <L01_USERIS>ABCDEFG     </L01_USERIS>
        <L01_R_DATE>2026-03-10T11:44:41</L01_R_DATE>
        <L01_AR_GALI>0</L01_AR_GALI>
        <L01_POZ_DATE>0</L01_POZ_DATE>
        <L01_BEG_DATE>2026-03-10T11:44:41</L01_BEG_DATE>
        <L01_END_DATE>2026-03-10T11:44:41</L01_END_DATE>
    </L01>
</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.3d11c2a9.1773136925474</id>
    <durationMs>3</durationMs>
    <errorMessage>Invalid column name 'fake_col'.</errorMessage>
</RET_DOK>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: ABCDEFG.ABCDEFG',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "GET_L01_LIST",
    "params": {
        "list": "H",
        "fil": "L01_KODAS_FS='FS_TEST_FULL'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

L01

Nuoroda į lentelės aprašymą: L01

L02

Nuoroda į lentelės aprašymą: L02