EDIT_K24

Aprašymas

Personalo vaikų sąrašo sukūrimas, koregavimas, trinimas

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_K24
params :
- oper :
  - I - naujos kortelės sukūrimas
  - U - kortelės koregavimas
  - D - kortelės išmetimas
data: perduodami duomenys:
- K24 - personalo vaikų informacija (k24)

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_K24</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <K24>
            <K24_KODAS_4A>001</K24_KODAS_4A>
            <K24_VARDAS>Vaikas Vardenis</K24_VARDAS>
            <K24_PAVARDE>Pavardė</K24_PAVARDE>
            <K24_G_DATE>2015.01.01</K24_G_DATE>
            <K24_AS_KODAS>333333333</K24_AS_KODAS>
            <K24_INV>0</K24_INV>
            <K24_PASTABOS></K24_PASTABOS>
        </K24>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_K24",
    "params": {
        "oper": "I"
    },
    "data": {
        "K24": {
            "K24_KODAS_4A": "001",
            "K24_VARDAS": "Vaikas Vardenis",
            "K24_PAVARDE": "Pavardė",
            "K24_G_DATE": "2015.01.01",
            "K24_AS_KODAS": "333333333",
            "K24_INV": 0,
            "K24_PASTABOS": ""
        }
    }
}

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>
    <K24>
        <K24_KODAS_4A>001</K24_KODAS_4A>
        <K24_EIL_NR>2</K24_EIL_NR>
        <K24_VARDAS>Vaikas Vardenis</K24_VARDAS>
        <K24_PAVARDE>Pavardė</K24_PAVARDE>
        <K24_G_DATE>2015-01-01T00:00:00</K24_G_DATE>
        <K24_AS_KODAS>333333333</K24_AS_KODAS>
        <K24_INV>0</K24_INV>
        <K24_PASTABOS></K24_PASTABOS>
        <K24_USERIS>B1NOONQ</K24_USERIS>
        <K24_ADDUSR>B1NOONQ</K24_ADDUSR>
        <K24_R_DATE>2020-06-25T16:10:20</K24_R_DATE>
        <K24_ADD_DATE>2020-06-25T16:10:20</K24_ADD_DATE>
    </K24>
</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>21313695680.3ed9a8db.1593091193222</id>
    <durationMs>4</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <errors>
        <error>
            <data>&lt;K24>&lt;K24_INV>0&lt;/K24_INV>&lt;K24_PAVARDE>1&lt;/K24_PAVARDE>&lt;K24_PASTABOS/>&lt;K24_KODAS_44A>0011&lt;/K24_KODAS_44A>&lt;K24_EIL_NR>2&lt;/K24_EIL_NR>&lt;K24_VARDAS>Vaikas Vardenis&lt;/K24_VARDAS>&lt;K24_G_DATE>2015.01.01&lt;/K24_G_DATE>&lt;K24_AS_KODAS>333333333&lt;/K24_AS_KODAS>&lt;/K24></data>
        <dataErrors>
            <dataError>
                <tag>K24_KODAS_4A</tag>
                <code>19013</code>
                <message>Nenurodytas kodas</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>/v1</path>
</Map>

Koregavimas ir trinimas

Koregavimas, trynimas vykdomas pagal lentelės raktą (Primary Key)

Koreguojant informaciją bus koreguojami tik perduodami laukai.

pvz trinimas:

<body>
    <method>EDIT_K24</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <K24>
            <K24_KODAS_4A>001</K24_KODAS_4A>
            <K24_EIL_NR>2</K24_EIL_NR>
        </K24>
    </data>
</body>

pvz koregavimas:

<body>
    <method>EDIT_K24</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <K24>
            <K24_KODAS_4A>001</K24_KODAS_4A>
            <K24_EIL_NR>1</K24_EIL_NR>
            <K24_VARDAS>Testas</K24_VARDAS>
        </K24>
    </data>
</body>

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": "EDIT_K24",
    "params": {
        "oper": "I"
    },
    "data": {
        "K24": {
            "K24_KODAS_4A": "001",
            "K24_VARDAS": "Vaikas Vardenis",
            "K24_PAVARDE": "Pavardė",
            "K24_G_DATE": "2015.01.01",
            "K24_AS_KODAS": "333333333",
            "K24_INV": 0,
            "K24_PASTABOS": ""
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

K24

Personalo vaikų lentelė.

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
K24_KODAS_4A	C(12)	Kodas	Privalomas , kai oper=U,D
K24_EIL_NR	N(6)	Eilės Nr.	Privalomas , kai oper=U,D
K24_VARDAS	C(20)	Vardas
K24_PAVARDE	C(20)	Pavardė
K24_G_DATE	T(8)	Gimimo data
K24_AS_KODAS	C(21)	Asmens kodas
K24_INV	N(1)	Invalidumo požymis
K24_PASTABOS	C(60)	Pastabos
K24_USERIS	C(12)	Kas koregavo
K24_ADDUSR	C(12)	Kas sukūrė
K24_R_DATE	T(8)	Kada koregavo
K24_ADD_DATE	T(8)	Kada sukūrė