GET_N87_LIST

Aprašymas

Kliento prekių 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_N87_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N87 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_N87_LIST</method>
    <params>
        <fil>n87_kodas_ps='005' and n87_kodas_us='VNT' and n87_kodas_ks='121411842'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_N87_LIST",
    "params": {
        "fil": "n87_kodas_ps='005' and n87_kodas_us='VNT' and n87_kodas_ks='121411842'"
    }
}
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ą N87_KODAS_PS+N87_KODAS_US+N87_KODAS_KS

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>
    <N87>
        <Row_number>1</Row_number>
        <N87_KODAS_PS>005</N87_KODAS_PS>
        <N87_KODAS_US>VNT</N87_KODAS_US>
        <N87_KODAS_KS>121411842</N87_KODAS_KS>
        <N87_PAV>UAB "Rivilė"</N87_PAV>
        <N87_KODAS>123</N87_KODAS>
        <N87_NUM1>0.0000</N87_NUM1>
        <N87_NUM2>0.0000</N87_NUM2>
        <N87_NUM3>0.0000</N87_NUM3>
        <N87_USERIS>MASTER</N87_USERIS>
        <N87_R_DATE>2020-02-13T14:08:22</N87_R_DATE>
        <N87_ADDUSR>MASTER</N87_ADDUSR>
    </N87>
</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 'n87_kodasxx_ds'.</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_N87_LIST",
    "params": {
        "fil": "n87_kodas_ps=\'005\' and n87_kodas_us=\'VNT\' and n87_kodas_ks=\'121411842\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N87

Nuoroda į lentelės aprašymą: N87