EDIT_K34

Aprašymas

Personalo išsilavinimo informacijos 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_K34
params :
- oper :
  - I - naujos kortelės sukūrimas
  - U - kortelės koregavimas
  - D - kortelės išmetimas
data: perduodami duomenys:
- K34 - personalo vaikų informacija (k34)

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_K34</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <K34>
            <K34_KODAS_4A>001</K34_KODAS_4A>
            <K34_TIPAS>1</K34_TIPAS>
            <K34_PAV>Aukštasis mokslas</K34_PAV>
            <K34_DATE>2015.01.02 00:00</K34_DATE>
            <K34_DOK_NR>123456</K34_DOK_NR>
            <K34_KODAS_1A_06>AUKSTASIS</K34_KODAS_1A_06>
            <K34_KODAS_1A_07>BAKALAURAS</K34_KODAS_1A_07>
            <K34_KODAS_1A_08>DOC</K34_KODAS_1A_08>
            <K34_KODAS_5A>ABC</K34_KODAS_5A>
            <K34_SRITIS>Inžinierius</K34_SRITIS>
            <K34_ISDAVEJAS>Doc. Testauskas</K34_ISDAVEJAS>
        </K34>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_K34",
    "params": {
        "oper": "I"
    },
    "data": {
        "K34": {
            "K34_KODAS_4A": "001",
            "K34_TIPAS": 1,
            "K34_PAV": "Aukštasis mokslas",
            "K34_DATE": "2015.01.02",
            "K34_DOK_NR": "123456",
            "K34_KODAS_1A_06": "AUKSTASIS",
            "K34_KODAS_1A_07": "BAKALAURAS",
            "K34_KODAS_1A_08": "DOC",
            "K34_KODAS_5A": "ABC",
            "K34_SRITIS": "Inžinierius",
            "K34_ISDAVEJAS": "Doc. Testauskas"
        }
    }
}

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>
    <K34>
        <K34_KODAS_4A>001</K34_KODAS_4A>
        <K34_EIL_NR>3</K34_EIL_NR>
        <K34_TIPAS>1</K34_TIPAS>
        <K34_PAV>Aukštasis mokslas</K34_PAV>
        <K34_DATE>2015-01-02T00:00:00</K34_DATE>
        <K34_DOK_NR>123456</K34_DOK_NR>
        <K34_KODAS_1A_06>AUKSTASIS</K34_KODAS_1A_06>
        <K34_KODAS_1A_07>BAKALAURAS</K34_KODAS_1A_07>
        <K34_KODAS_1A_08>DOC</K34_KODAS_1A_08>
        <K34_KODAS_5A>ABC</K34_KODAS_5A>
        <K34_SRITIS>Inžinierius</K34_SRITIS>
        <K34_ISDAVEJAS>Doc. Testauskas</K34_ISDAVEJAS>
        <K34_POZ_DATE>0</K34_POZ_DATE>
        <K34_BEG_DATE>2020-06-26T00:00:00</K34_BEG_DATE>
        <K34_END_DATE>2020-06-26T00:00:00</K34_END_DATE>
        <K34_USERIS>B1NOONQ</K34_USERIS>
        <K34_ADDUSR>B1NOONQ</K34_ADDUSR>
        <K34_R_DATE>2020-06-26T09:04:04</K34_R_DATE>
        <K34_ADD_DATE>2020-06-26T09:04:04</K34_ADD_DATE>
    </K34>
</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.e6861671.1593151753310</id>
    <durationMs>7</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <errors>
        <error>
            <data>&lt;K34>&lt;K34_TIPAS>1&lt;/K34_TIPAS>&lt;K34_KODAS_4AA>001&lt;/K34_KODAS_4AA>&lt;K34_PAV>Aukštasis mokslas&lt;/K34_PAV>&lt;K34_ISDAVEJAS>Doc. Testauskas&lt;/K34_ISDAVEJAS>&lt;K34_KODAS_5A>ABC&lt;/K34_KODAS_5A>&lt;K34_SRITIS>Inžinierius&lt;/K34_SRITIS>&lt;K34_DATE>2015.01.02 00:00&lt;/K34_DATE>&lt;K34_KODAS_1A_06>AUKSTASIS&lt;/K34_KODAS_1A_06>&lt;K34_KODAS_1A_07>BAKALAURAS&lt;/K34_KODAS_1A_07>&lt;K34_DOK_NR>123456&lt;/K34_DOK_NR>&lt;K34_KODAS_1A_08>DOC&lt;/K34_KODAS_1A_08>&lt;/K34></data>
            <dataErrors>
                <dataError>
                    <tag>K34_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_K34</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <K34>
            <K34_KODAS_4A>001</K34_KODAS_4A>
            <K34_EIL_NR>4</K34_EIL_NR>
        </K34>
    </data>
</body>

pvz koregavimas:

<body>
    <method>EDIT_K34</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <K34>
            <K34_KODAS_4A>001</K34_KODAS_4A>
            <K34_EIL_NR>2</K34_EIL_NR>
            <K34_DOK_NR>AB123</K34_DOK_NR>
        </K34>
    </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_K34",
    "params": {
        "oper": "I"
    },
    "data": {
        "K34": {
            "K34_KODAS_4A": "001",
            "K34_TIPAS": 1,
            "K34_PAV": "Aukštasis mokslas",
            "K34_DATE": "2015.01.02",
            "K34_DOK_NR": "123456",
            "K34_KODAS_1A_06": "AUKSTASIS",
            "K34_KODAS_1A_07": "BAKALAURAS",
            "K34_KODAS_1A_08": "DOC",
            "K34_KODAS_5A": "ABC",
            "K34_SRITIS": "Inžinierius",
            "K34_ISDAVEJAS": "Doc. Testauskas"
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

K34

Personalo išsilavinimo lentelė.

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
K34_KODAS_4A	C(12)	Kodas	Privalomas , kai oper=U,D
K34_EIL_NR	N(6)	Eilės Nr.	Privalomas , kai oper=U,D
K34_TIPAS	N(1)	Tipas.1-Išsimokslinimas,2-laipsnis,3-Ped.mok.vardas,4-Licensijos
K34_PAV	C(100)	Pavadinimas/Suteikta kvalifikacija
K34_DATE	T(8)	Suteikimo data
K34_DOK_NR	C(20)	Diplomo numeris
K34_KODAS_1A_06	C(12)	Išsimokslinimo kodas
K34_KODAS_1A_07	C(12)	Mokslo laipsnis
K34_KODAS_1A_08	C(12)	Mokslo vardas
K34_KODAS_5A	C(12)	Specialybės kodas
K34_SRITIS	C(100)	Mokslo sritis/Specialybė
K34_ISDAVEJAS	C(100)	Kas išdavė
K34_POZ_DATE	N(1)	Ar terminuota 1-Taip,0-Ne
K34_BEG_DATE	T(8)	Pradžios data
K34_END_DATE	T(8)	Pabaigos data
K34_USERIS	C(12)	Kas koregavo
K34_ADDUSR	C(12)	Kas sukūrė
K34_R_DATE	T(8)	Kada koregavo
K34_ADD_DATE	T(8)	Kada sukūrė