MGAMA_GET_K16_ATPRA_LIST

Aprašymas

Personalo atostogų pratęsimo dokumentų nuskaitymas

Specifikacija

Informacija apie autorizaciją, bendruosius parametrus ir klaidų kodus: Rivile API v2 naudojimo pagrindai

Body
  • method : MGAMA_GET_K16_ATPRA_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės K16 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ę.

Pagal nutylėjimą nuskaityti galima tik to paties API vartotojo sukurtas operacijas. Teisės valdomos parametru RGI_ALL_EDIT

Kadangi darbuotojų kortelėse gali būti saugoma konfidenciali informacija, jau egzistuojančių įrašų nuskaitymui ir koregavimui būtinas papildomas leidimas per Rivile Gama parametrą RGI_K14_FIL. Šiame parametre įvedamas papildomas filtravimas, galimų reikšmių pavyzdžiai: 1=1 (visos darbuotojų kortelės), K14_KODAS_LS_1='L1' (tik darbuotojų kortelės su pirmu logistikos kodu 'L1'). Filtravimo sąlygose galima naudoti visus lentelės K14 laukus.

pvz application/xml:

<body>
    <method>MGAMA_GET_K16_ATPRA_LIST</method>
    <params>
        <fil>k16_kodas_6a='000R00001252'</fil>
        <pageNumber>2</pageNumber>
    </params>
</body>

pvz application/json:

{
    "method": "MGAMA_GET_K16_ATPRA_LIST",
    "params": {
        "fil": "k16_kodas_6a='000R00001252'",
        "pageNumber": 2
    }
}
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ą K16_KODAS_6A

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

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <K16>
        <ROW_NUMBER>1</ROW_NUMBER>
        <K16_KODAS_6A>000R00016999</K16_KODAS_6A>
        <K16_KODAS_6A_S>000R00016997</K16_KODAS_6A_S>
        <K16_KODAS_6A_F>000R00016997</K16_KODAS_6A_F>
        <K16_BEG_DATE>2024-06-12T00:00:00</K16_BEG_DATE>
        <K16_DIENOS_SV>0.000</K16_DIENOS_SV>
        <K16_DIENU_SK>10.000</K16_DIENU_SK>
        <K16_DOK_NR>6AATP0000288</K16_DOK_NR>
        <K16_END_DATE>2024-06-21T00:00:00</K16_END_DATE>
        <K16_KODAS_0A>555         </K16_KODAS_0A>
        <K16_KODAS_1A_19>           </K16_KODAS_1A_19>
        <K16_KODAS_1A_25>           </K16_KODAS_1A_25>
        <K16_KODAS_4A>001         </K16_KODAS_4A>
        <K16_KODAS_5A>           </K16_KODAS_5A>
        <K16_KODAS_IS>999999999999</K16_KODAS_IS>
        <K16_OP_DATE>2024-09-04T00:00:00</K16_OP_DATE>
        <K16_PAV>koreguotas p1(darbuotojas r1)                               </K16_PAV>
        <K16_RUSIS>1</K16_RUSIS>
        <K16_SUT_NR>000R00016998</K16_SUT_NR>
        <K16_PERKELTA>1</K16_PERKELTA>
        <K16_ADDUSR>9JOITM2     </K16_ADDUSR>
        <K16_R_DATE>2024-09-04T11:56:27</K16_R_DATE>
        <K16_USERIS>9JOITM2     </K16_USERIS>
    </K16>
    <K16>
        ...
    </K16>
    ...
</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>3451ded.be556121580910178112</id>
    <durationMs>25</durationMs>
    <errorMessage>Invalid column name 'k16_kodas_a6'.</errorMessage>
</RET_DOK>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: 1234567.sssssssssssssssssssssssssssssssssssssssss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "MGAMA_GET_K16_ATPRA_LIST",
    "params": {
        "fil": "k16_kodas_6a=\'000R00001252\'",
        "pageNumber": 2
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

K16

Nuoroda į lentelės aprašymą: K16