MGAMA_GET_PERS_LIK

Aprašymas

Metodas grąžina darbuotojų atostogų informaciją pateiktai datai. Užklausos atsakymas pateikiamas kiekvienai unikaliai priėmimo operacijai.

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_PERS_LIK
params :
- pagenumber: parametras nurodo kelintą puslapį grąžinti. Jei nenurodomas, tuomet grąžinamas pirmas puslapis su 100 įrašų. Neprivaloma.
- datai: nurodoma kuriai datai paskaičiuoti atostogų likutį. Jei nenurodoma informacija grąžinama šiandien dienai. Neprivaloma.
- kodas_6a_f: pirminės priėmimo operacijos numeris. Neprivalomas.
- kodas_6a_s: aktyvios priėmimo/perkėlimo operacijos numeris. Neprivalomas.
- kodas_4a: personalo kodas (asmens kortelės numeris). Neprivalomas.
- kodas_is: aktyvios priėmimo operacijos padalinio kodas. Neprivalomas.
- kodas_0a: aktyvios priėmimo operacijos etato kodas. Neprivalomas.
- kodas_5a: aktyvios priėmimo operacijos specialybės kodas. Neprivalomas.

Nuskaitant informaciją datai, nėra atsižvelgiama kokia tuo metu bus ar buvo aktyvi priėmimo operacija. Visuomet skaičiuojamas likutis esamai aktyviai priėmimo sutarčiai.

MGAMA_GET_PERS_LIK metodas apribojimas 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ę.

MGAMA grupės metodams taikomas atskiras apmokestinimas, kuris apibrėžtas nuomos sutartyje.

pvz application/xml:

<body>
    <method>MGAMA_GET_PERS_LIK</method>
    <params>
        <pagenumber>1</pagenumber>
        <datai>2024-12-31</datai>
        <kodas_4a>DARBUOTOJAS1</kodas_4a>
    </params>
</body>

pvz application/json:

{
    "method": "MGAMA_GET_PERS_LIK",
    "params": {
        "pagenumber": "1",
        "datai": "2024-12-31",
        "kodas_4a": "DARBUOTOJAS1"
    }
}

Response (status 200 OK)

Grąžinama informacija XML formate tarp tag'ų <RET_DOK>..</RET_DOK>.

pvz:

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <ATOSTOGOS>
        <datai>2024-12-31T00:00:00</datai>
        <kodas_6a_f>000000000004</kodas_6a_f>
        <priemimoData>2023-01-17</priemimoData>
        <kodas_6a_s>000000000004</kodas_6a_s>
        <kodas_4a>DARBUOTOJAS1</kodas_4a>
        <kodas_is>01          </kodas_is>
        <kodas_5a>           </kodas_5a>
        <kodas_0a>PROJ1       </kodas_0a>
        <pareigos>Projektų vadovas</pareigos>
        <sukaupta>39.128</sukaupta>
        <panaudota>6.000</panaudota>
        <koreguota>0.000</koreguota>
        <likutis>33.128</likutis>
    </ATOSTOGOS>
    <ATOSTOGOS>
        <datai>2024-12-31T00:00:00</datai>
        <kodas_6a_f>000000000009</kodas_6a_f>
        <priemimoData>2019-01-03</priemimoData>
        <kodas_6a_s>000000000009</kodas_6a_s>
        <kodas_4a>DARBUOTOJAS1</kodas_4a>
        <kodas_is>999999999999</kodas_is>
        <kodas_5a>           </kodas_5a>
        <kodas_0a>1           </kodas_0a>
        <pareigos>Vadybininkas</pareigos>
        <sukaupta>119.891</sukaupta>
        <panaudota>0.000</panaudota>
        <koreguota>0.000</koreguota>
        <likutis>119.891</likutis>
    </ATOSTOGOS>
    ...
</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>0</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": "MGAMA_GET_PERS_LIK",
    "params": {
        "pagenumber": "1",
        "datai": "2024-12-31",
        "kodas_4a": "DARBUOTOJAS1"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Rezultatas

Atostogų informacija pagal priėmimo sutartį.

Laukas	Tipas	Aprašymas
DATAI	T	Data, kuriai paskaičiuojami atostogų likučiai
KODAS_6A_F	C(12)	Pirminės priėmimo operacijos kodas
KODAS_6A_S	C(12)	Aktyvios priėmimo operacijos kodas
PRIEMIMODATA	D	Pirminės priėmimo operacijos data (priėmimo data)
KODAS_4A	C(12)	Personalo kodas
KODAS_IS	C(12)	Aktyvios priėmimo operacijos padalinio kodas
KODAS_0A	C(12)	Aktyvios priėmimo operacijos etato kodas
KODAS_5A	C(12)	Aktyvios priėmimo operacijos specialybės kodas
PAREIGOS	C(150)	Aktyvios priėmimo operacijos pareigų pavadinimas
SUKAUPTA	N(12,3)	Kiek sukaupta atostogų nurodytai datai
PANAUDOTA	N(12,3)	Kiek panaudota atostogų nurodytai datai
KOREGUOTA	N(12,3)	Kiek iškoreguotas periodas (dėl neatvykimų ir pan.), dienos kurios į atostogų skaičiavimą neįtraukiamos
LIKUTIS	N(12,3)	Atostogų likutis datai, įvertinant tik sistemoje perkeltus atostogų dokumentus