GET_N66_LIST

Aprašymas

Muitinės 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. Grąžinamo rezultato (response) formatas
    • application/xml(default)
    • application/json (veikia nuo Manorivile-Gateway-1.1.0 versijos)
Body
  • method : GET_N66_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N66 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_N66_LIST</method>
    <params>
        <fil>n66_kodas_iu='MT-PRE001'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_N66_LIST",
    "params": {
        "fil": "n66_kodas_iu='MT-PRE001'"
    }
}
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ą N66_KODAS_IU

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>
    <N66>
      <Row_number>2</Row_number>
      <N66_KODAS_IU>MT-PRE001   </N66_KODAS_IU>
      <N66_PAV>Muitinės prekė 1</N66_PAV>
      <N66_APR></N66_APR>
      <N66_APSKRITIS>            </N66_APSKRITIS>
      <N66_SANDORIS>            </N66_SANDORIS>
      <N66_SALYGOS>            </N66_SALYGOS>
      <N66_RUSIS>            </N66_RUSIS>
      <N66_SALIS>            </N66_SALIS>
      <N66_MATAS>            </N66_MATAS>
      <N66_SALIS_K>            </N66_SALIS_K>
      <N66_KOEF>0.000</N66_KOEF>
      <N66_APVAL>4</N66_APVAL>
      <N66_POZ_DATE>1</N66_POZ_DATE>
      <N66_BEG_DATE>2023-01-01T00:00:00</N66_BEG_DATE>
      <N66_END_DATE>2027-01-01T00:00:00</N66_END_DATE>
      <N66_ADDUSR>WS          </N66_ADDUSR>
      <N66_USERIS>WS          </N66_USERIS>
      <N66_R_DATE>2024-09-13T11:03:21</N66_R_DATE>
      <N66_ADD_DATE>2024-09-13T11:03:21</N66_ADD_DATE>
    </N66>
    ...
</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 'n66_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 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: 1234567.XXXXXXXXXXXXXXX',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "GET_N66_LIST",
    "params": {
        "fil": "n66_kodas_iu=\'MT-PRE001\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N66

Muitinės prekių informacija.

Laukas Tipas Aprašymas Pastabos
N66_KODAS_IU CHAR(12) Muit. prekės kodas
N66_PAV CHAR(100) Pavadinimas
N66_APR CHAR(100) Pastabos
N66_APSKRITIS CHAR(12) Apskritis
N66_SANDORIS CHAR(12) Sandoris
N66_SALYGOS CHAR(12) Sąlygos
N66_RUSIS CHAR(12) Rūšis
N66_SALIS CHAR(12) Šalis
N66_MATAS CHAR(12) Matavimo vnt.
N66_SALIS_K CHAR(12) Kilmės šalis
N66_KOEF NUMERIC(14,3) Neto konvertavimo koeficientas į kiekį
N66_APVAL NUMERIC(2) Apvalinimas
N66_POZ_DATE NUMERIC(1) Ar terminuota?
N66_BEG_DATE DATETIME Termino pradžios data
N66_END_DATE DATETIME Termino pabaigos data
N66_ADDUSR CHAR(12) Kas sukūrė
N66_USERIS CHAR(12) Kas koregavo
N66_R_DATE DATETIME Kada koregavo
N66_ADD_DATE DATETIME Kada sukūrė