GET_K14_LIST

Aprašymas

Personalo 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_K14_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės K14 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_K14_LIST</method>
    <params>
        <fil>k14_kodas_4a='001'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_K14_LIST",
    "params": {
        "fil": "k14_kodas_4a='001'"
    }
}
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ą K14_KODAS_4A

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>
    <K14>
        <row_number>1</row_number>
        <K14_KODAS_4A>001</K14_KODAS_4A>
        <K14_TIPAS>1</K14_TIPAS>
        <K14_AS_KODAS>123456789</K14_AS_KODAS>
        <K14_VARDAS>Vardas</K14_VARDAS>
        <K14_PAV>Pavardė</K14_PAV>
        <K14_LYTIS>1</K14_LYTIS>
        <K14_GIM>1989-01-09T00:00:00</K14_GIM>
        <K14_KODAS_1A_04></K14_KODAS_1A_04>
        <K14_KODAS_1A_05></K14_KODAS_1A_05>
        <K14_STAZ_MET>0</K14_STAZ_MET>
        <K14_STAZ_MEN>0</K14_STAZ_MEN>
        <K14_STAZ_D>0</K14_STAZ_D>
        <K14_VSTAZ_MET>0</K14_VSTAZ_MET>
        <K14_VSTAZ_MEN>0</K14_VSTAZ_MEN>
        <K14_VSTAZ_D>0</K14_VSTAZ_D>
        <K14_SEIM_PAD>1</K14_SEIM_PAD>
        <K14_SUT_VARDAS></K14_SUT_VARDAS>
        <K14_SUT_PAVARDE></K14_SUT_PAVARDE>
        <K14_SUT_GIM>1900-01-01T00:00:00</K14_SUT_GIM>
        <K14_ADR_REG>Vilnius</K14_ADR_REG>
        <K14_ADR_GYV>Adresas</K14_ADR_GYV>
        <K14_TEL>8888888888</K14_TEL>
        <K14_MOB>9999999999</K14_MOB>
        <K14_E_MAIL>testas@testas.lt</K14_E_MAIL>
        <K14_PASO_NR>123</K14_PASO_NR>
        <K14_PASO_DATA>2018-01-22T00:00:00</K14_PASO_DATA>
        <K14_PASO_GAL>2023-01-22T00:00:00</K14_PASO_GAL>
        <K14_PASO_ISDAV>Vilnius</K14_PASO_ISDAV>
        <K14_VAIR_DATA>1900-01-01T00:00:00</K14_VAIR_DATA>
        <K14_KODAS_1A_09></K14_KODAS_1A_09>
        <K14_LK_DATA>1900-01-01T00:00:00</K14_LK_DATA>
        <K14_KT_TARN>1</K14_KT_TARN>
        <K14_KODAS_1A_10></K14_KODAS_1A_10>
        <K14_KODAS_1A_11></K14_KODAS_1A_11>
        <K14_KT_DATA>1900-01-01T00:00:00</K14_KT_DATA>
        <K14_KODAS_1A_12></K14_KODAS_1A_12>
        <K14_POZ_DATE>0</K14_POZ_DATE>
        <K14_BEG_DATE>2020-06-05T00:00:00</K14_BEG_DATE>
        <K14_END_DATE>2020-06-05T00:00:00</K14_END_DATE>
        <K14_PASTABOS></K14_PASTABOS>
        <K14_USERIS>MASTER</K14_USERIS>
        <K14_ADDUSR>MASTER</K14_ADDUSR>
        <K14_R_DATE>2020-06-08T14:49:48</K14_R_DATE>
        <K14_ADD_DATE>2020-06-05T00:00:00</K14_ADD_DATE>
        <K14_KODAS_LS_1></K14_KODAS_LS_1>
        <K14_KODAS_LS_2></K14_KODAS_LS_2>
        <K14_KODAS_LS_3></K14_KODAS_LS_3>
        <K14_KODAS_LS_4></K14_KODAS_LS_4>
        <K14_KODAS_1A_23></K14_KODAS_1A_23>
        <K14_DIRBA>0</K14_DIRBA>
        <K14_KODAS_FR></K14_KODAS_FR>
        <K14_VAIR_GAL>1900-01-01T00:00:00</K14_VAIR_GAL>
        <K14_KODAS_LS_5></K14_KODAS_LS_5>
        <K14_KODAS_LS_6></K14_KODAS_LS_6>
        <K14_KODAS_LS_7></K14_KODAS_LS_7>
        <K14_KODAS_LS_8></K14_KODAS_LS_8>
        <k14_kodas_la>S_SISTEMINIS</k14_kodas_la>
    </K14>
</RET_DOK>
Response (status 400)

Klaida paduodant duomenis / SQL sintaksės klaidos / kitos DB klaidos

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id>21313695680.972f17c3.1591718687710</id>
    <durationMs>12</durationMs>
    <errorMessage>Invalid column name 'k14_kodas_4sa'.</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>/v2</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_K14_LIST",
    "params": {
        "fil": "k14_kodas_4a=\'001\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

K14

Nuoroda į lentelės aprašymą: K14