EDIT_I52

Aprašymas

Kaupiklio detalios eilutės 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_I52
params :
- oper :
  - I - naujo įrašo sukūrimas (numatytasis)
  - U - įrašo koregavimas
  - 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:
- I52 - atitinkamos lentelės laukai (I52)

Pirmi 7 ApiKey simboliai (pvz USERABC.JQKPGGd7Pkjxj28ObsgdfEvvfEfvF1oL7h7UMOLo -> 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_I52</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <I52>
            <I52_KODAS_KP>010R00000001</I52_KODAS_KP>
            <I52_BAR_KODAS>000000000123</I52_BAR_KODAS>
        </I52>    
    </data>
</body>

JSON request

{
    "method": "EDIT_I52",
    "params": {
        "oper": "I"
    },
    "data": {
        "I52": {
            "I52_KODAS_KP": "010R00000001",
            "I52_BAR_KODAS": "000000000123"
        }
    }
}

Response (status 200 OK)

XML response

<RET_DOK>
    <I52>
        <I52_KODAS_KP>010R00000001</I52_KODAS_KP>
        <I52_EIL_NR>1</I52_EIL_NR>
        <I52_BAR_KODAS>000000000123</I52_BAR_KODAS>
        <I52_KIEKIS>0.0000</I52_KIEKIS>
        <I52_KAINA>0.0000</I52_KAINA>
        <I52_PAV></I52_PAV>
        <I52_PERKELTA>1</I52_PERKELTA>
        <I52_USERIS>WS</I52_USERIS>
        <I52_R_DATE>2024-01-01T00:00:01</I52_R_DATE>
        <I52_ADDUSR>WS</I52_ADDUSR>
    </I52>
</RET_DOK>

JSON response

{
    "I52": {
        "I52_KODAS_KP": "010R00000001",
        "I52_EIL_NR": 1,
        "I52_BAR_KODAS": "000000000123",
        "I52_KIEKIS": 0,
        "I52_KAINA": 0,
        "I52_PAV": "",
        "I52_PERKELTA": 1,
        "I52_USERIS": "WS",
        "I52_R_DATE": "2024-01-01T00:00:01",
        "I52_ADDUSR": "WS"
    }
}

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>I52_BAR_KODAS</tag>
                    <code>6026</code>
                    <message>Bar 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>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_I52</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <I52>
            <I52_KODAS_KP>010R00000001</I52_KODAS_KP>
            <I52_EIL_NR>1</I52_EIL_NR>
            <I52_PAV>koreguota</I52_PAV>
            <I52_KAINA>1.0900</I52_KAINA>
        </I52>    
    </data>
</body>

pvz trynimas:

<body>
    <method>EDIT_I52</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <I52>
            <I52_KODAS_KP>010R00000001</I52_KODAS_KP>
            <I52_EIL_NR>1</I52_EIL_NR>
        </I52> 
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: uUCz7UY.sKVrjaWRDJAH1c7l4qL272ng2K0jARkkkHDdYTss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "EDIT_I52",
    "params": {
        "oper": "I"
    },
    "data": {
        "I52": {
            "I52_KODAS_KP": "010R00000001",
            "I52_BAR_KODAS": "000000000123"
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I52

Kaupiklio detali informacija

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
I52_KODAS_KP	C(12)	Kaupiklio operacija	Privalomas
I52_EIL_NR	N(6)	Eilutės numeris operacijoje	Privalomas , kai oper=U,D
I52_BAR_KODAS	C(12)	Bar kodas	Privalomas, kai oper=I
I52_KIEKIS	N(12,4)	Kiekis
I52_KAINA	N(12,4)	Kaina
I52_PAV	C(40)	Aprašymas
I52_PERKELTA	N(1)	Ar eilutė perkelta
I52_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I52_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I52_R_DATE	T(8)	Koregavimo data	Neperduodamas. Pildomas automatiškai, Current Datetime