GET_N19_LIST

Aprašymas

Grupių 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. Grąžinamo rezultato (response) formatas
    • application/xml(default)
    • application/json (veikia nuo Manorivile-Gateway-1.1.0 versijos)
Body
  • method : GET_N19_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N09 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_N19_LIST</method>
    <params>
        <fil>n19_kodas_gs='001'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_N19_LIST",
    "params": {
        "fil": "n19_kodas_gs='001'"
    }
}
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ą N19_KODAS_GS

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

pvz:

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <N19>
        <Row_number>1</Row_number>
        <N19_KODAS_GS>001</N19_KODAS_GS>
        <N19_RUSIS>1</N19_RUSIS>
        <N19_PAV>001</N19_PAV>
        <N19_LYGIS>1</N19_LYGIS>
        <N19_TEVAS></N19_TEVAS>
        <N19_TIPAS>2</N19_TIPAS>
        <N19_POZ_DATE>0</N19_POZ_DATE>
        <N19_BEG_DATE>2020-01-02T00:00:00</N19_BEG_DATE>
        <N19_END_DATE>2020-01-02T00:00:00</N19_END_DATE>
        <N19_IMP_EXP_GR></N19_IMP_EXP_GR>
        <N19_APRAS></N19_APRAS>
        <N19_ASOR_KIEK>0</N19_ASOR_KIEK>
        <N19_FRAC>0</N19_FRAC>
        <N19_ASOR_LIK>0</N19_ASOR_LIK>
        <N19_SK_KASOJE>0</N19_SK_KASOJE>
        <N19_ANTKAINIS>0.00</N19_ANTKAINIS>
        <N19_MAX_NUOL>0.00</N19_MAX_NUOL>
        <N19_ADDUSR>MASTER</N19_ADDUSR>
        <N19_USERIS>MASTER</N19_USERIS>
        <N19_R_DATE>2020-01-02T13:51:38</N19_R_DATE>
    </N19>
</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 'n19_kodasxx_ks'.</errorMessage>
</RET_DOK>
Response (status 401)

Blogai nurodytas adresas / neteisingai nurodytas API raktas / nenurodytas API raktas / pasibaigęs API rakto galiojimas / API raktas neturi teisių vykdyti šį metodą, 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_N19_LIST",
    "params": {
        "fil": "n19_kodas_gs=\'001\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N19

Grupių informacija.

Laukas Tipas Aprašymas Pastabos
N19_KODAS_GS C(12) Grupės kodas
N19_RUSIS N(1) Rūšis: 1-prekių, 2-paslaugų, 3-klientų, 4-kodų
N19_PAV C(40) Grupės pavadinimas
N19_LYGIS N(3) Lygis
N19_TIPAS N(1) Tipas: 1-grupė, 2-detali
N19_TEVAS C(12) Aukštesnės grupės kodas
N19_POZ_DATE N(1) Terminuota: 0-ne, 1-taip
N19_BEG_DATE T(8) Pradžios data
N19_END_DATE T(8) Pabaigos data
N19_IMP_EXP_GR C(12) Importo/Eksporto kodas muitinėje
N19_APRAS C(40) Importo/Eksporto aprašymas
N19_ASOR_KIEK N(6) Asortimento kiekis grupėje
N19_FRAC N(4 Asortimento frakcija
N19_ASOR_LIK N(12) Asortimento likutis
N19_SK_KASOJE N(2) Skyrius kasoje
N19_ANTKAINIS N(6,2) Antkainio procentas
N19_MAX_NUOL N(6,2) Maksimalus nuolaidos procentas parduodant
N19_ADDUSR C(12) Kas sukūrė
N19_USERIS C(12) Kas koregavo
N19_R_DATE T(8) Kada koregavo
N19_PAV_K1 C(100) Pavadinimas kita kalba 1
N19_PAV_K2 C(100) Pavadinimas kita kalba 2
N19_PAV_K3 C(100) Pavadinimas kita kalba 3