EDIT_I34

Aprašymas

Perkainavimo detalios eilutės (kainynas) 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_I34
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:
- I34 - atitinkamos lentelės laukai (I34)

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

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

Jei naudojate du tagus <KIEKIS_U2> ... <KIEKIS_U4> ir <BAR_KODAS>, tuomet nereikia naudoti šių tagų: <I34_KODAS_PS>, <I34_KODAS_US>, <I34_KIEKIS2> ... <I34_KIEKIS4>, <I34_FRAKCIJA>

XML request

<body>
    <method>EDIT_I34</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <I34>
            <I34_KODAS_PK>010R00000001</I34_KODAS_PK>
            <I34_KODAS_PS>PREKE1</I34_KODAS_PS>
            <I34_TIPAS>A</I34_TIPAS>
            <I34_G_DATE>2024.01.01</I34_G_DATE>
            <I34_KAINA1>1.1900</I34_KAINA1>
        </I34>    
    </data>
</body>

JSON request

{
    "method": "EDIT_I34",
    "params": {
        "oper": "I"
    },
    "data": {
        "I34": {
            "I34_KODAS_PK": "010R00000001",
            "I34_KODAS_PS": "PREKE1",
            "I34_TIPAS": "A",
            "I34_G_DATE": "2024.01.01",
            "I34_KAINA1": 1.1900
        }
    }
}

Response (status 200 OK)

XML response

<RET_DOK>
    <I34>
        <I34_KODAS_PK>010R00000001</I34_KODAS_PK>
        <I34_EIL_NR>1</I34_EIL_NR>
        <I34_KODAS_PS>PREKE1</I34_KODAS_PS>
        <I34_KODAS_US>VNT</I34_KODAS_US>
        <I34_TIPAS>A</I34_TIPAS>
        <I34_G_DATE>2024-01-01T00:00:00</I34_G_DATE>
        <I34_FRAKCIJA>1</I34_FRAKCIJA>
        <I34_KAINA1>1.1900</I34_KAINA1>
        <I34_KAINA2>0.0000</I34_KAINA2>
        <I34_KIEKIS2>0</I34_KIEKIS2>
        <I34_KAINA3>0.0000</I34_KAINA3>
        <I34_KIEKIS3>0</I34_KIEKIS3>
        <I34_KAINA4>0.0000</I34_KAINA4>
        <I34_KIEKIS4>0</I34_KIEKIS4>
        <I34_PERKELTA>1</I34_PERKELTA>
        <I34_USERIS>WS</I34_USERIS>
        <I34_R_DATE>2024-01-01T00:00:01</I34_R_DATE>
        <I34_ADDUSR>WS</I34_ADDUSR>
    </I34>
</RET_DOK>

JSON response

{
    "I34": {
        "I34_KODAS_PK": "010R00000001",
        "I34_EIL_NR": 1,
        "I34_KODAS_PS": "PREKE1",
        "I34_KODAS_US": "VNT",
        "I34_TIPAS": "A",
        "I34_G_DATE": "2024-01-01T00:00:00",
        "I34_FRAKCIJA": 1,
        "I34_KAINA1": 1.19,
        "I34_KAINA2": 0,
        "I34_KIEKIS2": 0,
        "I34_KAINA3": 0,
        "I34_KIEKIS3": 0,
        "I34_KAINA4": 0,
        "I34_KIEKIS4": 0,
        "I34_PERKELTA": 1,
        "I34_USERIS": "WS",
        "I34_R_DATE": "2024-01-01T00:00:01",
        "I34_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>I34_KAINA2</tag>
                    <code>552180</code>
                    <message>Negalima nurodyti kainos kol nenurodytas kiekis</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_I34</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <I34>
            <I34_KODAS_PK>010R00000001</I34_KODAS_PK>
            <I34_EIL_NR>1</I34_EIL_NR>
            <I34_KAINA1>1.0900</I34_KAINA1>
        </I34>    
    </data>
</body>

pvz trynimas:

<body>
    <method>EDIT_I34</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <I34>
            <I34_KODAS_PK>010R00000001</I34_KODAS_PK>
            <I34_EIL_NR>1</I34_EIL_NR>
        </I34>    
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: uUCz7UY.sKVrjaWRDJAH1c7l4qL272ng2K0jARgkkHDdYTso',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "EDIT_I34",
    "params": {
        "oper": "I"
    },
    "data": {
        "I34": {
            "I34_KODAS_PK": "010R00000001",
            "I34_KODAS_PS": "PREKE1",
            "I34_TIPAS": "A",
            "I34_G_DATE": "2024.01.01",
            "I34_KAINA1": 1.1900
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I34

Perkainavimo detali informacija - kainynas

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
I34_KODAS_PK	C(12)	Operacijos numeris	Privalomas
I34_EIL_NR	N(6)	Eilės numeris	Privalomas , kai oper=U,D
I34_KODAS_PS	C(12)	Prekės kodas	Privalomas, kai oper=I
I34_KODAS_US	C(12)	Matavimo vienetas
I34_TIPAS	C(1)	Kainynas	Privalomas, kai oper=I
I34_G_DATE	T(8)	Galioja nuo
I34_FRAKCIJA	N(4)	Frakcija
I34_KAINA1	N(12,4)	Kaina 1
I34_KAINA2	N(12,4)	Kaina 2
I34_KIEKIS2	N(14)	Kiekis 2
I34_KAINA3	N(12,4)	Kaina 3
I34_KIEKIS3	N(14)	Kiekis 3
I34_KAINA4	N(12,4)	Kaina 4
I34_KIEKIS4	N(14)	Kiekis 4
I34_PERKELTA	N(1)	Perkėlimo požymis:1-neperkelta,2-perkelta
I34_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I34_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I34_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime
bar_kodas	C(25)	Barkodas
kiekis_u2	N(14,3)	Kaina 2 kiekis dešimtainėje išraiškoje
kiekis_u3	N(14,3)	Kaina 3 kiekis dešimtainėje išraiškoje
kiekis_u4	N(14,3)	Kaina 4 kiekis dešimtainėje išraiškoje