Vidinių 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_I09_LISTparams :
list : H - gražinama tik pagrindinė informacija (I09) (default). Jeigu A - gražinama visa susijusi informacija (I09+I10).fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės I09 nenurodant pačio where tag'o. Neprivalomapagenumber: nurodome įrašų puslapio numerį. Jei nenurodomas, tuomet gaunamas 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_I09_LIST</method>
<params>
<list>H</list>
<fil>i09_kodas_vd='010000000001'</fil>
</params>
</body>pvz application/json:
{
"method": "GET_I09_LIST",
"params": {
"list": "A",
"fil": "i09_kodas_vd='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ą I09_KODAS_VD
Jeigu įrašų nerasta pagal užduotas sąlygas, tuomet gražinama status=200 bei tuščias
pvz, kai list='A':
<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
<I09>
<Row_number>1</Row_number>
<I09_KODAS_VD>010000000001</I09_KODAS_VD>
<I09_TIPAS>1</I09_TIPAS>
<I09_DOK_NR>DOK-001 </I09_DOK_NR>
<I09_IS_DATA>2020-01-06T00:00:00</I09_IS_DATA>
<I09_GAV_POZ>0</I09_GAV_POZ>
<I09_GAV_DATA>2020-01-06T00:00:00</I09_GAV_DATA>
<I09_KODAS_IS1>01</I09_KODAS_IS1>
<I09_KODAS_SS_T></I09_KODAS_SS_T>
<I09_NUTOL1>0</I09_NUTOL1>
<I09_EIL1></I09_EIL1>
...
<I09_KODAS_IS2>02</I09_KODAS_IS2>
<I09_NUTOL2>0</I09_NUTOL2>
<I09_A_EIL1></I09_A_EIL1>
...
<I09_PERKELTA1>1</I09_PERKELTA1>
<I09_PERKELTA2>1</I09_PERKELTA2>
...
<I10>
<I10_KODAS_VD>010000000001</I10_KODAS_VD>
<I10_EIL_NR>1</I10_EIL_NR>
<I10_KODAS_TR></I10_KODAS_TR>
<I10_TIPAS>1</I10_TIPAS>
<I10_PERKELTA>1</I10_PERKELTA>
<I10_KODAS_PS>1</I10_KODAS_PS>
<I10_KODAS_OS1></I10_KODAS_OS1>
<I10_SERIJA1></I10_SERIJA1>
<I10_KODAS_OS2></I10_KODAS_OS2>
<I10_SERIJA2></I10_SERIJA2>
<I10_PAV>CUKRUS</I10_PAV>
<I10_KODAS_US1>KG</I10_KODAS_US1>
<I10_KIEKIS1>1000</I10_KIEKIS1>
<I10_FRAKCIJA1>1000</I10_FRAKCIJA1>
<I10_KODAS_US>KG</I10_KODAS_US>
<I10_KIEKIS>1000</I10_KIEKIS>
<I10_FRAKCIJA>1000</I10_FRAKCIJA>
<I10_KODAS_US2>KG</I10_KODAS_US2>
<I10_KIEKIS2>1000</I10_KIEKIS2>
<I10_FRAKCIJA2>1000</I10_FRAKCIJA2>
...
</I10_VID>
<I10_VID>
<I10_KODAS_VD>010000000001</I10_KODAS_VD>
<I10_EIL_NR>2</I10_EIL_NR>
...
</I10>
</I09>
</RET_DOK>pvz, kai list='H'
<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
<RET_DOK>
<I09>
<Row_number>1</Row_number>
<I09_KODAS_VD>010000000001</I09_KODAS_VD>
<I09_TIPAS>1</I09_TIPAS>
<I09_DOK_NR>DOK-001 </I09_DOK_NR>
<I09_IS_DATA>2020-01-06T00:00:00</I09_IS_DATA>
<I09_GAV_POZ>0</I09_GAV_POZ>
<I09_GAV_DATA>2020-01-06T00:00:00</I09_GAV_DATA>
<I09_KODAS_IS1>01</I09_KODAS_IS1>
<I09_KODAS_SS_T></I09_KODAS_SS_T>
<I09_NUTOL1>0</I09_NUTOL1>
<I09_EIL1></I09_EIL1>
...
<I09_KODAS_IS2>02</I09_KODAS_IS2>
<I09_NUTOL2>0</I09_NUTOL2>
<I09_A_EIL1></I09_A_EIL1>
...
<I09_PERKELTA1>1</I09_PERKELTA1>
<I09_PERKELTA2>1</I09_PERKELTA2>
...
</I09>
</RET_DOK>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 'i09_kodasxx_vd'.</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: uUCz6UD.sKVrjaWRDJAH1c7l4qL2nOoN2K0jARkvuHDdYsss',
'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
"method": "GET_I09_LIST",
"params": {
"list": "H",
"fil": "i09_kodas_vd=\'010000000001\'"
}
}');
$response = curl_exec($ch);
curl_close($ch);Nuoroda į lentelės aprašymą: I09
Nuoroda į lentelės aprašymą: I10