Gamybos 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/xml
application/json
Accept
: Neprivalomas. Grąžinamo rezultato (response) formatas
application/xml
(default)application/json
(veikia nuo Manorivile-Gateway-1.1.0 versijos)method
: GET_I15_LIST
params
:
list
: H
- grąžinama tik pagrindinė informacija (I15) (default). Jeigu A
- grąžinama visa susijusi informacija (I15+I16).fil
: filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės I15 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_I15_LIST</method>
<params>
<list>A</list>
<fil>i15_kodas_ka='010000000001'</fil>
<pagenumber>1</pagenumber>
</params>
</body>
pvz application/json
:
{
"method": "GET_I15_LIST",
"params": {
"list": "H",
"fil": "i15_kodas_ka='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ą I15_KODAS_KA
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>
<I15>
<Row_number>1</Row_number>
<I15_KODAS_KA>010000000001</I15_KODAS_KA>
<I15_DOK_NR>SUR00001</I15_DOK_NR>
<I15_UZS_NR></I15_UZS_NR>
<I15_UZS_DATA>2020-01-17T00:00:00</I15_UZS_DATA>
<I15_OP_DATA>2020-01-17T00:00:00</I15_OP_DATA>
<I15_TIPAS>1</I15_TIPAS>
<I15_KODAS_IS>01</I15_KODAS_IS>
<I15_KODAS_PS>004</I15_KODAS_PS>
<I15_KODAS_OS></I15_KODAS_OS>
<I15_SERIJA></I15_SERIJA>
<I15_KODAS_US>VNT</I15_KODAS_US>
<I15_FRAKCIJA>1</I15_FRAKCIJA>
<I15_KIEKIS>2</I15_KIEKIS>
<I15_KODAS_US_A>VNT</I15_KODAS_US_A>
<I15_FRAKCIJA_A>1</I15_FRAKCIJA_A>
<I15_KIEKIS_A>2</I15_KIEKIS_A>
<I15_PERKELTA>2</I15_PERKELTA>
<I15_H_COST>1200.00</I15_H_COST>
<I15_PARD_K>0.0000</I15_PARD_K>
<I15_GALIOJA>3999-01-01T00:00:00</I15_GALIOJA>
<I15_IMP_EXP>0</I15_IMP_EXP>
<I15_USERIS>MASTER</I15_USERIS>
<I15_R_DATE>2020-01-17T12:39:03</I15_R_DATE>
<I15_ADDUSR>MASTER</I15_ADDUSR>
<I15_SUMA_NOR>999999999.99</I15_SUMA_NOR>
<I15_SERTIFIKATAS></I15_SERTIFIKATAS>
<I15_KODAS_OS_C></I15_KODAS_OS_C>
<I15_PAV></I15_PAV>
<I15_KODAS_PE></I15_KODAS_PE>
<I15_KODAS1></I15_KODAS1>
<I15_KODAS2></I15_KODAS2>
<I15_SKAICIUS>0.0000</I15_SKAICIUS>
<I15_KODAS_SM></I15_KODAS_SM>
<I15_BUSENA>1</I15_BUSENA>
<I16>
<I16_KODAS_KA>010000000001</I16_KODAS_KA>
<I16_EIL_NR>1</I16_EIL_NR>
<I16_TIPAS>1</I16_TIPAS>
<I16_KODAS_PS>005</I16_KODAS_PS>
<I16_KODAS_OS></I16_KODAS_OS>
<I16_SERIJA></I16_SERIJA>
<I16_PERKELTA>2</I16_PERKELTA>
<I16_KODAS_US_A>VNT</I16_KODAS_US_A>
<I16_FRAKCIJA_A>1</I16_FRAKCIJA_A>
<I16_KIEKIS_A>2</I16_KIEKIS_A>
<I16_PARD_KAINA>0.0000</I16_PARD_KAINA>
<I16_KODAS_US>VNT</I16_KODAS_US>
<I16_FRAKCIJA>1</I16_FRAKCIJA>
<I16_KIEKIS>2</I16_KIEKIS>
<I16_LIKUTIS>2</I16_LIKUTIS>
<I16_MINUSO_POZ>0</I16_MINUSO_POZ>
<I16_SAVIKAINA>-300.00</I16_SAVIKAINA>
<I16_ISEIG_PROC>0.00</I16_ISEIG_PROC>
<I16_GALIOJA>3999-01-01T00:00:00</I16_GALIOJA>
<I16_USERIS>MASTER</I16_USERIS>
<I16_R_DATE>2020-01-17T12:39:01</I16_R_DATE>
<I16_ADDUSR>MASTER</I16_ADDUSR>
<I16_KODAS_US_N>VNT</I16_KODAS_US_N>
<I16_PAV>2 (VNT):HDD</I16_PAV>
</I16>
<I16>
<I16_KODAS_KA>010000000001</I16_KODAS_KA>
<I16_EIL_NR>2</I16_EIL_NR>
<I16_TIPAS>1</I16_TIPAS>
<I16_KODAS_PS>006</I16_KODAS_PS>
<I16_KODAS_OS></I16_KODAS_OS>
<I16_SERIJA></I16_SERIJA>
<I16_PERKELTA>2</I16_PERKELTA>
<I16_KODAS_US_A>VNT</I16_KODAS_US_A>
<I16_FRAKCIJA_A>1</I16_FRAKCIJA_A>
<I16_KIEKIS_A>2</I16_KIEKIS_A>
<I16_PARD_KAINA>0.0000</I16_PARD_KAINA>
<I16_KODAS_US>VNT</I16_KODAS_US>
<I16_FRAKCIJA>1</I16_FRAKCIJA>
<I16_KIEKIS>2</I16_KIEKIS>
<I16_LIKUTIS>2</I16_LIKUTIS>
<I16_MINUSO_POZ>0</I16_MINUSO_POZ>
<I16_SAVIKAINA>-900.00</I16_SAVIKAINA>
<I16_ISEIG_PROC>0.00</I16_ISEIG_PROC>
<I16_GALIOJA>3999-01-01T00:00:00</I16_GALIOJA>
<I16_USERIS>MASTER</I16_USERIS>
<I16_R_DATE>2020-01-17T12:39:03</I16_R_DATE>
<I16_ADDUSR>MASTER</I16_ADDUSR>
<I16_KODAS_US_N>VNT</I16_KODAS_US_N>
<I16_PAV>2 (VNT):Plokštė</I16_PAV>
</I16>
</I15>
</RET_DOK>
pvz, kai list='H'
<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
<I15>
<Row_number>1</Row_number>
<I15_KODAS_KA>010000000001</I15_KODAS_KA>
<I15_DOK_NR>SUR00001</I15_DOK_NR>
<I15_UZS_NR></I15_UZS_NR>
<I15_UZS_DATA>2020-01-17T00:00:00</I15_UZS_DATA>
<I15_OP_DATA>2020-01-17T00:00:00</I15_OP_DATA>
<I15_TIPAS>1</I15_TIPAS>
<I15_KODAS_IS>01</I15_KODAS_IS>
<I15_KODAS_PS>004</I15_KODAS_PS>
<I15_KODAS_OS></I15_KODAS_OS>
<I15_SERIJA></I15_SERIJA>
<I15_KODAS_US>VNT</I15_KODAS_US>
<I15_FRAKCIJA>1</I15_FRAKCIJA>
<I15_KIEKIS>2</I15_KIEKIS>
<I15_KODAS_US_A>VNT</I15_KODAS_US_A>
<I15_FRAKCIJA_A>1</I15_FRAKCIJA_A>
<I15_KIEKIS_A>2</I15_KIEKIS_A>
<I15_PERKELTA>2</I15_PERKELTA>
<I15_H_COST>1200.00</I15_H_COST>
<I15_PARD_K>0.0000</I15_PARD_K>
<I15_GALIOJA>3999-01-01T00:00:00</I15_GALIOJA>
<I15_IMP_EXP>0</I15_IMP_EXP>
<I15_USERIS>MASTER</I15_USERIS>
<I15_R_DATE>2020-01-17T12:39:03</I15_R_DATE>
<I15_ADDUSR>MASTER</I15_ADDUSR>
<I15_SUMA_NOR>999999999.99</I15_SUMA_NOR>
<I15_SERTIFIKATAS></I15_SERTIFIKATAS>
<I15_KODAS_OS_C></I15_KODAS_OS_C>
<I15_PAV></I15_PAV>
<I15_KODAS_PE></I15_KODAS_PE>
<I15_KODAS1></I15_KODAS1>
<I15_KODAS2></I15_KODAS2>
<I15_SKAICIUS>0.0000</I15_SKAICIUS>
<I15_KODAS_SM></I15_KODAS_SM>
<I15_BUSENA>1</I15_BUSENA>
</I15>
</RET_DOK>
Klaida paduodant duomenis / SQL sintaksės klaidos / kitos DB klaidos
<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
<id>1266808491.62321ee0.1604412180363</id>
<durationMs>10</durationMs>
<errorMessage>Invalid column name 'i15_kodas_kas'.</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_I15_LIST",
"params": {
"list": "H",
"fil": "i15_kodas_ka=\'010000000001\'"
}
}');
$response = curl_exec($ch);
curl_close($ch);
Nuoroda į lentelės aprašymą: I15
Nuoroda į lentelės aprašymą: I16