Algos dokumentų sąrašas
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)method
: GET_I45_LIST
params
:
fil
: filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės I45 nenurodant pačio where tag'o. Neprivalomapagenumber
: į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šų. NeprivalomaSą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_I45_LIST</method>
<params>
<list>A</list>
<fil>I45_KODAS_IV = '000000000010'</fil>
</params>
</body>
pvz application/json
:
{
"method": "GET_I45_LIST",
"params": {
"list": "A",
"fil": "I45_KODAS_IV = '000000000010'"
}
}
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ą A24_KODAS_LI
Jeigu įrašų nerasta pagal užduotas sąlygas, tuomet gražinama status=200 bei tuščias
pvz.:
<RET_DOK>
<I45>
<Row_number>1</Row_number>
<I45_KODAS_IV>000000000010</I45_KODAS_IV>
<I45_KODAS_IS>999999999999</I45_KODAS_IS>
<I45_DOK_NR>IV0000000020</I45_DOK_NR>
<I45_TIPAS>1</I45_TIPAS>
<I45_RUSIS>2</I45_RUSIS>
<I45_PASTABOS> </I45_PASTABOS>
<I45_KODAS_IN>000000000033</I45_KODAS_IN>
<I45_SASK_POZ>0</I45_SASK_POZ>
<I45_KODAS_SS>7 </I45_KODAS_SS>
<I45_OP_DATA>2024-12-12T00:00:00</I45_OP_DATA>
<I45_FIX_DATA>2024-12-12T00:00:00</I45_FIX_DATA>
<I45_KODAS_OS_C> </I45_KODAS_OS_C>
<I45_PERKELTA>3</I45_PERKELTA>
<I45_USERIS>MASTER </I45_USERIS>
<I45_R_DATE>2025-01-08T11:02:36</I45_R_DATE>
<I45_ADDUSR>MASTER </I45_ADDUSR>
<I45_KODAS_SM> </I45_KODAS_SM>
<I45_BUSENA>1</I45_BUSENA>
<I46_IVDD>
<I46>
<I46_KODAS_IV>000000000010</I46_KODAS_IV>
<I46_EIL_NR>2</I46_EIL_NR>
<I46_KODAS_PS>001 </I46_KODAS_PS>
<I46_PAV>Prekė 001</I46_PAV>
<I46_KODAS_US_A>KG </I46_KODAS_US_A>
<I46_FRAKCIJA_A>1000</I46_FRAKCIJA_A>
<I46_KIEKIS_A>0</I46_KIEKIS_A>
<I46_KODAS_US>VNT </I46_KODAS_US>
<I46_FRAKCIJA>1</I46_FRAKCIJA>
<I46_KIEKIS>0</I46_KIEKIS>
<I46_KOEFICIENTAS>7</I46_KOEFICIENTAS>
<I46_KAINA>15.0000</I46_KAINA>
<I46_KIEKIS_F>0</I46_KIEKIS_F>
<I46_KIEKIS_A_F>0</I46_KIEKIS_A_F>
<I46_KODAS_OS> </I46_KODAS_OS>
<I46_SERIJA> </I46_SERIJA>
<I46_PERKELTA>1</I46_PERKELTA>
<I46_USERIS>MASTER </I46_USERIS>
<I46_R_DATE>2025-01-08T11:02:35</I46_R_DATE>
<I46_ADDUSR>MASTER </I46_ADDUSR>
<I46_SUMA>0.00</I46_SUMA>
</I46>
<I46>
<I46_KODAS_IV>000000000010</I46_KODAS_IV>
<I46_EIL_NR>1</I46_EIL_NR>
<I46_KODAS_PS>545 </I46_KODAS_PS>
<I46_PAV>Mažų likučių prekė </I46_PAV>
<I46_KODAS_US_A>VNT </I46_KODAS_US_A>
<I46_FRAKCIJA_A>1</I46_FRAKCIJA_A>
<I46_KIEKIS_A>545</I46_KIEKIS_A>
<I46_KODAS_US>VNT </I46_KODAS_US>
<I46_FRAKCIJA>1</I46_FRAKCIJA>
<I46_KIEKIS>545</I46_KIEKIS>
<I46_KOEFICIENTAS>1</I46_KOEFICIENTAS>
<I46_KAINA>0.0000</I46_KAINA>
<I46_KIEKIS_F>545</I46_KIEKIS_F>
<I46_KIEKIS_A_F>545</I46_KIEKIS_A_F>
<I46_KODAS_OS> </I46_KODAS_OS>
<I46_SERIJA> </I46_SERIJA>
<I46_PERKELTA>2</I46_PERKELTA>
<I46_USERIS>MASTER </I46_USERIS>
<I46_R_DATE>2024-12-12T11:03:22</I46_R_DATE>
<I46_ADDUSR>MASTER </I46_ADDUSR>
<I46_SUMA>0.00</I46_SUMA>
</I46>
</I46_IVDD>
</I45>
</RET_DOK>
Klaida paduodant duomenis / SQL sintaksės klaidos / kitos DB klaidos
<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
<id>4641133481.86fdf0ea.1736410135240</id>
<durationMs>2</durationMs>
<errorMessage>Invalid column name 'I45_KODASS_IV'.</errorMessage>
</RET_DOK>
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>
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>
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>
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
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'ApiKey: abcdef.12345',
'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
"method": "GET_I45_LIST",
"params": {
"list": "A",
"fil": "I45_KODAS_IV = \'000000000010\'"
}
}');
$response = curl_exec($ch);
curl_close($ch);
Nuoroda į lentelės aprašymą: I45