EDIT_N13

Aprašymas

Prekės akcijų įrašų 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_N13
params :
- oper :
  - I - naujo įrašo sukūrimas
  - U - įrašo koregavimas
  - D - įrašo ištrynimas
data: perduodami duomenys:
- N13 - atitinkamos lentelės laukai (N13)

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

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

pvz application/xml:

<body>
    <method>EDIT_N13</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N13>
            <N13_KODAS_PS>PREKE</N13_KODAS_PS>
            <N13_KODAS_US>VNT</N13_KODAS_US>
            <N13_KODAS_IS>PAD2</N13_KODAS_IS>
            <N13_KAINA1>100</N13_KAINA1>
        </N13>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N13",
    "params": {
        "oper": "I"
    },
    "data": {
        "N13": {
            "N13_KODAS_PS": "PREKE",
            "N13_KODAS_US": "VNT",
            "N13_KODAS_IS": "PAD2",
            "N13_KAINA1": 100
        }
    }
}

Response (status 200 OK)

Grąžinama informacija XML formate tarp tag'ų <RET_DOK>..</RET_DOK>.

pvz:

<?xml version='1.0'?>
<RET_DOK>
     <N13>
         <N13_KODAS_PS>477040522708</N13_KODAS_PS>
         <N13_KODAS_US>VNT </N13_KODAS_US>
         <N13_KODAS_IS>PAD1 </N13_KODAS_IS>
         <N13_EIL_NR>2</N13_EIL_NR>
         <N13_DATE_PR>2020-02-27 00:00:00.000</N13_DATE_PR>
         <N13_DATE_PB>2020-02-27 00:00:00.000</N13_DATE_PB>
         <N13_PAV>TEST1 </N13_PAV>
         <N13_POZ_KAINA>0</N13_POZ_KAINA>
         <N13_KAINA1>.0000</N13_KAINA1>
         <N13_KIEKIS2K>0</N13_KIEKIS2K>
         <N13_KAINA2>.0000</N13_KAINA2>
         <N13_KIEKIS3K>0</N13_KIEKIS3K>
         <N13_KAINA3>.0000</N13_KAINA3>
         <N13_KIEKIS4K>0</N13_KIEKIS4K>
         <N13_KAINA4>.0000</N13_KAINA4>
         <N13_POZ_NUOLAIDA>0</N13_POZ_NUOLAIDA>
         <N13_NUOLAIDA1>.00</N13_NUOLAIDA1>
         <N13_KIEKIS2N>0</N13_KIEKIS2N>
         <N13_NUOLAIDA2>.00</N13_NUOLAIDA2>
         <N13_KIEKIS3N>0</N13_KIEKIS3N>
         <N13_NUOLAIDA3>.00</N13_NUOLAIDA3>
         <N13_KIEKIS4N>0</N13_KIEKIS4N>
         <N13_NUOLAIDA4>.00</N13_NUOLAIDA4>
         <N13_KODAS_LS_1> </N13_KODAS_LS_1>
         <N13_KODAS_LS_2> </N13_KODAS_LS_2>
         <N13_KODAS_LS_3> </N13_KODAS_LS_3>
         <N13_KODAS_LS_4> </N13_KODAS_LS_4>
         <N13_ADDUSR>MASTER </N13_ADDUSR>
         <N13_USERIS>3 </N13_USERIS>
         <N13_R_DATE>2020-03-15 16:52:15.000</N13_R_DATE>
         <N13_REZERVAS> </N13_REZERVAS>
     </N13>
 </RET_DOK>

Response (status 400)

Klaida paduodant duomenis / SQL sintaksės klaidos / kitos DB klaidos

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id>14433105830.9def1bf4.1584217427751</id>
    <durationMs>45</durationMs>
    <errorMessage>nepavyko įvykdyti metodo</errorMessage>
    <errors>
        <error>
            <data>&lt;N13>&lt;/N13></data>
            <dataErrors>
                <dataError>
                    <tag>N13_KODAS_PS</tag>
                    <code>5001</code>
                    <message>Nenurodytas prekės kodas</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>2020-02-05T12:34:26.890+0000</timestamp>
    <status>500</status>
    <error>Internal Server Error</error>
    <message>No message available</message>
    <path>/v2</path>
</Map>

Koregavimas ir išmetimas

Koregavimas, išmetimas vyksta pagal lentelės raktą (Primary Key)

Koreguojant informaciją bus koreguojami tik perduodami laukai.

pvz koregavimas:

<body>
    <method>EDIT_N13</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N13>
            <N13_KODAS_PS>PREKE</N13_KODAS_PS>
            <N13_KODAS_US>VNT</N13_KODAS_US>
            <N13_KODAS_IS>PAD2</N13_KODAS_IS>
            <N13_EIL_NR>1</N13_EIL_NR>
            <N13_KAINA1>100</N13_KAINA1>
        </N13>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_N13</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N13>
            <N13_KODAS_PS>PREKE</N13_KODAS_PS>
            <N13_KODAS_US>VNT</N13_KODAS_US>
            <N13_KODAS_IS>PAD2</N13_KODAS_IS>
            <N13_EIL_NR>1</N13_EIL_NR>
        </N13>
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: uUCz6UD.sKVrjaWRDJAH1c7l4qL2nOoN2K0jARkvuHDdYsss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N13

Prekės akcijų informacijos lentelė.

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
N13_KODAS_PS	C(12)	Prekės kodas	Privalomas
N13_KODAS_US	C(12)	Mat.vnt.	Privalomas
N13_KODAS_IS	C(12)	Padalinys	Privalomas
N13_EIL_NR	N(6)	Eilutės nr.	Privalomas, kai oper=U,D
N13_DATE_PR	T(8)	Pradžios data
N13_DATE_PB	T(8)	Pabaigos data
N13_PAV	C(60)	Aprašymas
N13_POZ_KAINA	N(1)	Kainos parinkimas: 0-ne; 1-taip
N13_KAINA1	N(12,4)	Kaina1
N13_KIEKIS2K	N(14)	Kainos kiekis2
N13_KAINA2	N(12,4)	Kaina2
N13_KIEKIS3K	N(14)	Kainos kiekis3
N13_KAINA3	N(12,4)	Kaina3
N13_KIEKIS4K	N(14)	Kainos kiekis4
N13_KAINA4	N(12,4)	Kaina4
N13_POZ_NUOLAIDA	N(1)	Nuolaidos parinkimas: 0-ne; 1-taip.
N13_NUOLAIDA1	N(6,2)	Nuolaida1
N13_KIEKIS2N	N(14)	Nuolaidos kiekis2
N13_NUOLAIDA2	N(6,2)	Nuolaida2
N13_KIEKIS3N	N(14)	Nuolaidos kiekis3
N13_NUOLAIDA3	N(6,2)	Nuolaida3
N13_KIEKIS4N	N(14)	Nuolaidos kiekis4
N13_NUOLAIDA4	N(6,2)	Nuolaida4
N13_KODAS_LS_1	C(12)	Logistika 1
N13_KODAS_LS_2	C(12)	Logistika 2
N13_KODAS_LS_3	C(12)	Logistika 3
N13_KODAS_LS_4	C(12)	Logistika 4
N13_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai (oper=`I`), ApiKey - pirmi 7 simboliai
N13_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N13_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime
N13_REZERVAS	C(12)	Rezervas