EDIT_N40

Aprašymas

Koreguoti prekės/paslaugos alternatyvaus barkodo informaciją

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

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_N40</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N40>
            <N40_KODAS_PS>001</N40_KODAS_PS>
            <N40_KODAS_US>VNT</N40_KODAS_US>
            <N40_BAR_KODAS>12345678901</N40_BAR_KODAS>
        </N40>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N40",
    "params": {
        "oper": "I"
    },
    "data": {
          "N40": {
            "N40_KODAS_PS": "001",
            "N40_KODAS_US": "VNT",
            "N40_BAR_KODAS": "12345678901"
          }
    }
}
Response (status 200 OK)

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

pvz:

<?xml version="1.0" encoding="UTF-8" ?>
<RET_DOK>
    <N40>
         <N40_BAR_KODAS>12345678901 </N40_BAR_KODAS>
         <N40_KODAS_PS>001 </N40_KODAS_PS>
         <N40_KODAS_US>VNT </N40_KODAS_US>
         <N40_USERIS>3 </N40_USERIS>
         <N40_R_DATE>2019-11-04 13:51:44.000</N40_R_DATE>
         <N40_ADDUSR>3 </N40_ADDUSR>
         <n40_eksp_poz>0</n40_eksp_poz>
         <n40_eksp_tag>0</n40_eksp_tag>
     </N40>
 </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;N40>&lt;/N40></data>
            <dataErrors>
                <dataError>
                    <tag>N40_BAR_KODAS</tag>
                    <code>6010</code>
                    <message>Egzistuoja toks 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_N40</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N40>
             <N40_BAR_KODAS>12345678901 </N40_BAR_KODAS>
             <N40_KODAS_PS>001 </N40_KODAS_PS>
             <N40_KODAS_US>VNT </N40_KODAS_US>
         </N40>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_N40</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N40>
             <N40_BAR_KODAS>12345678901 </N40_BAR_KODAS>
         </N40>
    </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

N40

Prekės/paslaugos alternatyvaus barkodo lentelė.

Laukas Tipas Aprašymas Pastabos naudojant EDIT metodus
N40_BAR_KODAS C(40) Bar kodas Privalomas
N40_KODAS_PS C(12) Prekės kodas Privalomas, kai oper=I
N40_KODAS_US C(12) Matavimo vienetas Privalomas, kai oper=I
N40_USERIS C(12) Kas koregavo Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N40_R_DATE T(8) Kada koreguotas Neperduodamas. Pildomas automatiškai, Current Datetime
N40_ADDUSR C(12) Kas sukūrė Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N40_EKSP_POZ N(1) Eksporto požymis
N40_EKSP_TAG N(3) Eksporto TAG-as