EDIT_N37

Aprašymas

Koreguoti prekės/paslaugos matavimo vienetų 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_N37
params :
- oper :
  - I - naujo įrašo sukūrimas
  - U - įrašo koregavimas
  - D - įrašo ištrynimas
data: perduodami duomenys:
- N37 - atitinkamos lentelės laukai (N37)

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.

Alternatyvaus matavimo vieneto frakcija negali būti didesnė už pagrindinio matavimo vieneto frakciją. Šį ribojimą galima išjungti tag'u PAGR_ALT_FRAK.

pvz application/xml:

<body>
    <method>EDIT_N37</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N37>
            <N37_KODAS_PS>001</N37_KODAS_PS>
            <N37_KODAS_US>VNT001</N37_KODAS_US>
            <N37_KOEFICI>3</N37_KOEFICI>
        </N37>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N37",
    "params": {
        "oper": "I"
    },
    "data": {
          "N37": {
            "N37_KODAS_PS": "001",
            "N37_KODAS_US": "VNT001",
            "N37_KOEFICI": "3"
          }
    }
}

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>
<N37>
        <N37_KODAS_PS>0000000001 </N37_KODAS_PS>
        <N37_KODAS_US>VNT </N37_KODAS_US>
        <N37_BAR_KODAS>000000005555</N37_BAR_KODAS>
        <N37_TRUM_PAV> </N37_TRUM_PAV>
        <N37_PAV>HGR15R_C </N37_PAV>
        <N37_KASOS_POZ>1</N37_KASOS_POZ>
        <N37_SVARST_POZ>0</N37_SVARST_POZ>
        <N37_SK_SVARST> </N37_SK_SVARST>
        <N37_TAROS_GR> </N37_TAROS_GR>
        <N37_TAROS_SVORIS>0</N37_TAROS_SVORIS>
        <N37_FRAKCIJA_A>1</N37_FRAKCIJA_A>
        <N37_FRAKCIJA>1</N37_FRAKCIJA>
        <N37_KOEFICI>1000</N37_KOEFICI>
        <N37_NETTO>5.800</N37_NETTO>
        <N37_BRUTTO>5.800</N37_BRUTTO>
        <N37_TURIS>0.0000000000</N37_TURIS>
        <N37_ILGIS>4.000</N37_ILGIS>
        <N37_PLOTIS>15.000</N37_PLOTIS>
        <N37_AUKSTIS>15.000</N37_AUKSTIS>
        <N37_R_DATE>2018-12-21T09:46:32</N37_R_DATE>
        <N37_ADDUSR>3 </N37_ADDUSR>
        <N37_USERIS>MASTER </N37_USERIS>
        <N37_LAIKAS_KROV>0</N37_LAIKAS_KROV>
        <N37_ORIENTACIJA>0</N37_ORIENTACIJA>
        <N37_AR_VIRS>0</N37_AR_VIRS>
        <N37_VIRS_SVOR>0.000</N37_VIRS_SVOR>
        <N37_VIRS_PAK>0.000</N37_VIRS_PAK>
        <N37_KODAS_US_PAK>VNT </N37_KODAS_US_PAK>
        <N37_KIEKIS_PAK>1</N37_KIEKIS_PAK>
        <N37_PAK_TIPAS>1</N37_PAK_TIPAS>
        <N37_PAK_MASE>0.000</N37_PAK_MASE>
        <N37_KODAS_LS_1> </N37_KODAS_LS_1>
        <N37_KODAS_LS_2> </N37_KODAS_LS_2>
        <N37_REZERVAS> </N37_REZERVAS>
        <N37_RUSIS>10 </N37_RUSIS>
        <N37_MATAS>CTM</N37_MATAS>
        <N37_SALIS_K>CY </N37_SALIS_K>
        <N37_VAISTO_ID> </N37_VAISTO_ID>
    </N37>
  </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;N37>&lt;/N37></data>
            <dataErrors>
                <dataError>
                    <tag>N37_KODAS_US</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_N37</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N37>
            <N37_KODAS_PS>001</N37_KODAS_PS>
            <N37_KODAS_US>VNT001</N37_KODAS_US>
            <N37_KOEFICI>3</N37_KOEFICI>
        </N37>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_N37</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N37>
            <N37_KODAS_PS>001</N37_KODAS_PS>
            <N37_KODAS_US>VNT001</N37_KODAS_US>
        </N37>
    </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

N37

Papildomos prekės/paslaugos matavimo vienetų lentelė.

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
N37_KODAS_PS	C(12)	Prekės kodas	Privalomas
N37_KODAS_US	C(12)	Matavimo kodas	Privalomas
N37_BAR_KODAS	C(12)	Prekės Bar kodas
N37_TRUM_PAV	C(16)	Trumpas prekės pav. siunčiant į kasas
N37_PAV	C(120)	Ilgas prekės pavadinimas
N37_KASOS_POZ	N(1)	Svėrimo požumis:0-ne,1-taip
N37_SVARST_POZ	N(1)	Siųsti į svarstykles:0-ne,1-taip
N37_SK_SVARST	C(4)	Svarstyklių skyrius
N37_TAROS_GR	C(4)	Taros grupė
N37_TAROS_SVORIS	N(12)	Taros svoris
N37_FRAKCIJA_A	N(4)	Altenatyvaus matavimo frakcija
N37_FRAKCIJA	N(4)	Pagrindinio matavimo frakcija
N37_KOEFICI	N(14)	Santykis su pagrindiniu matu
N37_NETTO	N(14,3)	Prekės vieneto neto
N37_BRUTTO	N(14,3)	Prekės vieneto bruto
N37_TURIS	N(18,10)	Prekės vieneto tūris
N37_ILGIS	N(14,3)	Prekės ilgis
N37_PLOTIS	N(14,3)	Prekės plotis
N37_AUKSTIS	N(14,3)	Prekės aukštis
N37_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime
N37_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N37_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N37_LAIKAS_KROV	N(10)	Krovimo darbų laikas
N37_ORIENTACIJA	N(1)	Prekės orientacija
N37_AR_VIRS	N(1)	Ar transportuojant prekė dedasi ant viršaus
N37_VIRS_SVOR	N(14,3)	Koks svoris galimas ant viršaus
N37_VIRS_PAK	N(14,3)	Kiek pakuočių galima dėti vieną ant kitos
N37_KODAS_US_PAK	C(12)	Standartinis mat.vienetas
N37_KIEKIS_PAK	N(14)	Santykis su alternatyviu matu
N37_PAK_TIPAS	N(2)	Pakuotės tipas
N37_PAK_MASE	N(14,3)	Pakuotės masė
N37_KODAS_LS_1	C(12)	Logistikos kodas 1
N37_KODAS_LS_2	C(12)	Logistikos kodas 2
N37_REZERVAS	C(40)	Rezervas
N37_APSKRITIS	C(3)	Apskritis
N37_SANDORIS	C(3)	Sandoris
N37_SALYGOS	C(3)	Pristatymo sąlygos
N37_RUSIS	C(3)	Rūšis
N37_SALIS	C(3)	Šalis gavėja
N37_MATAS	C(3)	Mato vnt.
N37_SALIS_K	C(3)	Kilmės šalis
N37_VAISTO_ID	C(12)	Vaisto Id.
PAGR_ALT_FRAK	N(1)	Leisti alternatyvią frakciją didesnę už pagrindinę	Pagal nutylėjimą neleidžiama, 1 - leisti