EDIT_I01

Aprašymas

DK žurnalo 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_I01
params :
- oper :
  - I - naujo žurnalo sukūrimas (numatytasis)
  - U - žurnalo koregavimas
  - D - žurnalo ištrynimas
- user : vartotojo vardas (naudojamas dokumentų skaitliukams, parametrams ir kt.), veikia tik rakto prefix'ui įjungus parametrą RGI_USR_EDIT
data: perduodami duomenys:
- I01 - atitinkamos lentelės laukai (I01)

Pirmi 7 ApiKey simboliai (pvz USERABC.JQKPGdl7Pkjxj37ObsgdfEkvfEllF1oL7h7UMOLo -> 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_I01</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <I01>
            <I01_KODAS_ZS>DK1</I01_KODAS_ZS>
            <I01_PAV>API test</I01_PAV>
        </I01>
    </data>
</body>

JSON request

{
    "method": "EDIT_I01",
    "params": {
        "oper": "I"
    },
    "data": {
        "I01": {
            "I01_KODAS_ZS": "DK1",
            "I01_PAV": "API test"
        }
    }
}

Response (status 200 OK)

XML response

<RET_DOK>
    <I01>
        <I01_KODAS_ZS>DK1</I01_KODAS_ZS>
        <I01_PAV>API test</I01_PAV>
        <I01_EXP_IMP>0</I01_EXP_IMP>
        <I01_POZ>2</I01_POZ>
        <I01_POZ_DATE>0</I01_POZ_DATE>
        <I01_BEG_DATE>2024-01-01T00:00:00</I01_BEG_DATE>
        <I01_END_DATE>2024-01-01T00:00:00</I01_END_DATE>
        <I01_ADDUSR>WS</I01_ADDUSR>
        <I01_USERIS>WS</I01_USERIS>
        <I01_R_DATE>2024-01-01T00:00:01</I01_R_DATE>
        <I01_MODUL></I01_MODUL>
    </I01>
</RET_DOK>

JSON response

{
    "I01": {
        "I01_KODAS_ZS": "DK1",
        "I01_PAV": "API test",
        "I01_EXP_IMP": 0,
        "I01_POZ": 2,
        "I01_POZ_DATE": 0,
        "I01_BEG_DATE": "2024-01-01T00:00:00",
        "I01_END_DATE": "2024-01-01T00:00:00",
        "I01_ADDUSR": "WS",
        "I01_USERIS": "WS",
        "I01_R_DATE": "2024-01-01T00:00:01",
        "I01_MODUL": ""
    }
}

Response (status 400)

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

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>1</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data></data>
            <dataErrors>
                <dataError>
                    <tag>I01_KODAS_ZS</tag>
                    <code>552177</code>
                    <message>Toks žurnalas jau yra</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_I01</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <I01>
            <I01_KODAS_ZS>DK1</I01_KODAS_ZS>
            <I01_PAV>API test - papildyta</I01_PAV>
        </I01>
    </data>
</body>

pvz trynimas:

<body>
    <method>EDIT_I01</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <I01>
            <I01_KODAS_ZS>DK1</I01_KODAS_ZS>
        </I01>
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: uUCz6UY.sKVrjaWRDJAH1c7l4qL2nOok2K0jARkklHDdYsss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "EDIT_I01",
    "params": {
        "oper": "I"
    },
    "data": {
        "I01": {
            "I01_KODAS_ZS": "DK1",
            "I01_PAV": "API test"
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I01

DK žurnalų sąrašas

Laukas	Tipas	Aprašymas	Pastabos
I01_KODAS_ZS	C(12)	DK Žurnalo kodas	Privalomas
I01_PAV	C(40)	DK žurnalo pavadinimas
I01_EXP_IMP	N(1)	Rezervas
I01_POZ	N(1)	Požymis:1-sisteminis,2-nesisteminis
I01_POZ_DATE	N(1)	Terminuotas:0-Ne,1-Taip
I01_BEG_DATE	T(8)	Pradžios data
I01_END_DATE	T(8)	Pabaigos data
I01_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I01_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I01_R_DATE	T(8)	Koregavimo laikas	Neperduodamas. Pildomas automatiškai, Current Datetime
I01_MODUL	C(2)	Modulio Id.