EDIT_K42

Aprašymas

DVS operacijos 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_K42
params :
- oper :
  - I - naujo įrašo sukūrimas (numatytasis)
  - U - įrašo koregavimas
  - P - įrašo perkėlimas
  - D - įrašo ištrynimas
- user : vartotojo vardas (naudojamas dokumentų skaitliukams, parametrams ir kt.), veikia tik rakto prefix'ui įjungus parametrą RGI_USR_EDIT
data: perduodami duomenys:
- K42 - atitinkamos lentelės laukai (k42)

Pirmi 7 ApiKey simboliai (pvz USERABC.JQKPGHd7PPjxj37ObsgdfEvoEEfvF1oL7h7UMOLo -> USERABC) yra vartotojo vardas Rivile GAMA programoje, kuriuo bus kuriami ar koreguojami įrašai.

Vienu metu veiksmai atliekami tik su vienu įrašu.

XML request

<body>
    <method>EDIT_K42</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <K42>
            <K42_KODAS_RD>SS_SU01</K42_KODAS_RD>
            <K42_KODAS_KS>121411842</K42_KODAS_KS>
        </K42>    
    </data>
</body>

JSON request

{
    "method": "EDIT_K42",
    "params": {
        "oper": "I"
    },
    "data": {
        "K42": {
            "K42_KODAS_RD": "SS_SU01",
            "K42_KODAS_KS": "121411842"
        }
    }
}

Response (status 200 OK)

XML response

<RET_DOK>
    <K42>
        <K42_KODAS_OD>010R00000001</K42_KODAS_OD>
        <K42_TEVAS></K42_TEVAS>
        <K42_PAV></K42_PAV>
        <K42_TIPAS>3</K42_TIPAS>
        <K42_LYGIS>0</K42_LYGIS>
        <K42_KODAS_RD>SS_SU01</K42_KODAS_RD>
        <K42_OP_DATA>2024-01-01T00:00:00</K42_OP_DATA>
        <K42_KODAS_KS>121411842</K42_KODAS_KS>
        ...
    </K42>
</RET_DOK>

JSON response

{
    "K42": {
        "K42_KODAS_OD": "010R00000001",
        "K42_TEVAS": "",
        "K42_PAV": "",
        "K42_TIPAS": 3,
        "K42_LYGIS": 0,
        "K42_KODAS_RD": "SS_SU01",
        "K42_OP_DATA": "2024-01-01T00:00:00",
        "K42_KODAS_KS": 121411842,
        ...
    }
}

Response (status 400)

Klaida paduodant duomenis / SQL sintaksės klaidos / kitos duomenų klaidos

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>>
    <durationMs>0</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data></data>
            <dataErrors>
                <dataError>
                    <tag>K42_KODAS_KS</tag>
                    <code>2001</code>
                    <message>Nėra tokio kliento</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>2024-01-01T00:00:01.001+0000</timestamp>
    <status>500</status>
    <error>Internal Server Error</error>
    <message>No message available</message>
    <path>/v2</path>
</Map>

Koregavimas, trynimas ir perkėlimas

Koregavimas, trynimas ir perkėlimas vyksta pagal atitinkamos lentelės raktą (Primary Key)

Koreguojant informaciją bus koreguojami tik perduodami laukai.

pvz koregavimas:

<body>
    <method>EDIT_K42</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <K42>
            <K42_KODAS_OD>010R00000001</K42_KODAS_OD>
            <K42_PAV>Koreguota</K42_PAV>
        </K42>    
    </data>
</body>

pvz trynimas:

<body>
    <method>EDIT_K42</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <K42>
            <K42_KODAS_OD>010R00000001</K42_KODAS_OD>
        </K42>
    </data>
</body>

pvz perkėlimas:

<body>
    <method>EDIT_K42</method>
    <params>
        <oper>P</oper>
    </params>
    <data>
        <K42>
            <K42_KODAS_OD>010R00000001</K42_KODAS_OD>
        </K42>
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: uUCz7UY.sKVrjaWRDJAH1c7l4qL322nn2K0jARkkkHDdYTss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "EDIT_K42",
    "params": {
        "oper": "I"
    },
    "data": {
        "K42": {
            "K42_KODAS_RD": "SS_SU01",
            "K42_KODAS_KS": "121411842"
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

K42

DVS operacijų antraštės lentelė

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
K42_KODAS_OD	C(12)	Operacijos Numeris	Privalomas , kai oper=U,D,P
K42_TEVAS	C(12)	Tėvinės operacijos Nr.
K42_PAV	C(150)	Pavadinimas
K42_TIPAS	N(3)	Tipas
K42_LYGIS	N(4)	Lygis
K42_KODAS_RD	C(12)	DVS rūšis	Privalomas, kaip oper=I
K42_OP_DATA	T(8)	Operacijos data
K42_DOK_DATA	T(8)	Dokumento data
K42_ARCH_DATA	T(8)	Archyvavimo data
K42_DOK_NR	C(20)	Dokumento Nr.
K42_DOK_REG	C(20)	Registro Nr.
K42_ARCH_NR	C(20)	Archyvo Nr.
K42_BUKLE	N(1)	Būklė: 1-aktyvus; 2-archyvuotas; 3-anuliuotas
K42_APRASYMAS1	C(150)	Aprašymas 1
K42_APRASYMAS2	C(150)	Aprašymas 2
K42_APRASYMAS3	C(150)	Aprašymas 3
K42_APRASYMAS4	C(150)	Aprašymas 4
K42_KODAS_LS_1	C(12)	Logistika 1
K42_KODAS_LS_2	C(12)	Logistika 2
K42_KODAS_LS_3	C(12)	Logistika 3
K42_KODAS_LS_4	C(12)	Logistika 4
K42_KODAS_IS	C(12)	Padalinys
K42_KODAS_MS	C(12)	Menedžeris
K42_KODAS_KS	C(12)	Klientas
K42_KODAS_TB	C(12)	Tabelinis Nr.
K42_KODAS_4A	C(12)	Personalo kodas
K42_BUSENA	N(3)	Būsena
K42_PASTABOS	M(4)	Pastabos
K42_PERKELTA	N(1)	Perkelta
K42_POZ_DATE	N(1)	Terminuota: 0-ne; 1-taip
K42_BEG_DATE	T(8)	Periodo pradzia
K42_END_DATE	T(8)	Periodo pabaiga
K42_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
K42_ADD_DATE	T(8)	Kada sukūrė	Neperduodamas. Pildomas automatiškai, Current Datetime
K42_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
K42_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime
K42_KODAS_RS	C(12)	Vartotojo kodas
K42_GALIOJA_IKI	T(8)	Galioja iki
K42_KODAS_OS	C(12)	Objekto kodas