EDIT_I28

Aprašymas

Perkainavimo detalios eilutės (O/S 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_I28
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:
- I28 - atitinkamos lentelės laukai (I28)

Pirmi 7 ApiKey simboliai (pvz USERABC.JQKPGGd7Pkjxl78ObsgdfEvvfEfvF1oL7h7UMOLo -> 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ų: <I28_KODAS_PS>, <I28_KODAS_US>, <I28_KIEKIS>, <I28_FRAKCIJA>

Jegu dirbama su rinkinias, tuomet <I28_KODAS_OS> atitinka rinkinio kodą. Taip pat yra galimybė rinkinio kodą paduoti dalimis - tam naudojami tag'ai <K45_RIN01> ... <K45_RIN15>. Jeigu bus paduoti ir <I28_KODAS_OS> ir <K45_RIN01> ... <K45_RIN15> tag'ai, aukštesnį prioritetą turi <I28_KODAS_OS>. Rinkinio kodo iš anksto kurti nereikia, jis bus sukurtas automatiškai.

XML request

<body>
    <method>EDIT_I28</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <I28>
            <I28_KODAS_PK>010R00000001</I28_KODAS_PK>
            <I28_KODAS_PS>PREKE1</I28_KODAS_PS>
            <I28_SERIJA>SERIJA1</I28_SERIJA>
            <I28_KAINA_N>1.1900</I28_KAINA_N>
            <K45_RIN01>OBJ1</K45_RIN01>
        </I28>    
    </data>
</body>

JSON request

{
    "method": "EDIT_I28",
    "params": {
        "oper": "I"
    },
    "data": {
        "I28": {
            "I28_KODAS_PK": "010R00000001",
            "I28_KODAS_PS": "PREKE1",
            "I28_SERIJA": "SERIJA1",
            "I28_KAINA_N": 1.1900,
            "K45_RIN01": "OBJ1"
        }
    }
}

Response (status 200 OK)

XML response

<RET_DOK>
    <I28>
        <I28_KODAS_PK>010R00000001</I28_KODAS_PK>
        <I28_EIL_NR>1</I28_EIL_NR>
        <I28_KODAS_PS>PREKE1</I28_KODAS_PS>
        <I28_KODAS_US>VNT</I28_KODAS_US>
        <I28_KODAS_OS>010R00000001</I28_KODAS_OS>
        <I28_SERIJA>SERIJA1</I28_SERIJA>
        <I28_FRAKCIJA>1</I28_FRAKCIJA>
        <I28_KIEKIS>0</I28_KIEKIS>
        <I28_KAINA_S>0.0000</I28_KAINA_S>
        <I28_KAINA_N>1.1900</I28_KAINA_N>
        <I28_PERKELTA>1</I28_PERKELTA>
        <I28_USERIS>WS</I28_USERIS>
        <I28_R_DATE>2024-01-01T00:00:01</I28_R_DATE>
        <I28_ADDUSR>WS</I28_ADDUSR>
    </I28>
</RET_DOK>

JSON response

{
    "I28": {
        "I28_KODAS_PK": "010R00000001",
        "I28_EIL_NR": 1,
        "I28_KODAS_PS": "PREKE1",
        "I28_KODAS_US": "VNT",
        "I28_KODAS_OS": "010R00000001",
        "I28_SERIJA": "SERIJA1",
        "I28_FRAKCIJA": 1,
        "I28_KIEKIS": 0,
        "I28_KAINA_S": 0,
        "I28_KAINA_N": 1.19,
        "I28_PERKELTA": 1,
        "I28_USERIS": "WS",
        "I28_R_DATE": "2024-01-01T00:00:01",
        "I28_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>I28_EIL_NR</tag>
                    <code>20002</code>
                    <message>Tokia operacijos eilutė nerasta</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_I28</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <I28>
            <I28_KODAS_PK>010R00000001</I28_KODAS_PK>
            <I28_EIL_NR>1</I28_EIL_NR>
            <I28_KAINA_N>1.0900</I28_KAINA_N>
        </I28>    
    </data>
</body>

pvz trynimas:

<body>
    <method>EDIT_I28</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <I28>
            <I28_KODAS_PK>010R00000001</I28_KODAS_PK>
            <I28_EIL_NR>1</I28_EIL_NR>
        </I28> 
    </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_I28",
    "params": {
        "oper": "I"
    },
    "data": {
        "I28": {
            "I28_KODAS_PK": "010R00000001",
            "I28_KODAS_PS": "PREKE1",
            "I28_SERIJA": "SERIJA1",
            "I28_KAINA_N": 1.1900,
            "K45_RIN01": "OBJ1"
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I28

Perkainavimo detali informacija - O/S kainos

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
I28_KODAS_PK	C(12)	Operacijos numeris	Privalomas
I28_EIL_NR	N(6)	Eilės numeris	Privalomas , kai oper=U,D
I28_KODAS_PS	C(12)	Prekės kodas	Privalomas, kai oper=I
I28_KODAS_US	C(12)	Matavimo vienetas
I28_KODAS_OS	C(12)	Objektas/Rinkinio ID
I28_SERIJA	C(12)	Serija
I28_FRAKCIJA	N(4)	Frakcija
I28_KIEKIS	N(14)	Perkainuojamas Kiekis
I28_KAINA_S	N(12,4)	Sena kaina
I28_KAINA_N	N(12,4)	Nauja kaina
I28_PERKELTA	N(1)	Perkėlimo požymis:1-neperkelta,2-perkelta
I28_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I28_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I28_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
K45_RIN01, ... , K45_RIN15	C(12)	Rinkiniai