GET_K78_LIST

Aprašymas

Dovanų čekių operacijų sąrašas

Specifikacija

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

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

pvz application/json:

{
    "method": "GET_K78_LIST",
    "params": {
        "list": "H",
        "fil": "k78_kodas_do='010000000001'"
    }
}
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ą K78_KODAS_DO

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

pvz, kai list='A':

<RET_DOK>
    <K78>
        <Row_number>1</Row_number>
        <K78_KODAS_DO>010000000001</K78_KODAS_DO>
        <K78_ID></K78_ID>
        <K78_TIPAS>1</K78_TIPAS>
        <K78_DATE>2023-12-31T00:00:00</K78_DATE>
        <K78_DOK_NR>DOK_NR1</K78_DOK_NR>
        <K78_PAV></K78_PAV>
        <K78_KODAS_IS_1>001</K78_KODAS_IS_1>
        <K78_KODAS_IS_2></K78_KODAS_IS_2>
        <K78_KODAS_KS>121411842</K78_KODAS_KS>
        ...
        <K79>
            <K79_KODAS_DO>010000000001</K79_KODAS_DO>
            <K79_ID></K79_ID>
            <K79_EIL_NR>1</K79_EIL_NR>
            <K79_KODAS_DC>1</K79_KODAS_DC>
            <K79_PAV></K79_PAV>
            <K79_NOMINALAS>9.00</K79_NOMINALAS>
            ...
        </K79>
    </K78>
</RET_DOK>

pvz, kai list='H'

<RET_DOK>
    <K78>
        <Row_number>1</Row_number>
        <K78_KODAS_DO>010000000001</K78_KODAS_DO>
        <K78_ID></K78_ID>
        <K78_TIPAS>1</K78_TIPAS>
        <K78_DATE>2023-12-31T00:00:00</K78_DATE>
        <K78_DOK_NR>DOK_NR1</K78_DOK_NR>
        <K78_PAV></K78_PAV>
        <K78_KODAS_IS_1>001</K78_KODAS_IS_1>
        <K78_KODAS_IS_2></K78_KODAS_IS_2>
        <K78_KODAS_KS>121411842</K78_KODAS_KS>
        ...
    </K78>
</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 'k78_kodas_doo'.</errorMessage>
</RET_DOK>

PHP pvz

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

Lentelės

K78

Nuoroda į lentelės aprašymą: k78

K79

Nuoroda į lentelės aprašymą: k79