MGAMA_GET_K16_ATOST_LIST

Aprašymas

Personalo atostogų operacijų dokumentų nuskaitymas

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 : MGAMA_GET_K16_ATOST_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ę.

pvz application/xml:

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

pvz application/json:

{
    "method": "MGAMA_GET_K16_ATOST_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>000P00000041</K16_KODAS_6A>
        <K16_KODAS_6A_S>000000000026</K16_KODAS_6A_S>
        <K16_KODAS_6A_F>000000000026</K16_KODAS_6A_F>
        <K16_AT_RIBA>0</K16_AT_RIBA>
        <K16_BEG_DATE>2024-08-19T00:00:00</K16_BEG_DATE>
        <K16_DIENOS_SV>0.000</K16_DIENOS_SV>
        <K16_DIENU_SK>5.000</K16_DIENU_SK>
        <K16_DOK_NR>6AAT00001666</K16_DOK_NR>
        <K16_END_DATE>2024-08-23T00:00:00</K16_END_DATE>
        <K16_KAL>1</K16_KAL>
        <K16_KODAS_1A_19>555         </K16_KODAS_1A_19>
        <K16_KODAS_1A_25>           </K16_KODAS_1A_25>
        <K16_KODAS_4A>001         </K16_KODAS_4A>
        <K16_KOR_POZ>0</K16_KOR_POZ>
        <K16_OP_DATE>2024-08-19T00:00:00</K16_OP_DATE>
        <K16_PAV>koreguotas p1(darbuotojas r1)                               </K16_PAV>
        <K16_RUSIS>2</K16_RUSIS>
        <K16_SUT_NR>           </K16_SUT_NR>
        <K16_SUT_TIPAS>1</K16_SUT_TIPAS>
        <K16_PERKELTA>1</K16_PERKELTA>
        <K16_ADDUSR>VP          </K16_ADDUSR>
        <K16_R_DATE>2024-08-13T08:46:40</K16_R_DATE>
        <K16_USERIS>VP          </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>
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: 1234567.sssssssssssssssssssssssssssssssssssssssss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "MGAMA_GET_K16_ATOST_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