EDIT_I21

Aprašymas

Perkainavimo detalios eilutės (pardavimo kaina) 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_I21
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:
- I21 - atitinkamos lentelės laukai (I21)

Pirmi 7 ApiKey simboliai (pvz USERABC.JQKPGGd7Pkjxj78ObsgdfEvvfEfvF1oL7h7UMOLo -> 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_U> ir <BAR_KODAS>, tuomet nereikia naudoti šių tagų: <I21_KODAS_PS>, <I21_KODAS_US>, <I21_KIEKIS>, <I21_FRAKCIJA>

XML request

<body>
    <method>EDIT_I21</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <I21>
            <I21_KODAS_PK>010R00000001</I21_KODAS_PK>
            <I21_KODAS_PS>PREKE1</I21_KODAS_PS>
            <I21_KAINA_N>1.1900</I21_KAINA_N>
        </I21>    
    </data>
</body>

JSON request

{
    "method": "EDIT_I21",
    "params": {
        "oper": "I"
    },
    "data": {
        "I21": {
            "I21_KODAS_PK": "010R00000001",
            "I21_KODAS_PS": "PREKE1",
            "I21_KAINA_N": 1.1900
        }
    }
}

Response (status 200 OK)

XML response

<RET_DOK>
    <I21>
        <I21_KODAS_PK>010R00000001</I21_KODAS_PK>
        <I21_EIL_NR>1</I21_EIL_NR>
        <I21_KODAS_PS>PREKE1</I21_KODAS_PS>
        <I21_KODAS_US>VNT</I21_KODAS_US>
        <I21_FRAKCIJA>1</I21_FRAKCIJA>
        <I21_KIEKIS>0</I21_KIEKIS>
        <I21_KAINA_S>0.0000</I21_KAINA_S>
        <I21_KAINA_N>1.1900</I21_KAINA_N>
        <I21_PERKELTA>1</I21_PERKELTA>
        <I21_USERIS>WS</I21_USERIS>
        <I21_ADDUSR>WS</I21_ADDUSR>
        <I21_R_DATE>2024-01-01T00:00:01</I21_R_DATE>
    </I21>
</RET_DOK>

JSON response

{
    "I21": {
        "I21_KODAS_PK": "010R00000001",
        "I21_EIL_NR": 1,
        "I21_KODAS_PS": "PREKE1",
        "I21_KODAS_US": "VNT",
        "I21_FRAKCIJA": 1,
        "I21_KIEKIS": 0,
        "I21_KAINA_S": 0,
        "I21_KAINA_N": 1.19,
        "I21_PERKELTA": 1,
        "I21_USERIS": "WS",
        "I21_ADDUSR": "WS",
        "I21_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>I21_KODAS_PS</tag>
                    <code>19014</code>
                    <message>Nerastas prekės/paslaugos kodas</message>
                </dataError>
                <dataError>
                    <tag>I21_KODAS_US</tag>
                    <code>5030</code>
                    <message>Nenurodytas matavimo vienetas</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_I21</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <I21>
            <I21_KODAS_PK>010R00000001</I21_KODAS_PK>
            <I21_EIL_NR>1</I21_EIL_NR>
            <I21_KODAS_PS>PREKE1</I21_KODAS_PS>
            <I21_KAINA_N>1.0900</I21_KAINA_N>
        </I21>    
    </data>
</body>

pvz trynimas:

<body>
    <method>EDIT_I21</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <I21>
            <I21_KODAS_PK>010R00000001</I21_KODAS_PK>
            <I21_EIL_NR>1</I21_EIL_NR>
        </I21> 
    </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_I21",
    "params": {
        "oper": "I"
    },
    "data": {
        "I21": {
            "I21_KODAS_PK": "010R00000001",
            "I21_KODAS_PS": "PREKE1",
            "I21_KAINA_N": 1.1900
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I21

Perkainavimo detali informacija - pardavimo kaina

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
I21_KODAS_PK	C(12)	Operacijos numeris	Privalomas
I21_EIL_NR	N(6)	Eilės numeris	Privalomas , kai oper=U,D
I21_KODAS_PS	C(12)	Prekės kodas	Privalomas, kai oper=I
I21_KODAS_US	C(12)	Matavimo vienetas
I21_FRAKCIJA	N(4)	Frakcija
I21_KIEKIS	N(14)	Perkainuojamas Kiekis
I21_KAINA_S	N(12,4)	Sena kaina
I21_KAINA_N	N(12,4)	Nauja kaina
I21_PERKELTA	N(1)	Perkėlimo požymis:1-neperkelta,2-perkelta
I21_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I21_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I21_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime
bar_kodas	C(25)	Barkodas
kiekis_u	N(14,3)	Kiekis dešimtainėje išraiškoje