GET_N37_LIST

Aprašymas

Prekių matavimo vienetų/barkodų informacija.

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_N37_LIST
  • params :
    • list : H - gražinama tik pagrindinė informacija (N37) (default). Jeigu A - gražinama visa susijusi informacija (N37+N40).
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N37 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_N37_LIST</method>
    <params>
        <list>H</list>
        <fil>n37_kodas_ps='1' and n37_kodas_us='KG'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_N37_LIST",
    "params": {
        "list": "A",
        "fil": "n37_kodas_ps='1' and n37_kodas_us='KG'"
    }
}
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ą N37_KODAS_PS+N37_KODAS_US

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>
    <N37>
        <Row_number>1</Row_number>
        <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_NETTO>0.000</N37_NETTO>
        <N37_BRUTTO>0.000</N37_BRUTTO>
        <N37_TURIS>0.0000000000</N37_TURIS>
        <N37_ILGIS>0.000</N37_ILGIS>
        <N37_PLOTIS>0.000</N37_PLOTIS>
        <N37_AUKSTIS>0.000</N37_AUKSTIS>
        <N37_R_DATE>2020-01-15T16:15:20</N37_R_DATE>
        <N37_ADDUSR>MASTER</N37_ADDUSR>
        <N37_USERIS>MASTER</N37_USERIS>
        <N37_LAIKAS_KROV>0</N37_LAIKAS_KROV>
        <N37_ORIENTACIJA>0</N37_ORIENTACIJA>
        <N37_AR_VIRS>0</N37_AR_VIRS>
        <N37_VIRS_SVOR>0.000</N37_VIRS_SVOR>
        <N37_VIRS_PAK>0.000</N37_VIRS_PAK>
        <N37_KODAS_US_PAK></N37_KODAS_US_PAK>
        <N37_KIEKIS_PAK>0</N37_KIEKIS_PAK>
        <N37_PAK_TIPAS>1</N37_PAK_TIPAS>
        <N37_PAK_MASE>0.000</N37_PAK_MASE>
        <N37_KODAS_LS_1></N37_KODAS_LS_1>
        <N37_KODAS_LS_2></N37_KODAS_LS_2>
        <N37_REZERVAS></N37_REZERVAS>
        <N37_VAISTO_ID></N37_VAISTO_ID>
    </N37>
    <N40>
    ...
    </N40>
    <N40>
    ...
    </N40>
</RET_DOK>>

pvz, kai list='H'

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <N37>
        <Row_number>1</Row_number>
        <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_NETTO>0.000</N37_NETTO>
        <N37_BRUTTO>0.000</N37_BRUTTO>
        <N37_TURIS>0.0000000000</N37_TURIS>
        <N37_ILGIS>0.000</N37_ILGIS>
        <N37_PLOTIS>0.000</N37_PLOTIS>
        <N37_AUKSTIS>0.000</N37_AUKSTIS>
        <N37_R_DATE>2020-01-15T16:15:20</N37_R_DATE>
        <N37_ADDUSR>MASTER</N37_ADDUSR>
        <N37_USERIS>MASTER</N37_USERIS>
        <N37_LAIKAS_KROV>0</N37_LAIKAS_KROV>
        <N37_ORIENTACIJA>0</N37_ORIENTACIJA>
        <N37_AR_VIRS>0</N37_AR_VIRS>
        <N37_VIRS_SVOR>0.000</N37_VIRS_SVOR>
        <N37_VIRS_PAK>0.000</N37_VIRS_PAK>
        <N37_KODAS_US_PAK></N37_KODAS_US_PAK>
        <N37_KIEKIS_PAK>0</N37_KIEKIS_PAK>
        <N37_PAK_TIPAS>1</N37_PAK_TIPAS>
        <N37_PAK_MASE>0.000</N37_PAK_MASE>
        <N37_KODAS_LS_1></N37_KODAS_LS_1>
        <N37_KODAS_LS_2></N37_KODAS_LS_2>
        <N37_REZERVAS></N37_REZERVAS>
        <N37_VAISTO_ID></N37_VAISTO_ID>
    </N37>
</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 'n37_kodas_pob'.</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: uUCz6UD.sKVrjaWRDJAH1c7l4qL2nOoN2K0jARkvuHDdYsss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "GET_N37_LIST",
    "params": {
        "list": "H",
        "fil": "n37_kodas_ps=\'1\' and n37_kodas_us=\'KG\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N37

Nuoroda į lentelės aprašymą: N37

N40

Nuoroda į lentelės aprašymą: N40