Klientų sąrašas su alternatyviais adresais
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_N08_LIST
params
:
list
: H
- gražinama tik pagrindinė informacija (N08) (default). Jeigu A
- gražinama visa susijusi informacija (N08+N33).fil
: filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N08 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_N08_LIST</method>
<params>
<list>H</list>
<fil>n08_kodas_ks='121411842'</fil>
</params>
</body>
pvz application/json
:
{
"method": "GET_N08_LIST",
"params": {
"list": "",
"fil": "n08_kodas_ks='121411842'"
}
}
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ą N08_KODAS_KS
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>
<N08>
<Row_number>1</Row_number>
<N08_KODAS_KS>121411842</N08_KODAS_KS>
<N08_RUSIS>2</N08_RUSIS>
<N08_PVM_KODAS>LT214118411</N08_PVM_KODAS>
<N08_IM_KODAS>121411842</N08_IM_KODAS>
<N08_PAV>UAB "Rivilė"</N08_PAV>
...
<N33>
<N33_KODAS_KS>121411842 </N33_KODAS_KS>
<N33_EIL_NR>1</N33_EIL_NR>
...
</N33>
</N08>
</RET_DOK>
pvz, kai list='H'
<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
<N08>
<Row_number>1</Row_number>
<N08_KODAS_KS>121411842</N08_KODAS_KS>
<N08_RUSIS>2</N08_RUSIS>
<N08_PVM_KODAS>LT214118411</N08_PVM_KODAS>
<N08_IM_KODAS>121411842</N08_IM_KODAS>
<N08_PAV>UAB "Rivilė"</N08_PAV>
...
</N08>
</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 'n08_kodasxx_ks'.</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_N08_LIST",
"params": {
"list": "H",
"fil": "n08_kodas_ks=\'121411842\'"
}
}');
$response = curl_exec($ch);
curl_close($ch);
Nuoroda į lentelės aprašymą: N08
Nuoroda į lentelės aprašymą: N33