Redaguoti

Pradžia Internetiniai moduliai Rivile API v2 (REST web servisai) GET_N17_LIST

GET_N17_LIST

Aprašymas

Prekių, paslaugų sąrašas

Specifikacija

Address

POST https://api.manorivile.lt/client/v2

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_N17_LIST
params :
- list : H - gražinama tik pagrindinė informacija (N17) (default). Jeigu A - gražinama visa susijusi informacija (N17+N37+I33+N40).
- fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N17 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ą „porcijomis“ per kelis kartus, filtruojant pagal paskutinio gauto įrašo rakto reikšmę.

pvz application/xml:

<body>
    <method>GET_N17_LIST</method>
    <params>
        <list>H</list>
        <fil>n17_kodas_ps='1'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_N17_LIST",
    "params": {
        "list": "A",
        "fil": "n17_kodas_ps='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ą N17_KODAS_PS

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

pvz, kai list='A':

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <N17>
        <Row_number>1</Row_number>
        <N17_KODAS_PS>1</N17_KODAS_PS>
        <N17_TIPAS>1</N17_TIPAS>
        <N17_KODAS_P1></N17_KODAS_P1>
        <N17_KODAS_P2></N17_KODAS_P2>
        <N17_KODAS_US>KG</N17_KODAS_US>
        <N17_PAV>Cukrus</N17_PAV>
        <N17_PAVU></N17_PAVU>
        <N17_KODAS_KS></N17_KODAS_KS>
        <N17_KOD_T></N17_KOD_T>
        <N17_KODAS_KS1></N17_KODAS_KS1>
        <N17_KOD_T1></N17_KOD_T1>
        <N17_KODAS_KS2></N17_KODAS_KS2>
        <N17_KOD_T2></N17_KOD_T2>
        <N17_KODAS_VS></N17_KODAS_VS>
        <N17_KODAS_ES></N17_KODAS_ES>
        <N17_UZSIGUL>0.00</N17_UZSIGUL>
        <N17_BAZ_KIEKIS>0</N17_BAZ_KIEKIS>
        <N17_ASSEMBLY>1</N17_ASSEMBLY>
        <N17_KODAS_LS_1>001AA</N17_KODAS_LS_1>
        <N17_KODAS_LS_2></N17_KODAS_LS_2>
        <N17_KODAS_LS_3></N17_KODAS_LS_3>
        <N17_KODAS_LS_4></N17_KODAS_LS_4>
        <N17_KODAS_DS>PR001</N17_KODAS_DS>
        <N17_NUOL_GR></N17_NUOL_GR>
        <N17_GALIOJA>0</N17_GALIOJA>
        <N17_MOKESTIS>1</N17_MOKESTIS>
        <N17_TAX>1</N17_TAX>
        <N17_KODAS_KS_G></N17_KODAS_KS_G>
        <N17_KODAS_GS></N17_KODAS_GS>
        <N17_INSTR_POZ>0</N17_INSTR_POZ>
        ...
        <I33>
            <I33_KODAS_PS>1</I33_KODAS_PS>
            <I33_KODAS_IS>02</I33_KODAS_IS>
            <I33_KODAS_US>05_MAISELIS </I33_KODAS_US>
            <I33_KAINA>0.0000</I33_KAINA>
            <I33_KAINA_NEW>0.0000</I33_KAINA_NEW>
            <I33_PPK>2.5000</I33_PPK>
            <I33_PPK_DATE>2020-01-08T00:00:00</I33_PPK_DATE>
            <I33_KODAS_VL></I33_KODAS_VL>
            <I33_PPK_VAL>0.0000</I33_PPK_VAL>
            <I33_PPK_SAV>2.5000</I33_PPK_SAV>
            ...
        </I33>
        <I33>
            <I33_KODAS_PS>1</I33_KODAS_PS>
            <I33_KODAS_IS>02</I33_KODAS_IS>
            <I33_KODAS_US>KG</I33_KODAS_US>
            <I33_KAINA>0.0000</I33_KAINA>
            <I33_KAINA_NEW>0.0000</I33_KAINA_NEW>
            <I33_PPK>4.5000</I33_PPK>
            <I33_PPK_DATE>2020-01-08T00:00:00</I33_PPK_DATE>
            <I33_KODAS_VL></I33_KODAS_VL>
            <I33_PPK_VAL>0.0000</I33_PPK_VAL>
            <I33_PPK_SAV>4.5000</I33_PPK_SAV>
            ...
        </I33>
        ...
        <N37>
            <N37_KODAS_PS>1</N37_KODAS_PS>
            <N37_KODAS_US>05_MAISELIS</N37_KODAS_US>
            <N37_BAR_KODAS>000000000001</N37_BAR_KODAS>
            <N37_TRUM_PAV>Cukrus</N37_TRUM_PAV>
            <N37_PAV>Cukrus</N37_PAV>
            <N37_KASOS_POZ>0</N37_KASOS_POZ>
            <N37_SVARST_POZ>0</N37_SVARST_POZ>
            <N37_SK_SVARST></N37_SK_SVARST>
            <N37_TAROS_GR></N37_TAROS_GR>
            <N37_TAROS_SVORIS>0</N37_TAROS_SVORIS>
            <N37_FRAKCIJA_A>500</N37_FRAKCIJA_A>
            <N37_FRAKCIJA>1000</N37_FRAKCIJA>
            <N37_KOEFICI>500</N37_KOEFICI>
            ...
        </N37>
        <N37>
            <N37_KODAS_PS>1</N37_KODAS_PS>
            <N37_KODAS_US>KG</N37_KODAS_US>
            <N37_BAR_KODAS>000000000002</N37_BAR_KODAS>
            <N37_TRUM_PAV>Cukrus</N37_TRUM_PAV>
            <N37_PAV>Cukrus</N37_PAV>
            <N37_KASOS_POZ>0</N37_KASOS_POZ>
            <N37_SVARST_POZ>0</N37_SVARST_POZ>
            <N37_SK_SVARST></N37_SK_SVARST>
            <N37_TAROS_GR></N37_TAROS_GR>
            <N37_TAROS_SVORIS>0</N37_TAROS_SVORIS>
            <N37_FRAKCIJA_A>1000</N37_FRAKCIJA_A>
            <N37_FRAKCIJA>1000</N37_FRAKCIJA>
            <N37_KOEFICI>1000</N37_KOEFICI>
            ...
        </N37>
        <N37>
            <N37_KODAS_PS>1</N37_KODAS_PS>
            <N37_KODAS_US>VNT</N37_KODAS_US>
            <N37_BAR_KODAS>000000000003</N37_BAR_KODAS>
            <N37_TRUM_PAV>Cukrus</N37_TRUM_PAV>
            <N37_PAV>Cukrus</N37_PAV>
            <N37_KASOS_POZ>0</N37_KASOS_POZ>
            <N37_SVARST_POZ>0</N37_SVARST_POZ>
            <N37_SK_SVARST></N37_SK_SVARST>
            <N37_TAROS_GR></N37_TAROS_GR>
            <N37_TAROS_SVORIS>0</N37_TAROS_SVORIS>
            <N37_FRAKCIJA_A>1</N37_FRAKCIJA_A>
            <N37_FRAKCIJA>1000</N37_FRAKCIJA>
            <N37_KOEFICI>3000</N37_KOEFICI>
            ...
        </N37>
    </N17>
</RET_DOK>

pvz, kai list='H'

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <N17>
        <Row_number>1</Row_number>
        <N17_KODAS_PS>1</N17_KODAS_PS>
        <N17_TIPAS>1</N17_TIPAS>
        <N17_KODAS_P1></N17_KODAS_P1>
        <N17_KODAS_P2></N17_KODAS_P2>
        <N17_KODAS_US>KG</N17_KODAS_US>
        <N17_PAV>Cukrus</N17_PAV>
        <N17_PAVU></N17_PAVU>
        <N17_KODAS_KS></N17_KODAS_KS>
        <N17_KOD_T></N17_KOD_T>
        <N17_KODAS_KS1></N17_KODAS_KS1>
        <N17_KOD_T1></N17_KOD_T1>
        <N17_KODAS_KS2></N17_KODAS_KS2>
        <N17_KOD_T2></N17_KOD_T2>
        <N17_KODAS_VS></N17_KODAS_VS>
        <N17_KODAS_ES></N17_KODAS_ES>
        <N17_UZSIGUL>0.00</N17_UZSIGUL>
        <N17_BAZ_KIEKIS>0</N17_BAZ_KIEKIS>
        <N17_ASSEMBLY>1</N17_ASSEMBLY>
        <N17_KODAS_LS_1>001AA</N17_KODAS_LS_1>
        <N17_KODAS_LS_2></N17_KODAS_LS_2>
        <N17_KODAS_LS_3></N17_KODAS_LS_3>
        <N17_KODAS_LS_4></N17_KODAS_LS_4>
        <N17_KODAS_DS>PR001</N17_KODAS_DS>
        <N17_NUOL_GR></N17_NUOL_GR>
        <N17_GALIOJA>0</N17_GALIOJA>
        <N17_MOKESTIS>1</N17_MOKESTIS>
        <N17_TAX>1</N17_TAX>
        <N17_KODAS_KS_G></N17_KODAS_KS_G>
        <N17_KODAS_GS></N17_KODAS_GS>
        <N17_INSTR_POZ>0</N17_INSTR_POZ>
        ...
    </N17>
</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 'n17_kodas_psb'.</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 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: uUCz6UD.sKVrjaWRDJAH1c7l4qL2nOoN2K0jARkvuHDdYsss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "GET_N17_LIST",
    "params": {
        "list": "H",
        "fil": "n17_kodas_ps=\'1\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N17

Nuoroda į lentelės aprašymą: N17

N37

Nuoroda į lentelės aprašymą: N37

I33

Nuoroda į lentelės aprašymą: I33

N40

Nuoroda į lentelės aprašymą: N40

GET_N17_LIST

Aprašymas

Specifikacija

Address

Header

Body

Response (status 200 OK)

Response (status 400)

Response (status 401)

Response (status 500)

PHP pvz

Lentelės

N17

N37

I33

N40