EDIT_I14

Aprašymas

Perkainavimo detalios eilutės (akcijos) 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_I14
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:
- I14 - atitinkamos lentelės laukai (I14)

Pirmi 7 ApiKey simboliai (pvz USERABC.JQKPHGd7Pkjxl78ObsgdfEvpfEfvF1oL7h7UMOLo -> 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_K2> ... <KIEKIS_K4> ir <BAR_KODAS>, tuomet nereikia naudoti šių tagų: <I14_KODAS_PS>, <I14_KODAS_US>, <I14_KIEKIS2K> ... <I14_KIEKIS4K>, <I14_FRAKCIJA>

Jei naudojate du tagus <KIEKIS_N2> ... <KIEKIS_N4> ir <BAR_KODAS>, tuomet nereikia naudoti šių tagų: <I14_KODAS_PS>, <I14_KODAS_US>, <I14_KIEKIS2N> ... <I14_KIEKIS4N>, <I14_FRAKCIJA>

XML request

<body>
    <method>EDIT_I14</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <I14>
            <I14_KODAS_PK>010R00000001</I14_KODAS_PK>
            <I14_KODAS_PS>PREKE1</I14_KODAS_PS>
            <I14_KODAS_IS>01</I14_KODAS_IS>
            <I14_POZ_KAINA>1</I14_POZ_KAINA>
            <I14_KAINA1>1.1900</I14_KAINA1>
        </I14>    
    </data>
</body>

JSON request

{
    "method": "EDIT_I14",
    "params": {
        "oper": "I"
    },
    "data": {
        "I14": {
            "I14_KODAS_PK": "010R00000001",
            "I14_KODAS_PS": "PREKE1",
            "I14_KODAS_IS": "01",
            "I14_POZ_KAINA": 1,
            "I14_KAINA1": 1.1900
        }
    }
}

Response (status 200 OK)

XML response

<RET_DOK>
    <I14>
        <I14_KODAS_PK>010R00000001</I14_KODAS_PK>
        <I14_EIL_NR>1</I14_EIL_NR>
        <I14_KODAS_PS>PREKE1</I14_KODAS_PS>
        <I14_KODAS_US>VNT</I14_KODAS_US>
        <I14_KODAS_IS>01</I14_KODAS_IS>
        <I14_DATE_PR>2024-01-01T00:00:00</I14_DATE_PR>
        <I14_DATE_PB>2024-01-01T23:59:59</I14_DATE_PB>
        <I14_FRAKCIJA>1</I14_FRAKCIJA>
        <I14_POZ_KAINA>1</I14_POZ_KAINA>
        <I14_KAINA1>1.1900</I14_KAINA1>
        <I14_KIEKIS2K>0</I14_KIEKIS2K>
        <I14_KAINA2>0.0000</I14_KAINA2>
        <I14_KIEKIS3K>0</I14_KIEKIS3K>
        <I14_KAINA3>0.0000</I14_KAINA3>
        <I14_KIEKIS4K>0</I14_KIEKIS4K>
        <I14_KAINA4>0.0000</I14_KAINA4>
        <I14_POZ_NUOLAIDA>0</I14_POZ_NUOLAIDA>
        <I14_NUOLAIDA1>0.00</I14_NUOLAIDA1>
        <I14_KIEKIS2N>0</I14_KIEKIS2N>
        <I14_NUOLAIDA2>0.00</I14_NUOLAIDA2>
        <I14_KIEKIS3N>0</I14_KIEKIS3N>
        <I14_NUOLAIDA3>0.00</I14_NUOLAIDA3>
        <I14_KIEKIS4N>0</I14_KIEKIS4N>
        <I14_NUOLAIDA4>0.00</I14_NUOLAIDA4>
        <I14_PERKELTA>1</I14_PERKELTA>
        <I14_ADDUSR>WS</I14_ADDUSR>
        <I14_USERIS>WS</I14_USERIS>
        <I14_R_DATE>2024-01-01T00:00:01</I14_R_DATE>
    </I14>
</RET_DOK>

JSON response

{
    "I14": {
        "I14_KODAS_PK": "010R00000001",
        "I14_EIL_NR": 1,
        "I14_KODAS_PS": "PREKE1",
        "I14_KODAS_US": "VNT",
        "I14_KODAS_IS": "01",
        "I14_DATE_PR": "2024-01-01T00:00:00",
        "I14_DATE_PB": "2024-01-01T23:59:59",
        "I14_FRAKCIJA": 1,
        "I14_POZ_KAINA": 1,
        "I14_KAINA1": 1.19,
        "I14_KIEKIS2K": 0,
        "I14_KAINA2": 0,
        "I14_KIEKIS3K": 0,
        "I14_KAINA3": 0,
        "I14_KIEKIS4K": 0,
        "I14_KAINA4": 0,
        "I14_POZ_NUOLAIDA": 0,
        "I14_NUOLAIDA1": 0,
        "I14_KIEKIS2N": 0,
        "I14_NUOLAIDA2": 0,
        "I14_KIEKIS3N": 0,
        "I14_NUOLAIDA3": 0,
        "I14_KIEKIS4N": 0,
        "I14_NUOLAIDA4": 0,
        "I14_PERKELTA": 1,
        "I14_ADDUSR": "WS",
        "I14_USERIS": "WS",
        "I14_R_DATE": "2024-01-01T00:00:01"
    }
}

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>I14_KODAS_LS_1</tag>
                    <code>2043</code>
                    <message>Nėra tokio logistikos kodo kodo</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_I14</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <I14>
            <I14_KODAS_PK>010R00000001</I14_KODAS_PK>
            <I14_EIL_NR>1</I14_EIL_NR>
            <I14_KODAS_LS_1>LS1</I14_KODAS_LS_1>
        </I14>    
    </data>
</body>

pvz trynimas:

<body>
    <method>EDIT_I14</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <I14>
            <I14_KODAS_PK>010R00000001</I14_KODAS_PK>
            <I14_EIL_NR>1</I14_EIL_NR>
        </I14>    
    </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_I14",
    "params": {
        "oper": "I"
    },
    "data": {
        "I14": {
            "I14_KODAS_PK": "010R00000001",
            "I14_KODAS_PS": "PREKE1",
            "I14_KODAS_IS": "01",
            "I14_POZ_KAINA": 1,
            "I14_KAINA1": 1.1900
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I14

Perkainavimo detali informacija - akcijos

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
I14_KODAS_PK	C(12)	Operacijos numeris	Privalomas
I14_EIL_NR	N(6)	Eilės numeris	Privalomas , kai oper=U,D
I14_KODAS_PS	C(12)	Prekės kodas	Privalomas, kai oper=I
I14_KODAS_US	C(12)	Matavimo vienetas
I14_KODAS_IS	C(12)	Padalinys
I14_DATE_PR	T(8)	Pradžios data
I14_DATE_PB	T(8)	Pabaigos data
I14_FRAKCIJA	N(4)	Frakcija
I14_POZ_KAINA	N(1)	Kainos parinkimas: 0-ne; 1-taip
I14_KAINA1	N(12,4)	Kaina 1
I14_KIEKIS2K	N(14)	Kainos kiekis 2
I14_KAINA2	N(12,4)	Kaina 2
I14_KIEKIS3K	N(14)	Kainos kiekis 3
I14_KAINA3	N(12,4)	Kaina 3
I14_KIEKIS4K	N(14)	Kainos kiekis 4
I14_KAINA4	N(12,4)	Kaina 4
I14_POZ_NUOLAIDA	N(1)	Nuolaidos parinkimas: 0-ne; 1-taip
I14_NUOLAIDA1	N(6,2)	Nuolaida 1
I14_KIEKIS2N	N(14)	Nuolaidos kiekis 2
I14_NUOLAIDA2	N(6,2)	Nuolaida 2
I14_KIEKIS3N	N(14)	Nuolaidos kiekis 3
I14_NUOLAIDA3	N(6,2)	Nuolaida 3
I14_KIEKIS4N	N(14)	Nuolaidos kiekis 4
I14_NUOLAIDA4	N(6,2)	Nuolaida 4
I14_KODAS_LS_1	C(12)	Logistika 1
I14_KODAS_LS_2	C(12)	Logistika 2
I14_KODAS_LS_3	C(12)	Logistika 3
I14_KODAS_LS_4	C(12)	Logistika 4
I14_PERKELTA	N(1)	Perkėlimo požymis:1-neperkelta,2-perkelta
I14_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I14_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I14_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime
bar_kodas	C(25)	Barkodas
kiekis_k2	N(14,3)	Kaina 2 kiekis dešimtainėje išraiškoje
kiekis_k3	N(14,3)	Kaina 3 kiekis dešimtainėje išraiškoje
kiekis_k4	N(14,3)	Kaina 4 kiekis dešimtainėje išraiškoje
kiekis_n2	N(14,3)	Nuolaida 2 kiekis dešimtainėje išraiškoje
kiekis_n3	N(14,3)	Nuolaida 3 kiekis dešimtainėje išraiškoje
kiekis_n4	N(14,3)	Nuolaida 4 kiekis dešimtainėje išraiškoje