EDIT_I02

Aprašymas

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

Pirmi 7 ApiKey simboliai (pvz USERABC.JQKPGhd7Pkjxj37ObsgdfEvofEfvF1oL7h7UMOLo -> 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_I02</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <I02>
            <I02_KODAS_ZS>DK1</I02_KODAS_ZS>
            <I02_OP_APRAS>API test</I02_OP_APRAS>
        </I02>    
    </data>
</body>

JSON request

{
    "method": "EDIT_I02",
    "params": {
        "oper": "I"
    },
    "data": {
        "I02": {
            "I02_KODAS_ZS": "DK1",
            "I02_OP_APRAS": "API test"
        }
    }
}

Response (status 200 OK)

XML response

<RET_DOK>
    <I02>
        <I02_IMON_ID>01</I02_IMON_ID>
        <I02_KODAS_DH>010000000001</I02_KODAS_DH>
        <I02_KODAS_ZS>DK1</I02_KODAS_ZS>
        <I02_MODUL_NR></I02_MODUL_NR>
        <I02_DOK_NR>DOK000000001</I02_DOK_NR>
        <I02_OP_DATA>2024-01-01T00:00:00</I02_OP_DATA>
        <I02_OP_APRAS>API test</I02_OP_APRAS>
        <I02_GEN_POZ>0</I02_GEN_POZ>
        <I02_GEN_KARTAI>0</I02_GEN_KARTAI>
        <I02_GEN_DIEN>0</I02_GEN_DIEN>
        <I02_PERKELTA>1</I02_PERKELTA>
        <I02_ADDUSR>WS</I02_ADDUSR>
        <I02_USERIS>WS</I02_USERIS>
        <I02_R_DATE>2024-01-01T00:00:01</I02_R_DATE>
        <I02_KODAS_SM></I02_KODAS_SM>
    </I02>
</RET_DOK>

JSON response

{
    "I02": {
        "I02_IMON_ID": "01",
        "I02_KODAS_DH": "010000000001",
        "I02_KODAS_ZS": "DK1",
        "I02_MODUL_NR": "",
        "I02_DOK_NR": "DOK000000001",
        "I02_OP_DATA": "2024-01-01T00:00:00",
        "I02_OP_APRAS": "API test",
        "I02_GEN_POZ": 0,
        "I02_GEN_KARTAI": 0,
        "I02_GEN_DIEN": 0,
        "I02_PERKELTA": 1,
        "I02_ADDUSR": "WS",
        "I02_USERIS": "WS",
        "I02_R_DATE": "2024-01-01T00:00:01",
        "I02_KODAS_SM": ""
    }
}

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>I02_KODAS_ZS</tag>
                    <code>552173</code>
                    <message>Nerastas žurnalas</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_I02</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <I02>
            <I02_KODAS_ZS>DK1</I02_KODAS_ZS>
            <I02_KODAS_DH>010000000001</I02_KODAS_DH>
            <I02_OP_APRAS>API test - pataisyta</I02_OP_APRAS>
        </I02>    
    </data>
</body>

pvz trynimas:

<body>
    <method>EDIT_I02</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <I02>
            <I02_KODAS_ZS>DK1</I02_KODAS_ZS>
            <I02_KODAS_DH>010000000001</I02_KODAS_DH>
        </I02>
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: uUCz7UY.sKVrjaWRDJAH1c7l4qL222nn2K0jARkkkHDdYTss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "EDIT_I02",
    "params": {
        "oper": "I"
    },
    "data": {
        "I02": {
            "I02_KODAS_ZS": "DK1",
            "I02_OP_APRAS": "API test"
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I02

Didžiosios knygos antraštės lentelė

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
I02_IMON_ID	C(2)	Rezervas
I02_KODAS_DH	C(12)	DK operacijos numeris žurnale	Privalomas , kai oper=U,D,P
I02_KODAS_ZS	C(12)	DK žurnalo kodas	Privalomas
I02_MODUL_NR	C(12)	Analitinio modulio operacijos numeris
I02_DOK_NR	C(20)	Dokumento numeris
I02_OP_DATA	T(8)	Operacijos data
I02_OP_APRAS	C(40)	Operacijos aprašymas
I02_GEN_POZ	N(1)	Operacijos kopijavimo požymis:0-Ne,1-Taip
I02_GEN_KARTAI	N(4)	Operacijos kopijavimo kartai
I02_GEN_DIEN	N(3)	Dienų skaičius nurodantis generavimo intervalą
I02_PERKELTA	N(1)	Perkėlimo požymis:1-neperkelta,2-perkelta,3-koreguota
I02_ADDUSR	C(12)	Kas autorius	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I02_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I02_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime
I02_KODAS_SM	C(12)	Asmuo
I02_KODAS_LS_1	C(12)	Logistika 1
I02_KODAS_LS_2	C(12)	Logistika 2
I02_KODAS_LS_3	C(12)	Logistika 3
I02_KODAS_LS_4	C(12)	Logistika 4
I02_KODAS_ZN	C(12)	Zona
I02_APRASYMAS1	C(150)	Aprašymas 1
I02_APRASYMAS2	C(150)	Aprašymas 2
I02_APRASYMAS3	C(150)	Aprašymas 3