EDIT_A11

Aprašymas

Darbuotojų priskaitymų/atskaitymų koregavimas.

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 : EDIT_A11
  • params :
    • oper :
    • I - naujo įrašo sukūrimas (numatytasis)
    • U - dokumento koregavimas
    • D - dokumento ištrynimas
  • data: perduodami duomenys:
    • A11 - Personalo operacijų antraštė (a11)

Pirmi 7 ApiKey simboliai (pvz USERABC.JQKPGdd7Pkjxj37ObsgdfEkvfEfvF1oL7h7UMOLo -> USERABC) yra vartotojo vardas Rivile GAMA programoje, kuriuo bus kuriami ar koreguojami įrašai.

Vienu metu veiksmai atliekami tik su vienu įrašu.

Koreguoti 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_A06_FIL. Šiame parametre įvedamas papildomas filtravimas, galimų reikšmių pavyzdžiai: 1=1 (visos darbuotojų kortelės), A11_KODAS_TB='004' (tik darbuotojų kortelės su tabeliniu kodu '004'). Filtravimo sąlygose galima naudoti visus lentelės A11 laukus.

XML Request pvz.:

<body>
    <method>EDIT_A11</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <A11>
            <A11_KODAS_LP>100</A11_KODAS_LP>
            <A11_KODAS_TB>004</A11_KODAS_TB>
            <A11_KODAS_IS>999999999999</A11_KODAS_IS>
        </A11>
    </data>
</body>

JSON Request pvz.:

{
    "method": "EDIT_A11",
    "params": {
        "oper": "I"
    },
    "data": {
        "A11": {
            "A11_KODAS_LP": "100",
            "A11_KODAS_TB": "004",
            "A11_KODAS_IS": "999999999999"
        }
    }
}
Response (status 200 OK)

XML response pvz.:

<RET_DOK>
    <A11>
        <A11_KODAS_LP>000000000100</A11_KODAS_LP>
        <A11_TIPAS>1</A11_TIPAS>
        <A11_KODAS_TB>004         </A11_KODAS_TB>
        <A11_KODAS_IS>999999999999</A11_KODAS_IS>
        <A11_EIL_NR>14</A11_EIL_NR>
        <A11_PAV> Etatinis atlyginimas var pav</A11_PAV>
        <A11_ATS_IP>0</A11_ATS_IP>
        <A11_IP_DOK>                   </A11_IP_DOK>
        <A11_IP_SUMA>0.00</A11_IP_SUMA>
        <A11_POZ_DATE>0</A11_POZ_DATE>
        <A11_BEG_DATE>2025-02-13T00:00:00</A11_BEG_DATE>
        <A11_END_DATE>2025-02-13T00:00:00</A11_END_DATE>
        <A11_USERIS>*******     </A11_USERIS>
        <A11_R_DATE>2025-02-13T00:00:00</A11_R_DATE>
        <A11_KODAS_SS>           </A11_KODAS_SS>
        <A11_KODAS_KS>           </A11_KODAS_KS>
    </A11>
</RET_DOK>

JSON response pvz.:

{
    "A11": {
        "A11_KODAS_LP": "000000000100",
        "A11_TIPAS": "1",
        "A11_KODAS_TB": "004",
        "A11_KODAS_IS": "999999999999",
        "A11_EIL_NR": "14",
        "A11_PAV": "Etatinis atlyginimas var pav",
        "A11_ATS_IP": "0",
        "A11_IP_DOK": "",
        "A11_IP_SUMA": "0.00",
        "A11_POZ_DATE": "0",
        "A11_BEG_DATE": "2025-02-13T00:00:00",
        "A11_END_DATE": "2025-02-13T00:00:00",
        "A11_USERIS": "*******",
        "A11_R_DATE": "2025-02-13T00:00:00",
        "A11_KODAS_SS": "",
        "A11_KODAS_KS": ""
    }
}
Response (status 400)

Klaida paduodant duomenis / SQL sintaksinės klaidos / kitos duomenų klaidos, pvz.:

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id>4641133481.40a6e682.1739444053694</id>
    <durationMs>33</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data>&lt;A11>&lt;num_row>1&lt;/num_row>&lt;A11_KODAS_LP>1007&lt;/A11_KODAS_LP>&lt;A11_KODAS_TB>004&lt;/A11_KODAS_TB>&lt;A11_KODAS_IS>999999999999&lt;/A11_KODAS_IS>&lt;/A11></data>
            <dataErrors>
                <dataError>
                    <tag>A11_KODAS_LP</tag>
                    <code>552216</code>
                    <message>Nerastas priskaitymas [000000001007]</message>
                </dataError>
            </dataErrors>
        </error>
    </errors>
</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 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>
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>

Koregavimas ir trynimas

Koregavimas ir trynimas vyksta pagal atitinkamos lentelės raktą (Primary Key).

Koreguojant informaciją bus koreguojami tik perduodami laukai.

Pvz. koregavimas:

<body>
    <method>EDIT_A11</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <A11>
            <A11_KODAS_LP>100</A11_KODAS_LP>
            <A11_TIPAS>1</A11_TIPAS>
            <A11_KODAS_TB>004</A11_KODAS_TB>
            <A11_EIL_NR>14</A11_EIL_NR>
            <A11_KODAS_IS>9999999999999</A11_KODAS_IS>
            <A11_PAV>update</A11_PAV>
        </A11>
    </data>
</body>

Pvz. trynimas:

<body>
    <method>EDIT_A11</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <A11>
            <A11_KODAS_LP>100</A11_KODAS_LP>
            <A11_TIPAS>1</A11_TIPAS>
            <A11_KODAS_TB>004</A11_KODAS_TB>
            <A11_EIL_NR>14</A11_EIL_NR>
            <A11_KODAS_IS>9999999999999</A11_KODAS_IS>
        </A11>
    </data>
</body>

PHP pavyzdys:

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: *******.************',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "EDIT_A11",
    "params": {
        "oper": "I"
    },
    "data": {
        "A11": {
            "A11_KODAS_LP": "100",
            "A11_KODAS_TB": "004",
            "A11_KODAS_IS": "999999999999"
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

A11

Darbuotojų priskaitymų/atskaitymų koregavimo informacija

Kodas Tipas Aprašymas Pastabos naudojant EDIT metodus
A11_KODAS_LP char(12) Priskaitymas/Atskaitymas
A11_TIPAS numeric(1,0) Tipas: 1-priskaitymas,2-atskaitymas
A11_KODAS_TB char(12) Tabelinis Nr.
A11_KODAS_IS char(12) Padalinys
A11_EIL_NR numeric(6,0) Eilutės numeris(unikalumui)
A11_PAV char(60) Aprašymas
A11_ATS_IP numeric(1,0) Ypatingas atskaitymas
A11_IP_DOK char(20) Ypatingo atskaitymo Dok.Nr.
A11_IP_SUMA numeric(12,2) Ypatingo atskaitymo visa suma
A11_POZ_DATE numeric(1,0) Terminuota
A11_BEG_DATE datetime Pradžios data
A11_END_DATE datetime Pabaigos data
A11_USERIS char(12) Kas koregavo
A11_R_DATE datetime Kada koregavo
A11_KODAS_SS char(12) Sąskaitos kodas
A11_KODAS_KS char(12) Kliento kodas