EDIT_N32

Aprašymas

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

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_N32</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N32>
            <N32_KODAS_PS>00001 </N32_KODAS_PS>
            <N32_KODAS_US>KG </N32_KODAS_US>
            <N32_TIPAS>B</N32_TIPAS>
            <N32_G_DATE>2015-09-09</N32_G_DATE>
            <N32_KAINA1>0.0000</N32_KAINA1>
            <N32_KAINA2>0.0000</N32_KAINA2>
            <N32_KIEKIS2>0</N32_KIEKIS2>
            <N32_KAINA3>0.0000</N32_KAINA3>
            <N32_KIEKIS3>0</N32_KIEKIS3>
            <N32_KAINA4>0.0000</N32_KAINA4>
            <N32_KIEKIS4>0</N32_KIEKIS4>
            <N32_ID> </N32_ID>
        </N32>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N32",
    "params": {
        "oper": "I"
    },
    "data": {
          "N32": {
            "N32_KODAS_PS": "00001 ",
            "N32_KODAS_US": "KG ",
            "N32_TIPAS": "B",
            "N32_G_DATE": "2015-09-09",
            "N32_KAINA1": "0.0000",
            "N32_KAINA2": "0.0000",
            "N32_KIEKIS2": "0",
            "N32_KAINA3": "0.0000",
            "N32_KIEKIS3": "0",
            "N32_KAINA4": "0.0000",
            "N32_KIEKIS4": "0",
            "N32_ID": " "
          }
    }
}

Response (status 200 OK)

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

pvz:

<?xml version='1.0'?>
<RET_DOK>
    <N32>
        <N32_KODAS_PS>00001 </N32_KODAS_PS>
        <N32_KODAS_US>KG </N32_KODAS_US>
        <N32_TIPAS>B</N32_TIPAS>
        <N32_G_DATE>2015-09-09T00:00:00</N32_G_DATE>
        <N32_KAINA1>0.0000</N32_KAINA1>
        <N32_KAINA2>0.0000</N32_KAINA2>
        <N32_KIEKIS2>0</N32_KIEKIS2>
        <N32_KAINA3>0.0000</N32_KAINA3>
        <N32_KIEKIS3>0</N32_KIEKIS3>
        <N32_KAINA4>0.0000</N32_KAINA4>
        <N32_KIEKIS4>0</N32_KIEKIS4>
        <N32_USERIS>3 </N32_USERIS>
        <N32_R_DATE>2015-09-09T11:01:01</N32_R_DATE>
        <N32_ADDUSR>3 </N32_ADDUSR>
        <N32_ID> </N32_ID>
    </N32>
 </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;N32>&lt;/N32></data>
            <dataErrors>
                <dataError>
                    <tag>N32_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_N32</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N32>
            <N32_KODAS_PS>00001 </N32_KODAS_PS>
            <N32_KODAS_US>KG </N32_KODAS_US>
            <N32_TIPAS>B</N32_TIPAS>
            <N32_G_DATE>2015-09-09</N32_G_DATE>
            <N32_KAINA1>100.0000</N32_KAINA1>
        </N32>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_N32</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N32>
            <N32_KODAS_PS>00001 </N32_KODAS_PS>
            <N32_KODAS_US>KG </N32_KODAS_US>
            <N32_TIPAS>B</N32_TIPAS>
            <N32_G_DATE>2015-09-09</N32_G_DATE>
        </N32>
    </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

N32

Kainynai ABC lentelė.

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
N32_KODAS_PS	C(12)	Prekės/Paslaugos kodas	Privalomas
N32_KODAS_US	C(12)	Matavimo vieneto kodas	Privalomas
N32_TIPAS	C(1)	Nuolaidos tipas A,B,C,...J	Privalomas
N32_G_DATE	T(8)	Galioja nuo	Privalomas
N32_KAINA1	N(12,4)	Kaina 1
N32_KAINA2	N(12,4)	Kaina 2 priklausanti nuo kiekio 2
N32_KIEKIS2	N(14)	kiekis 2
N32_KAINA3	N(12,4)	Kaina 3 priklausanti nuo kiekio 3
N32_KIEKIS3	N(14)	Kiekis 3
N32_KAINA4	N(12,4)	Kaina 4 priklausanti nuo kiekio 4
N32_KIEKIS4	N(14)	Kiekis 4
N32_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N32_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime
N32_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N32_ID	C(2)	Įmonės Id.