GET_N47_LIST

Aprašymas

Prekių/paslaugų padalinių 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_N47_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N47 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_N47_LIST</method>
    <params>
        <fil>n47_kodas_ps='21832GBC4501' and n47_kodas_is='01' and n47_kodas_us='VNT'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_N47_LIST",
    "params": {
        "fil": "n47_kodas_ps='21832GBC4501' and n47_kodas_is='01' and n47_kodas_us='VNT'"
    }
}
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ą N47_KODAS_PS+N47_KODAS_IS+N47_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>
    <N47>
        <Row_number>1</Row_number>
        <N47_KODAS_IS>01</N47_KODAS_IS>
        <N47_KODAS_PS>21832GBC4501</N47_KODAS_PS>
        <N47_KODAS_US>VNT</N47_KODAS_US>
        <N47_FRAKCIJA>1</N47_FRAKCIJA>
        <N47_MINIMUMAS>10</N47_MINIMUMAS>
        <N47_UZSAKYTI>0</N47_UZSAKYTI>
        <N47_MIN_P>10</N47_MIN_P>
        <N47_KODAS_IS1></N47_KODAS_IS1>
        <N47_KODAS_IS2></N47_KODAS_IS2>
        <N47_ADDUSR>MASTER</N47_ADDUSR>
        <N47_R_DATE>2019-12-11T08:06:06</N47_R_DATE>
        <N47_USERIS>MASTER</N47_USERIS>
        <N47_PAV></N47_PAV>
        <N47_POZ_DATE>0</N47_POZ_DATE>
        <N47_BEG_DATE>2019-12-05T00:00:00</N47_BEG_DATE>
        <N47_END_DATE>2019-12-05T00:00:00</N47_END_DATE>
        <N47_UZSAKYTI1>0</N47_UZSAKYTI1>
        <N47_UZSAKYTI2>0</N47_UZSAKYTI2>
        <N47_UZSAKYTI3>0</N47_UZSAKYTI3>
        <N47_MIN_UZS>0</N47_MIN_UZS>
        <N47_KODAS_LS_1></N47_KODAS_LS_1>
        <N47_KODAS_LS_2></N47_KODAS_LS_2>
        <N47_KODAS_LS_3></N47_KODAS_LS_3>
        <N47_KODAS_LS_4></N47_KODAS_LS_4>
        <N47_KODAS_LS_5></N47_KODAS_LS_5>
        <N47_KODAS_LS_6></N47_KODAS_LS_6>
        <N47_KODAS_LS_7></N47_KODAS_LS_7>
        <N47_KODAS_LS_8></N47_KODAS_LS_8>
        <N47_SVS>0</N47_SVS>
        <N47_KODAS_MS></N47_KODAS_MS>
    </N47>
</RET_DOK>
Response (status 400)

Klaida paduodant duomenis / SQL sintaksės klaidos / kitos DB klaidos

<RET_DOK type="error">
    <id>2552c6d.dd81a1c1580324646507</id>
    <durationMs>53</durationMs>
    <errorMessage>Invalid column name 'n47_kodasxx_ps'.</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_N47_LIST",
    "params": {
        "fil": "n47_kodas_ps=\'21832GBC4501\' and n47_kodas_is=\'01\' and n47_kodas_us=\'VNT\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N47

Nuoroda į lentelės aprašymą: N47