GET_N31_LIST

Aprašymas

Nuolaidų lentelės

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_N31_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N31 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_N31_LIST</method>
    <params>
        <fil>n31_kodas_ns='AAA   BBB' and n31_eil_nr='1'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_N31_LIST",
    "params": {
        "fil": "n31_kodas_ns='AAA   BBB' and n31_eil_nr='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ą N31_KODAS_NS+N31_EIL_NR

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>
    <N31>
        <Row_number>1</Row_number>
        <N31_KODAS_NS>AAA   BBB</N31_KODAS_NS>
        <N31_EIL_NR>1</N31_EIL_NR>
        <N31_MINIMUM>2.000</N31_MINIMUM>
        <N31_NUOL_PROC>10.0000</N31_NUOL_PROC>
        <N31_USERIS>MASTER</N31_USERIS>
        <N31_R_DATE>2020-02-11T19:17:17</N31_R_DATE>
        <N31_ADDUSR>MASTER</N31_ADDUSR>
    </N31>
</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 'n31_kodasxx_ns'.</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_N31_LIST",
    "params": {
        "fil": "n31_kodas_ns=\'AAA   BBB\' and n31_eil_nr=\'1\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N31

Laukas Tipas Aprašymas
N31_KODAS_NS C(12) Nuolaidos lentelės kodas
N31_EIL_NR N(6) Detalios eilutės numeris
N31_MINIMUM N(14,3) Minimalus kiekis pagrindiniu matu
N31_NUOL_PROC N(8,4) Nuolaidos procentas
N31_USERIS C(12) Kas koregavo
N31_R_DATE T(8) Kada koregavo
N31_ADDUSR C(12) Kas sukūrė