GET_N60_LIST

Aprašymas

Asmenų sąrašas

Specifikacija

Address

POST https://api.manorivile.lt/client/v2

Header
  • 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)
Body
  • method : GET_N60_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N60 nenurodant pačio where tag'o. Neprivaloma
    • pagenumber: į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šų. Neprivaloma

Są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_N60_LIST</method>
    <params>
        <fil>n60_kodas_sm='A001'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_N60_LIST",
    "params": {
        "fil": "n60_kodas_sm='A001'"
    }
}
Response (status 200 OK)

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ą N60_KODAS_SM

Jeigu įrašų nerasta pagal užduotas sąlygas, tuomet gražinama status=200 bei tuščias tag'as

pvz:

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <N60>
        <Row_number>1</Row_number>
        <N60_KODAS_SM>A001</N60_KODAS_SM>
        <N60_ASMUO>39XXXXXXX</N60_ASMUO>
        <N60_PAV>Testavičius</N60_PAV>
        <N60_VARDAS>Testas</N60_VARDAS>
        <N60_PAREIGOS>IT darbuotojas</N60_PAREIGOS>
        <N60_KODAS_GS></N60_KODAS_GS>
        <N60_KODAS_KS>121411842   </N60_KODAS_KS>
        <N60_PAV2>UAB "Rivilė"</N60_PAV2>
        <N60_IGALIOJIMAS>1</N60_IGALIOJIMAS>
        <N60_DOK_NR>DOK001</N60_DOK_NR>
        <N60_DATE>2020-10-29T00:00:00</N60_DATE>
        <N60_POZ_DATE_G>0</N60_POZ_DATE_G>
        <N60_BEG_DATE_G>2020-10-29T00:00:00</N60_BEG_DATE_G>
        <N60_END_DATE_G>2020-10-29T00:00:00</N60_END_DATE_G>
        <N60_SKYRIUS></N60_SKYRIUS>
        <N60_KODAS_VS></N60_KODAS_VS>
        <N60_ADR>Geležinio Vilko 5-48, Vilnius</N60_ADR>
        <N60_TEL>8 5 2395535</N60_TEL>
        <N60_FAX_NUM>8 5 2653134</N60_FAX_NUM>
        <N60_MOB_TEL></N60_MOB_TEL>
        <N60_WWW></N60_WWW>
        <N60_E_MAIL>rivile@rivile.lt</N60_E_MAIL>
        <N60_KODAS_VS_N>VILNIUS</N60_KODAS_VS_N>
        <N60_ADR_N></N60_ADR_N>
        <N60_TEL_N></N60_TEL_N>
        <N60_KATEGORIJA></N60_KATEGORIJA>
        <N60_ADDUSR>MASTER</N60_ADDUSR>
        <N60_ADD_DATE>2020-10-29T00:00:00</N60_ADD_DATE>
        <N60_USERIS>MASTER</N60_USERIS>
        <N60_R_DATE>2020-10-29T21:31:35</N60_R_DATE>
        <N60_KALBA></N60_KALBA>
        <N60_POZ_DATE>0</N60_POZ_DATE>
        <N60_BEG_DATE>2020-10-29T00:00:00</N60_BEG_DATE>
        <N60_END_DATE>2020-10-29T00:00:00</N60_END_DATE>
        <N60_KODAS_LS_1></N60_KODAS_LS_1>
        <N60_KODAS_LS_2></N60_KODAS_LS_2>
        <N60_KODAS_LS_3></N60_KODAS_LS_3>
        <N60_KODAS_LS_4></N60_KODAS_LS_4>
        <N60_PASTABOS><N60_PASTABOS>
        <N60_KODAS_MS></N60_KODAS_MS>
        <N60_KODAS_VS_P></N60_KODAS_VS_P>
        <N60_ADR1_P></N60_ADR1_P>
        <N60_ADR2_P></N60_ADR2_P>
        <N60_ADR3_P></N60_ADR3_P>
    </N60>
</RET_DOK>
Response (status 400)

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 'n60_kodasxx_sm'.</errorMessage>
</RET_DOK>
Response (status 401)

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>
Response (status 502)

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>
Response (status 504)

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>
Response (status 500)

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 pvz

<?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_N60_LIST",
    "params": {
        "fil": "n60_kodas_sm=\'A001\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N60

Nuoroda į lentelės aprašymą: N60