GET_I33_LIST

Aprašymas

Prekių kainų 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_I33_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės I33 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ą „porcijomis“ per kelis kartus, filtruojant pagal paskutinio gauto įrašo rakto reikšmę.

pvz application/xml:

<body>
    <method>GET_I33_LIST</method>
    <params>
        <fil>i33_kodas_ps='1' and i33_kodas_is='01'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_I33_LIST",
    "params": {
        "fil": "i33_kodas_ps='1' and i33_kodas_is='01'"
    }
}
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ą I33_KODAS_PS+i33_KODAS_IS+i33_KODAS_US

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

pvz:

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <I33>
        <Row_number>1</Row_number>
        <I33_KODAS_PS>1</I33_KODAS_PS>
        <I33_KODAS_IS>01</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.0000</I33_PPK>
        <I33_PPK_DATE>2020-01-09T00:00:00</I33_PPK_DATE>
        <I33_KODAS_VL></I33_KODAS_VL>
        <I33_PPK_VAL>0.0000</I33_PPK_VAL>
        <I33_PPK_SAV>2.0000</I33_PPK_SAV>
        ...
    </I33>
    <I33>
        <Row_number>2</Row_number>
        <I33_KODAS_PS>1</I33_KODAS_PS>
        <I33_KODAS_IS>01</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>
</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 'i33_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 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_I33_LIST",
    "params": {
        "fil": "i33_kodas_ps=\'1\' and i33_kodas_is=\'01\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I33

Nuoroda į lentelės aprašymą: I33