EDIT_A24

Aprašymas

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

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.

pvz application/xml:

<body>
    <method>EDIT_A24</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <A24>
            <A24_KODAS_TB>005</A24_KODAS_TB>
        </A24>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_A24",
    "params": {
        "oper": "I"
    },
    "data": {
        "A24": {
            "A24_KODAS_TB": "005"
        }
    }
}

Response (status 200 OK)

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

pvz:

<RET_DOK>
    <A24>
        <A24_KODAS_LI>000R00000039</A24_KODAS_LI>
        <A24_KODAS_TB>005         </A24_KODAS_TB>
        <A24_DOK_NR>LI0000000013</A24_DOK_NR>
        <A24_DATE>2024-12-20T00:00:00</A24_DATE>
        <A24_DATE_PB>2024-12-20T00:00:00</A24_DATE_PB>
        <A24_TIPAS>1</A24_TIPAS>
        <A24_PAV>v5                                                          </A24_PAV>
        <A24_VID_TIP>1</A24_VID_TIP>
        <A24_TB_KOR>0</A24_TB_KOR>
        <A24_KODAS_LG>           </A24_KODAS_LG>
        <A24_PASTABOS></A24_PASTABOS>
        <A24_SUMAM>0.00</A24_SUMAM>
        <A24_VIDUR>0.00</A24_VIDUR>
        <A24_LIG_TIP_POZ>0</A24_LIG_TIP_POZ>
        <A24_LIG_TIP>1</A24_LIG_TIP>
        <A24_KODAS_LS_1>           </A24_KODAS_LS_1>
        <A24_KODAS_LS_2>           </A24_KODAS_LS_2>
        <A24_KODAS_LS_3>           </A24_KODAS_LS_3>
        <A24_KODAS_LS_4>           </A24_KODAS_LS_4>
        <A24_EIL1>                                                 </A24_EIL1>
        <A24_EIL2>                                                 </A24_EIL2>
        <A24_EIL3>                                                 </A24_EIL3>
        <A24_EIL4>                                                 </A24_EIL4>
        <A24_EIL5>                                                 </A24_EIL5>
        <A24_NUM1>0.00</A24_NUM1>
        <A24_NUM2>0.00</A24_NUM2>
        <A24_NUM3>0.00</A24_NUM3>
        <A24_NUM4>0.00</A24_NUM4>
        <A24_NUM5>0.00</A24_NUM5>
        <A24_PERKELTA>1</A24_PERKELTA>
        <A24_USERIS>abcdef     </A24_USERIS>
        <A24_ADDUSR>abcdef     </A24_ADDUSR>
        <A24_R_DATE>2024-12-20T00:00:00</A24_R_DATE>
        <A24_KODAS_IS>           </A24_KODAS_IS>
        <A24_DOK_DATE>2024-12-20T00:00:00</A24_DOK_DATE>
        <A24_KODAS_GS>           </A24_KODAS_GS>
        <A24_BUSENA>1</A24_BUSENA>
        <a24_date_pr>2024-12-20T00:00:00</a24_date_pr>
        <A24_LAIKAS_MOK>0.00</A24_LAIKAS_MOK>
    </A24>
</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;A24>&lt;/A24></data>
            <dataErrors>
                <dataError>
                    <tag>A24_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_A24</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <A24>
            <A24_KODAS_LI>000R00000039</A24_KODAS_LI>
            <A24_PAV>Naujas pavadinimas</A24_PAV>
        </A24>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_A24</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <A24>
            <A24_KODAS_LI>000R00000039</A24_KODAS_LI>
        </A24>
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: abcdef.12345678910',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
        "method": "EDIT_A24",
        "params": {
            "oper": "I"
        },
        "data": {
            "A24": {
                "A24_KODAS_TB": "005"
            }
    }
    }');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

A24

Algos dokumento informacija

Laukas	Tipas	Aprašymas
A24_KODAS_LI	char(12)	Operacijos Nr.
A24_KODAS_TB	char(12)	Tabelinis Nr.
A24_DOK_NR	char(12)	Dokumento Nr.
A24_DATE	datetime	Data
A24_DATE_PB	datetime	Pabaigos data
A24_TIPAS	numeric(2,0)	Tipas:1-atostoginiai,2-ligonlapiai (iš įmonės),3-ligonlapiai (iš sodros),4-kiti vidurkiai
A24_PAV	char(60)	Pavadinimas
A24_VID_TIP	numeric(1,0)	Vidurkio tipas:1-darbo dienos,2-darbo valandos,3-kalend.dienos,4-kalend.valandos
A24_TB_KOR	numeric(1,0)	Koreguoti tabelį:0-ne;1-taip
A24_KODAS_LG	char(12)	Tabelio diena kuria koreguojamas tabelis
A24_PASTABOS	varchar(max)	Pastabos
A24_SUMAM	numeric(12,2)	Metinė premija
A24_VIDUR	numeric(12,2)	Bendras vidurkis
A24_LIG_TIP_POZ	numeric(1,0)	Ligos tipo požymis
A24_LIG_TIP	numeric(1,0)	Ligos tipas:1-ligos,2-nėštumo,3-vaiko priež.
A24_KODAS_LS_1	char(12)	Logistikos kodas1
A24_KODAS_LS_2	char(12)	Logistikos kodas2
A24_KODAS_LS_3	char(12)	Logistikos kodas3
A24_KODAS_LS_4	char(12)	Logistikos kodas4
A24_EIL1	char(50)	Eilutė1
A24_EIL2	char(50)	Eilutė2
A24_EIL3	char(50)	Eilutė3
A24_EIL4	char(50)	Eilutė4
A24_EIL5	char(50)	Eilutė5
A24_NUM1	numeric(12,2)	Skaičius1
A24_NUM2	numeric(12,2)	Skaičius2
A24_NUM3	numeric(12,2)	Skaičius3
A24_NUM4	numeric(12,2)	Skaičius4
A24_NUM5	numeric(12,2)	Skaičius5
A24_PERKELTA	numeric(1,0)	Požymis:1-naujas,2-perkeltas,3-koreguota
A24_USERIS	char(12)	Kas koregavo
A24_ADDUSR	char(12)	Įrašo autorius
A24_R_DATE	datetime	Kada koregavo
A24_KODAS_IS	char(12)	Padalinio kodas
A24_DOK_DATE	datetime	Dokumento data
A24_KODAS_GS	char(12)	Grupė
A24_BUSENA	numeric(3,0)	Būsena
A24_DATE_PR	datetime	Pradžios data
A24_LAIKAS_MOK	numeric(12,2)	Apmokamas laikas