Perkainavimo operacijų 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/xmlapplication/json Accept: Neprivalomas. Gražinamo rezultato (response) formatas
application/xml(default)application/json (veikia nuo Manorivile-Gateway-1.1.0 versijos)method : GET_I20_LISTparams :
list : H - gražinama tik pagrindinė informacija (I20) (default). Jeigu A - grąžinama visa susijusi informacija (I20+I21+I28+I29+I34+I14).fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės I20 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 į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_I20_LIST</method>
<params>
<list>H</list>
<fil>i20_kodas_pk='010000000001'</fil>
</params>
</body>pvz application/json:
{
"method": "GET_I20_LIST",
"params": {
"list": "H",
"fil": "i20_kodas_pk='010000000001'"
}
}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ą I20_KODAS_PK
Jeigu įrašų nerasta pagal užduotas sąlygas, tuomet gražinama status=200 bei tuščias
pvz, kai list='A':
<RET_DOK>
<I20>
<Row_number>1</Row_number>
<I20_KODAS_PK>010R00000001</I20_KODAS_PK>
<I20_DOK_NR>PERK001</I20_DOK_NR>
<I20_TIPAS>1</I20_TIPAS>
<I20_OP_DATE>2024-01-01T00:00:00</I20_OP_DATE>
<I20_APRAS></I20_APRAS>
<I20_KODAS_IS>01</I20_KODAS_IS>
...
<I21_PERD>
<I21>
<I21_KODAS_PK>010R00000001</I21_KODAS_PK>
<I21_EIL_NR>1</I21_EIL_NR>
<I21_KODAS_PS>PREKE1</I21_KODAS_PS>
<I21_KODAS_US>VNT</I21_KODAS_US>
<I21_FRAKCIJA>1</I21_FRAKCIJA>
<I21_KIEKIS>0</I21_KIEKIS>
<I21_KAINA_S>0.0000</I21_KAINA_S>
<I21_KAINA_N>1.0900</I21_KAINA_N>
...
</I21>
<I21>
<I21_KODAS_PK>010R00000001</I21_KODAS_PK>
<I21_EIL_NR>2</I21_EIL_NR>
<I21_KODAS_PS>PREKE2</I21_KODAS_PS>
<I21_KODAS_US>VNT</I21_KODAS_US>
...
</I21>
</I21_PERD>
<I28_PERO>
<I28>
<I28_KODAS_PK>010R00000001</I28_KODAS_PK>
<I28_EIL_NR>1</I28_EIL_NR>
<I28_KODAS_PS>PREKE1</I28_KODAS_PS>
<I28_KODAS_US>VNT</I28_KODAS_US>
<I28_KODAS_OS>010R00000001</I28_KODAS_OS>
<I28_SERIJA>SERIJA1</I28_SERIJA>
...
</I28>
</I28_PERO>
<I29_PERB>
<I29>
<I29_KODAS_PK>010R00000001</I29_KODAS_PK>
<I29_EIL_NR>1</I29_EIL_NR>
<I29_KODAS_PS>PREKE1</I29_KODAS_PS>
<I29_KODAS_US>VNT</I29_KODAS_US>
...
</I29>
</I29_PERB>
<I34_PERK>
<I34>
<I34_KODAS_PK>010R00000001</I34_KODAS_PK>
<I34_EIL_NR>1</I34_EIL_NR>
<I34_KODAS_PS>PREKE1</I34_KODAS_PS>
<I34_KODAS_US>VNT</I34_KODAS_US>
<I34_TIPAS>A</I34_TIPAS>
<I34_G_DATE>2024-01-01T00:00:00</I34_G_DATE>
...
</I34>
</I34_PERK>
<I14_PERA>
<I14>
<I14_KODAS_PK>010R00000001</I14_KODAS_PK>
<I14_EIL_NR>1</I14_EIL_NR>
<I14_KODAS_PS>PREKE1</I14_KODAS_PS>
<I14_KODAS_US>VNT</I14_KODAS_US>
<I14_KODAS_IS>01</I14_KODAS_IS>
<I14_DATE_PR>2024-01-01T00:00:00</I14_DATE_PR>
<I14_DATE_PB>2024-01-01T23:59:59</I14_DATE_PB>
...
</I14>
</I14_PERA>
</I20>
</RET_DOK>pvz, kai list='H'
<RET_DOK>
<I20>
<Row_number>1</Row_number>
<I20_KODAS_PK>010R00000001</I20_KODAS_PK>
<I20_DOK_NR>PERK001</I20_DOK_NR>
<I20_TIPAS>1</I20_TIPAS>
<I20_OP_DATE>2024-01-01T00:00:00</I20_OP_DATE>
<I20_APRAS></I20_APRAS>
<I20_KODAS_IS>01</I20_KODAS_IS>
<I20_PERKELTA>1</I20_PERKELTA>
<I20_USERIS>WS</I20_USERIS>
<I20_ADDUSR>WS</I20_ADDUSR>
<I20_R_DATE>2024-01-01T00:00:01</I20_R_DATE>
<I20_PERKELTA2>1</I20_PERKELTA2>
<I20_KODAS_SM></I20_KODAS_SM>
<I20_ID></I20_ID>
<i20_busena>1</i20_busena>
</I20>
</RET_DOK>Klaida paduodant duomenis / SQL sintaksės klaidos / kitos DB klaidos
<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
<id/>
<durationMs>25</durationMs>
<errorMessage>Invalid column name 'i02_kodas_dhh'.</errorMessage>
</RET_DOKBlogai 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>2024-01-01T00:00:01.001+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: uUCz6UD.sKVrjWWRDJAH1c7l4LL2nOoN2K0jARkvuHDdYsss',
'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
"method": "GET_I20_LIST",
"params": {
"list": "H",
"fil": "i20_kodas_pk='010000000001'"
}
}');
$response = curl_exec($ch);
curl_close($ch);Nuoroda į lentelės aprašymą: i20
Nuoroda į lentelės aprašymą: i21
Nuoroda į lentelės aprašymą: i28
Nuoroda į lentelės aprašymą: i29
Nuoroda į lentelės aprašymą: i34
Nuoroda į lentelės aprašymą: i14