DK 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_I02_LISTparams :
list : H - gražinama tik pagrindinė informacija (I02) (default). Jeigu A - grąžinama visa susijusi informacija (I01+I02+I03).fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės I02 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_I02_LIST</method>
<params>
<list>H</list>
<fil>i02_kodas_dh='010000000001'</fil>
</params>
</body>pvz application/json:
{
"method": "GET_I02_LIST",
"params": {
"list": "H",
"fil": "i02_kodas_dh='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ą I02_KODAS_DH
Jeigu įrašų nerasta pagal užduotas sąlygas, tuomet gražinama status=200 bei tuščias
pvz, kai list='A':
<RET_DOK>
<I02>
<Row_number>1</Row_number>
<I02_IMON_ID>01</I02_IMON_ID>
<I02_KODAS_DH>010000000001</I02_KODAS_DH>
<I02_KODAS_ZS>DK1</I02_KODAS_ZS>
<I02_MODUL_NR></I02_MODUL_NR>
<I02_DOK_NR>DOK000000001</I02_DOK_NR>
<I02_OP_DATA>2024-01-01T00:00:00</I02_OP_DATA>
<I02_OP_APRAS></I02_OP_APRAS>
<I02_GEN_POZ>0</I02_GEN_POZ>
<I02_GEN_KARTAI>0</I02_GEN_KARTAI>
<I02_GEN_DIEN>0</I02_GEN_DIEN>
<I02_PERKELTA>1</I02_PERKELTA>
<I02_ADDUSR>WS</I02_ADDUSR>
<I02_USERIS>WS</I02_USERIS>
<I02_R_DATE>2024-01-01T00:00:01</I02_R_DATE>
<I02_KODAS_SM></I02_KODAS_SM>
<I01_DKZR>
<I01>
<I01_KODAS_ZS>DK1</I01_KODAS_ZS>
<I01_PAV>DK žurnalas Nr. 1</I01_PAV>
<I01_EXP_IMP>0</I01_EXP_IMP>
<I01_POZ>2</I01_POZ>
<I01_POZ_DATE>0</I01_POZ_DATE>
<I01_BEG_DATE>2024-01-01T00:00:00</I01_BEG_DATE>
<I01_END_DATE>2024-01-01T00:00:00</I01_END_DATE>
<I01_ADDUSR>WS</I01_ADDUSR>
<I01_USERIS>WS</I01_USERIS>
<I01_R_DATE>2024-01-01T00:00:01</I01_R_DATE>
<I01_MODUL> </I01_MODUL>
</I01>
</I01_DKZR>
<I03_DKD>
<I03>
<I03_KODAS_ZS>BENDRAS </I03_KODAS_ZS>
<I03_KODAS_DH>010000000001</I03_KODAS_DH>
<I03_EIL_NR>1</I03_EIL_NR>
<I03_KODAS_SSD>272</I03_KODAS_SSD>
<I03_KODAS_SSC>272</I03_KODAS_SSC>
<I03_VAL_SUMD>0.99</I03_VAL_SUMD>
<I03_VAL_SUMC>0.99</I03_VAL_SUMC>
<I03_SUMA>0.99</I03_SUMA>
<I03_KODAS_IS>01</I03_KODAS_IS>
<I03_KODAS_OS></I03_KODAS_OS>
<I03_KODAS_OS_S></I03_KODAS_OS_S>
<I03_SERIJA></I03_SERIJA>
<I03_ADDUSR>WS</I03_ADDUSR>
<I03_USERIS>WS</I03_USERIS>
<I03_R_DATE>2024-01-01T00:00:01</I03_R_DATE>
</I03>
</I03_DKD>I03_DKD>
</I02>
</RET_DOK>pvz, kai list='H'
<RET_DOK>
<I02>
<Row_number>1</Row_number>
<I02_IMON_ID>01</I02_IMON_ID>
<I02_KODAS_DH>010000000001</I02_KODAS_DH>
<I02_KODAS_ZS>DK1</I02_KODAS_ZS>
<I02_MODUL_NR></I02_MODUL_NR>
<I02_DOK_NR>DOK000000001</I02_DOK_NR>
<I02_OP_DATA>2024-01-01T00:00:00</I02_OP_DATA>
<I02_OP_APRAS></I02_OP_APRAS>
<I02_GEN_POZ>0</I02_GEN_POZ>
<I02_GEN_KARTAI>0</I02_GEN_KARTAI>
<I02_GEN_DIEN>0</I02_GEN_DIEN>
<I02_PERKELTA>1</I02_PERKELTA>
<I02_ADDUSR>WS</I02_ADDUSR>
<I02_USERIS>WS</I02_USERIS>
<I02_R_DATE>2024-01-01T00:00:01</I02_R_DATE>
<I02_KODAS_SM></I02_KODAS_SM>
</I02>
</RET_DOK>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 '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_I02_LIST",
"params": {
"list": "H",
"fil": "i02_kodas_dh='010000000001'"
}
}');
$response = curl_exec($ch);
curl_close($ch);Nuoroda į lentelės aprašymą: i01
Nuoroda į lentelės aprašymą: i02
Nuoroda į lentelės aprašymą: i03