EDIT_K11

Aprašymas

Personalo klasifikatoriaus 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_K11
params :
- oper :
  - I - naujo įrašo sukūrimas
  - U - įrašo koregavimas
  - D - įrašo ištrynimas
data: perduodami duomenys:
- K11 - atitinkamos lentelės laukai (K11)

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_K11</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <K11>
            <K11_KODAS_1A>1A001</K11_KODAS_1A>
            <K11_PAV>Klasifikatoriaus pavadinimas 001</K11_PAV>
        </K11>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_K11",
    "params": {
        "oper": "I"
    },
    "data": {
        "K11": {
            "K11_KODAS_1A": "1A001",
            "K11_PAV": "Klasifikatoriaus pavadinimas 001"
        }
    }
}

Response (status 200 OK)

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

pvz:

<RET_DOK>
        <K11>
        <K11_KODAS_1A>1A001 </K11_KODAS_1A>
        <K11_TIPAS>1</K11_TIPAS>
        <K11_PAV>                                                           </K11_PAV>
        <K11_PASTABOS>memo</K11_PASTABOS>
        <K11_POZ_DATE>0</K11_POZ_DATE>
        <K11_BEG_DATE>2024-10-10T00:00:00</K11_BEG_DATE>
        <K11_END_DATE>2024-10-10T00:00:00</K11_END_DATE>
        <K11_USERIS>ABC     </K11_USERIS>
        <K11_ADDUSR>ABC     </K11_ADDUSR>
        <K11_R_DATE>2024-10-10T00:00:00</K11_R_DATE>
        <K11_ADD_DATE>2024-10-10T00:00:00</K11_ADD_DATE>
        <K11_KODAS_LG>           </K11_KODAS_LG>
        <K11_TB_KOR>0</K11_TB_KOR>
        <K11_KAL>1</K11_KAL>
        <K11_AT_RIBA>0</K11_AT_RIBA>
        <K11_DOK_TIPAS>1</K11_DOK_TIPAS>
        <K11_DOK_TIPAS_KOR>0</K11_DOK_TIPAS_KOR>
        <K11_AT_GR>1</K11_AT_GR>
        <k11_kor_poz>0</k11_kor_poz>
    </K11>
</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;K11>&lt;/K11></data>
            <dataErrors>
                <dataError>
                    <tag>K11_KODAS_1A</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_K11</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <K11>
            <K11_KODAS_1A>1A001</K11_KODAS_1A>
            <K11_PAV>Klasifikatoriaus pavadinimas koreguotas</K11_PAV>
        </K11>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_K11</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <K11>
            <K11_KODAS_1A>1A001</K11_KODAS_1A>
        </K11>
    </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_K11",
        "params": {
            "oper": "I"
        },
        "data": {
            "K11": {
                "K11_KODAS_1A": "1A001",
                "K11_PAV": "Menedzerio pavadinimas 001"
            }
    }
    }');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

K11

Personalo klasifikatoriaus informacija

Laukas	Tipas	Aprašymas
K11_KODAS_1A	char(12)	Klasifikatoriaus kodas
K11_TIPAS	numeric(3,0)	1 - Kategorijos, 2 - Personalo grupė, 3 - Darbo pobūdis, 4 - Pilietybė, 5 - Tautybė, 6 - Išsilavinimas, 7 - Mokslo laipsnis, 8 - Mokslo vardas, 9 - Lietuvių kalbos kvalifikacinė kategorija, 10 - Karinis laipsnis,11 - Karinė parengtis, 12 - Pareigybės, 13 - Prasižengimai, 14 - At
K11_PAV	char(60)	Pavadinimas
K11_APR	char(100)	Aprašymas
K11_PASTABOS	varchar(max)	Pastabos
K11_POZ_DATE	numeric(1,0)	Terminuota: 1 - Taip, 0 - Ne
K11_BEG_DATE	datetime	Pradžios data
K11_END_DATE	datetime	Pabaigos data
K11_USERIS	char(12)	Kas koregavo
K11_ADDUSR	char(12)	Kas sukūrė
K11_R_DATE	datetime	Kada koregavo
K11_ADD_DATE	datetime	Kada sukūrė
K11_KODAS_LG	char(12)	Tabelio diena
K11_TB_KOR	numeric(1,0)	Koreguoti tabelį: 0 - ne, 1 - taip
K11_KAL	numeric(1,0)	Atostogų veiksmas (0-nieko nedaryti,1-kalendorinės,2-gener. koreg.,3-gener. koreg., viršijus ribą)
K11_AT_RIBA	numeric(3,0)	Riba, kurią viršijus kal. metuose generuojamas koreguojantis
K11_DOK_TIPAS	numeric(2,0)	Dokumento tipas
K11_DOK_TIPAS_KOR	numeric(1,0)	Dok. tipo koregavimas
K11_AT_GR	numeric(1,0)	Atostogu grupe (koreguojanciu at. grupavimui, kai ˛žiūrima, ar viršyta metuose): 0-_,1-A,2-B,3-C,4-D,5-E,6-F,7-G,8-H
K11_KOR_POZ	numeric(1,0)	Koreguojantis periodas darbo dienomis: 1-Taip,0-Ne