EDIT_A08

Aprašymas

Darbuotojo bankų 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_A08
params :
- oper :
  - I - naujo įrašo sukūrimas
  - U - įrašo koregavimas
  - D - įrašo ištrynimas
data: perduodami duomenys:
- A08 - atitinkamos lentelės laukai (A08)

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

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

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), A06_KODAS_LS_1='L1' (tik darbuotojų kortelės su pirmu logistikos kodu 'L1'). Filtravimo sąlygose galima naudoti visus lentelių A06, A07 ir A08 laukus.

pvz application/xml:

<body>
    <method>EDIT_A08</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <A08>
            <A08_KODAS_TB>TST01</A08_KODAS_TB>
            <A08_KODAS_WS>10100</A08_KODAS_WS>
            <A08_PAV></A08_PAV>
            <A08_SUMA></A08_SUMA>
            <A08_PROC></A08_PROC>
            <A08_TAUP_FIL></A08_TAUP_FIL>
            <A08_TAUP_RUS></A08_TAUP_RUS>
            <A08_TAUP_SAS></A08_TAUP_SAS>
            <A08_PASTABOS></A08_PASTABOS>
        </A08>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_A08",
    "params": {
        "oper": "I"
    },
    "data": {
        "A08": {
            "A08_KODAS_TB": "TST01",
            "A08_KODAS_WS": "10100",
            "A08_PAV": "",
            "A08_SUMA": "",
            "A08_PROC": "",
            "A08_TAUP_FIL": "",
            "A08_TAUP_RUS": "",
            "A08_TAUP_SAS": "",
            "A08_PASTABOS": ""
        }
    }
}

Response (status 200 OK)

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

pvz:

<RET_DOK>
    <A08>
        <A08_KODAS_TB>TST01       </A08_KODAS_TB>
        <A08_KODAS_WS>10100       </A08_KODAS_WS>
        <A08_PAV>Lietuvos bankas                                             </A08_PAV>
        <A08_SUMA>0.00</A08_SUMA>
        <A08_PROC>0.00</A08_PROC>
        <A08_TAUP_FIL>                   </A08_TAUP_FIL>
        <A08_TAUP_RUS>                   </A08_TAUP_RUS>
        <A08_TAUP_SAS>                                       </A08_TAUP_SAS>
        <A08_PASTABOS> </A08_PASTABOS>
        <A08_USERIS>AAAAAAAA     </A08_USERIS>
        <A08_R_DATE>2024-10-29T09:09:26</A08_R_DATE>
    </A08>
</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>4641133481.8ec4537a.1716271246499</id>
    <durationMs>569</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data>&lt;A08>&lt;/A08></data>
            <dataErrors>
                <dataError>
                    <tag>A08_KODAS_TB</tag>
                    <code>5009</code>
                    <message>Kodas nerastas</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 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>

Koregavimas ir išmetimas

Koregavimas, išmetimas vyksta pagal lentelės raktą (Primary Key)

Koreguojant informaciją bus koreguojami tik perduodami laukai.

pvz koregavimas:

<body>
    <method>EDIT_A08</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <A08>
            <A08_KODAS_TB>TST01</A08_KODAS_TB>
            <A08_KODAS_WS>10100</A08_KODAS_WS>
            <A08_SUMA>123</A08_SUMA>
        </A08>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_A08</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <A08>
            <A08_KODAS_TB>TST01</A08_KODAS_TB>
            <A08_KODAS_WS>10100</A08_KODAS_WS>
        </A08>
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: 9999999.12345678910',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
        "method": "EDIT_A08",
        "params": {
            "oper": "I"
        },
        "data": {
            "A08": {
                "A08_KODAS_TB": "TST01",
                "A08_KODAS_WS": "10100",
                "A08_PAV": "",
                "A08_SUMA": "",
                "A08_PROC": "",
                "A08_TAUP_FIL": "",
                "A08_TAUP_RUS": "",
                "A08_TAUP_SAS": "",
                "A08_PASTABOS": ""
            }
    }
    }');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

A08

Darbuotojo banko informacija

Laukas	Tipas	Aprašymas
A08_KODAS_TB	char(12)	Tabelinis Nr.
A08_KODAS_WS	char(12)	Bankas
A08_PAV	char(60)	Pavadinimas
A08_SUMA	numeric(12,2)	Suma
A08_PROC	numeric(6,2)	Procentas
A08_TAUP_FIL	char(20)	Filialas
A08_TAUP_RUS	char(20)	Indėlio rūšis
A08_TAUP_SAS	char(40)	Indėlio sąskaita
A08_PASTABOS	varchar(max)	Pastabos
A08_USERIS	char(12)	Kas koregavo
A08_R_DATE	datetime	Kada koregavo