GET_N77_LIST

Aprašymas

Dovanų čekių sąrašas

Specifikacija

Address

POST https://api.manorivile.lt/client/v2

  • 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_N77_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N77 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_N77_LIST</method>
    <params>
        <fil>n77_kodas_dc='CEKIS1'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_N77_LIST",
    "params": {
        "fil": "n77_kodas_dc='CEKIS1'"
    }
}
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ą N77_KODAS_DC

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>
    <N77>
        <Row_number>1</Row_number>
        <N77_KODAS_DC>CEKIS1</N77_KODAS_DC>
        <N77_PAV>Dovanų čekis</N77_PAV>
        <N77_DATE>2021-06-26T00:00:00</N77_DATE>
        <N77_TIPAS>0</N77_TIPAS>
        <N77_KODAS_IS>01</N77_KODAS_IS>
        <N77_NOMINALAS>100.00</N77_NOMINALAS>
        <N77_POZ_DATE>0</N77_POZ_DATE>
        <N77_BEG_DATE>2021-06-29T00:00:00</N77_BEG_DATE>
        <N77_END_DATE>2021-06-29T00:00:00</N77_END_DATE>
        <N77_GALIOJA>0</N77_GALIOJA>
        <N77_GALIOJA_D>0</N77_GALIOJA_D>
        <N77_KARTAS>0</N77_KARTAS>
        <N77_BLOK>0</N77_BLOK>
        <N77_BLOK_USERIS></N77_BLOK_USERIS>
        <N77_BLOK_DATE>1900-01-01T00:00:00</N77_BLOK_DATE>
        <N77_KODAS_AS>PASLXX</N77_KODAS_AS>
        <N77_KODAS_US>VNT</N77_KODAS_US>
        <N77_KODAS_LS_1></N77_KODAS_LS_1>
        <N77_KODAS_LS_2></N77_KODAS_LS_2>
        <N77_KODAS_LS_3></N77_KODAS_LS_3>
        <N77_KODAS_LS_4></N77_KODAS_LS_4>
        <N77_ADDUSR>MASTER</N77_ADDUSR>
        <N77_ADD_DATE>2021-06-26T08:14:46</N77_ADD_DATE>
        <N77_USERIS>MASTER</N77_USERIS>
        <N77_R_DATE>2021-06-26T08:16:12</N77_R_DATE>
        <T78_KODAS_DC>CEKIS1</T78_KODAS_DC>
        <T78_KODAS_IS>01</T78_KODAS_IS>
        <T78_NURASYTA>0</T78_NURASYTA>
        <T78_SUMA>0.00</T78_SUMA>
        <T78_NUR_REZ>0.00</T78_NUR_REZ>
        <T78_PAJ_REZ>0.00</T78_PAJ_REZ>
        <T78_USERIS>MASTER      </T78_USERIS>
        <T78_R_DATE>2021-06-29T08:15:58</T78_R_DATE>
    </N77>
</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 'n77_kodas_psb'.</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_N77_LIST",
    "params": {
        "fil": "n77_kodas_dc=\'CEKIS1\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N77

Dovanų čekių lentelės aprašymas

Laukas Tipas Aprašymas Pastabos
N77_KODAS_DC C(12) Kodas
N77_PAV C(60) Pavadinimas
N77_DATE T(8) Data
N77_TIPAS N(3) Tipas
N77_KODAS_IS C(12) Padalinys
N77_NOMINALAS N(12,2) Nominalas
N77_POZ_DATE N(1) Ar terminuota: 1- aip,0-Ne
N77_BEG_DATE T(8) Pradžios data
N77_END_DATE T(8) Pabaigos data
N77_GALIOJA N(1) Galiojantis laike DČ
N77_GALIOJA_D N(5) Galioja dienų
N77_KARTAS N(1) Vienkartinio požymis
N77_BLOK N(1) Blokavimo požymis
N77_BLOK_USERIS C(12) Kas koregavo požymį
N77_BLOK_DATE T(8) Kada koregavo požimį
N77_KODAS_AS C(12) Paslaugos kodas
N77_KODAS_US C(12) Matavimo vieneto kodas
N77_KODAS_LS_1 C(12) Logistikos kodas 1
N77_KODAS_LS_2 C(12) Logistikos kodas 2
N77_KODAS_LS_3 C(12) Logistikos kodas 3
N77_KODAS_LS_4 C(12) Logistikos kodas 4
N77_ADDUSR C(12) Kas sukūrė
N77_ADD_DATE T(8) Kada sukūrė
N77_USERIS C(12) Kas koregavo
N77_R_DATE T(8) Kada koregavo