EDIT_A26

Aprašymas

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

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_A26</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <A26>
            <A26_KODAS_LE>tst10</A26_KODAS_LE>
        </A26>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_A26",
    "params": {
        "oper": "I"
    },
    "data": {
        "A26": {
            "A26_KODAS_LE": "tst10"
        }
    }
}

Response (status 200 OK)

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

pvz:

<RET_DOK>
    <A26>
        <A26_KODAS_LE>TST10       </A26_KODAS_LE>
        <A26_PAV>                                                           </A26_PAV>
        <A26_SK_ETAT>1</A26_SK_ETAT>
        <A26_PASTABOS>                                                           </A26_PASTABOS>
        <A26_USERIS>abcdef     </A26_USERIS>
        <A26_R_DATE>2025-01-07T08:42:00</A26_R_DATE>
        <A26_POZ_DATE>0</A26_POZ_DATE>
        <A26_BEG_DATE>2025-01-07T00:00:00</A26_BEG_DATE>
        <A26_END_DATE>2025-01-07T00:00:00</A26_END_DATE>
    </A26>
</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.e87d4598.1736232200782</id>
    <durationMs>29</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data></data>
            <dataErrors>
                <dataError>
                    <tag>A26_KODAS_LE</tag>
                    <code>8003</code>
                    <message>Tokio įrašo nėra</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_A26</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <A26>
            <A26_KODAS_LE>tst10</A26_KODAS_LE>
            <A26_PAV>koreguotas pavadinimas</A26_PAV>
            <A26_PASTABOS>koreguotas pastabu laukas</A26_PASTABOS>
        </A26>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_A24</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <A26>
            <A26_KODAS_LE>tst10</A26_KODAS_LE>
        </A26>
    </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_A26",
        "params": {
            "oper": "I"
        },
        "data": {
            "A26": {
                "A24_KODAS_LE": "tst10"
            }
    }
    }');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

A26

Algos - pareigos informacija

Laukas	Tipas	Aprašymas
A26_KODAS_LE	char(12)	Kodas
A26_PAV	char(60)	Pavadinimas
A26_SK_ETAT	numeric(6,0)	Etatų skaičius
A26_PASTABOS	char(60)	Pastabos
A26_USERIS	char(12)	Kas koregavo
A26_R_DATE	datetime	Kada koregavo
A26_POZ_DATE	numeric(1,0)	Terminuota: 0-ne ,1-taip
A26_BEG_DATE	datetime	Pradžios data
A26_END_DATE	datetime	Pabaigos data