EDIT_N17

Aprašymas

Prekių, paslaugų sukūrimas, koregavimas, trynimas

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_N17
params :
- oper :
  - I - naujo prekės sukūrimas
  - U - prekės koregavimas
  - D - prekės ištrynimas
data: perduodami duomenys:
- N17 - Prekės, paslaugos informacija (N17)

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_N17</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N17>
            <N17_KODAS_PS>PASLX</N17_KODAS_PS>
            <N17_TIPAS>2</N17_TIPAS>
            <N17_PAV>Paslauga X</N17_PAV>
            <N17_KODAS_DS>PR001</N17_KODAS_DS>
            <N17_KODAS_US>VNT</N17_KODAS_US>
        </N17>   
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N17",
    "params": {
        "oper": "I"
    },
    "data": {
        "N17": {
            "N17_KODAS_PS": "PASLX",
            "N17_TIPAS": "2",
            "N17_PAV": "Paslauga X",
            "N17_KODAS_DS": "PR001",
            "N17_KODAS_US": "VNT"
        }
    }
}

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>
    <N17>
        <N17_KODAS_PS>PASLX</N17_KODAS_PS>
        <N17_TIPAS>2</N17_TIPAS>
        <N17_KODAS_P1></N17_KODAS_P1>
        <N17_KODAS_P2></N17_KODAS_P2>
        <N17_KODAS_US>VNT</N17_KODAS_US>
        <N17_PAV>Paslauga X</N17_PAV>
        <N17_PAVU></N17_PAVU>
        <N17_KODAS_KS></N17_KODAS_KS>
        <N17_KOD_T></N17_KOD_T>
        <N17_KODAS_KS1></N17_KODAS_KS1>
        <N17_KOD_T1></N17_KOD_T1>
        <N17_KODAS_KS2></N17_KODAS_KS2>
        <N17_KOD_T2></N17_KOD_T2>
        <N17_KODAS_VS></N17_KODAS_VS>
        <N17_KODAS_ES></N17_KODAS_ES>
        <N17_UZSIGUL>0.00</N17_UZSIGUL>
        <N17_BAZ_KIEKIS>0</N17_BAZ_KIEKIS>
        <N17_ASSEMBLY>1</N17_ASSEMBLY>
        <N17_KODAS_LS_1></N17_KODAS_LS_1>
        <N17_KODAS_LS_2></N17_KODAS_LS_2>
        <N17_KODAS_LS_3></N17_KODAS_LS_3>
        <N17_KODAS_LS_4></N17_KODAS_LS_4>
        <N17_KODAS_DS>PR001</N17_KODAS_DS>
        <N17_NUOL_GR></N17_NUOL_GR>
        <N17_GALIOJA>0</N17_GALIOJA>
        <N17_MOKESTIS>0</N17_MOKESTIS>
        <N17_TAX>0</N17_TAX>
        <N17_KODAS_KS_G></N17_KODAS_KS_G>
        <N17_KODAS_GS></N17_KODAS_GS>
        <N17_INSTR_POZ>0</N17_INSTR_POZ>
        <N17_INSTR_TIP></N17_INSTR_TIP>
        <N17_INSTR_VYK>0</N17_INSTR_VYK>
        <N17_INSTR_DATE>2020-02-29T00:00:00</N17_INSTR_DATE>
        <N17_INSTR_FILE></N17_INSTR_FILE>
        <N17_URM_POZ>0</N17_URM_POZ>
        <N17_URM_DATEIN>2020-02-29T00:00:00</N17_URM_DATEIN>
        <N17_URM_DATEOU>2020-02-29T00:00:00</N17_URM_DATEOU>
        <N17_KREPS_POZ>0</N17_KREPS_POZ>
        <N17_KREPS_KTG></N17_KREPS_KTG>
        <N17_KREPS_MIN>0</N17_KREPS_MIN>
        <N17_GARANT_POZ>0</N17_GARANT_POZ>
        <N17_GARANT_MEN>0</N17_GARANT_MEN>
        <N17_KODAS_KS3></N17_KODAS_KS3>
        <N17_TEMPER_POZ>0</N17_TEMPER_POZ>
        <N17_TEMPER_MAX>0</N17_TEMPER_MAX>
        <N17_TEMPER_MIN>0</N17_TEMPER_MIN>
        <N17_TEMPER_TXT></N17_TEMPER_TXT>
        <N17_SERTIF_POZ>0</N17_SERTIF_POZ>
        <N17_KODAS_MS></N17_KODAS_MS>
        <N17_ANTKAINIS>0.00</N17_ANTKAINIS>
        <N17_MAX_NUOL>0.00</N17_MAX_NUOL>
        <N17_EX_IM_FRAC>0</N17_EX_IM_FRAC>
        <N17_G_TIME>0</N17_G_TIME>
        <N17_KODAS_OS></N17_KODAS_OS>
        <N17_VAZ_LAIK>0</N17_VAZ_LAIK>
        <N17_UZS_LAIK>0</N17_UZS_LAIK>
        <N17_PAP_LAIK>0</N17_PAP_LAIK>
        <N17_SAN_COST>0.00</N17_SAN_COST>
        <N17_UZS_COST>0.00</N17_UZS_COST>
        <N17_TRA_COST>0.00</N17_TRA_COST>
        <N17_MEN_PAV></N17_MEN_PAV>
        <N17_MUIT_KOD></N17_MUIT_KOD>
        <N17_SK_KODAS>0</N17_SK_KODAS>
        <N17_INTERNET>0</N17_INTERNET>
        <N17_DUM_POZ>0</N17_DUM_POZ>
        <N17_DUM_TIP></N17_DUM_TIP>
        <N17_DUM_D_IN>2020-02-29T00:00:00</N17_DUM_D_IN>
        <N17_DUM_D_OUT>2020-02-29T00:00:00</N17_DUM_D_OUT>
        <N17_MUITO_PROC>0.00</N17_MUITO_PROC>
        <N17_AKCIZO_PROC>0.00</N17_AKCIZO_PROC>
        <N17_PASTABOS></N17_PASTABOS>
        <N17_POZ_DATE>0</N17_POZ_DATE>
        <N17_BEG_DATE>2020-02-29T00:00:00</N17_BEG_DATE>
        <N17_END_DATE>2020-02-29T00:00:00</N17_END_DATE>
        <N17_USERIS>B1NOONQ</N17_USERIS>
        <N17_R_DATE>2020-02-29T22:15:30</N17_R_DATE>
        <N17_ADD_DATE>2020-02-29T22:15:30</N17_ADD_DATE>
        <N17_ADDUSR>B1NOONQ</N17_ADDUSR>
        <N17_MIN_VISO>0</N17_MIN_VISO>
        <N17_SERT_POZ></N17_SERT_POZ>
        <N17_KAT_POZ></N17_KAT_POZ>
        <N17_BROK_POZ>0</N17_BROK_POZ>
        <N17_KODAS_PS_G></N17_KODAS_PS_G>
        <N17_DATA_BR>2020-02-29T00:00:00</N17_DATA_BR>
        <N17_KODAS_VS_T></N17_KODAS_VS_T>
        <N17_KODAS_MS_A></N17_KODAS_MS_A>
        <N17_KODAS_MS_M></N17_KODAS_MS_M>
        <N17_AR_NAUJA>0</N17_AR_NAUJA>
        <N17_DATA_NAUJA>2020-02-29T00:00:00</N17_DATA_NAUJA>
        <N17_MIN_ANTK>0.00</N17_MIN_ANTK>
        <N17_KODAS_LS_5></N17_KODAS_LS_5>
        <N17_KODAS_LS_6></N17_KODAS_LS_6>
        <N17_KODAS_LS_7></N17_KODAS_LS_7>
        <N17_KODAS_LS_8></N17_KODAS_LS_8>
        <N17_MIN_ANTK_UR>0.00</N17_MIN_ANTK_UR>
        <N17_MIN_ANTK_UR_D>2020-02-29T00:00:00</N17_MIN_ANTK_UR_D>
        <N17_MAX_ANTK>0.00</N17_MAX_ANTK>
        <N17_SVS_GALIOJA>0</N17_SVS_GALIOJA>
        <N17_SVS_GALIOJA_D>0</N17_SVS_GALIOJA_D>
        <N17_SVS_PARTIJA>0</N17_SVS_PARTIJA>
        <N17_PAV_K1></N17_PAV_K1>
        <N17_PAV_K2></N17_PAV_K2>
        <N17_PAV_K3></N17_PAV_K3>
    </N17>
</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.f8ddfad4.1584209364010</id>
    <durationMs>6</durationMs>
    <errorMessage>nepavyko įvykdyti metodo</errorMessage>
    <errors>
        <error>
            <data>&lt;N17>&lt;N17_KODAS_PS>PASLX&lt;/N17_KODAS_PS>&lt;N17_TIPAS>2&lt;/N17_TIPAS>&lt;N17_KODAS_US>VNT&lt;/N17_KODAS_US>&lt;N17_KODAS_DS>PR001&lt;/N17_KODAS_DS>&lt;N17_PAV>Paslauga X&lt;/N17_PAV>&lt;/N17></data>
            <dataErrors>
                <dataError>
                    <tag>N17_KODAS_PS</tag>
                    <code>5008</code>
                    <message>Tokia prekė/paslauga jau yra</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 trynimas

Koregavimas, trynimas vyksta pagal lentelės raktą (Primary Key)

Koreguojant informaciją bus koreguojami tik perduodami laukai.

pvz koregavimas:

<body>
    <method>EDIT_N17</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N17>
            <N17_KODAS_PS>PASLX</N17_KODAS_PS>
            <N17_PAV>Paslauga ABC</N17_PAV>
        </N17>   
    </data>
</body>

Trynimas vyksta pagal atitinkamos lentelės raktą (Primary Key)

pvz trynimas:

<body>
    <method>EDIT_N17</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N17>
            <N17_KODAS_PS>PASLX</N17_KODAS_PS>
        </N17>   
    </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, '{
    "method": "EDIT_N17",
    "params": {
        "oper": "I"
    },
    "data": {
        "N17": {
            "N17_KODAS_PS": "PASLX",
            "N17_TIPAS": "2",
            "N17_PAV": "Paslauga X",
            "N17_KODAS_DS": "PR001",
            "N17_KODAS_US": "VNT"
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N17

Prekės, paslaugos kortelės lentelė

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
N17_KODAS_PS	C(12)	Prekės kodas	Privalomas
N17_TIPAS	N(1)	Tipas:1-prekė,2-paslauga	Privalomas
N17_KODAS_P1	C(12)	Pirmas alternatyvus kodas
N17_KODAS_P2	C(12)	Antras alternatyvus kodas
N17_KODAS_US	C(12)	Pagrindinis matavimo vieneto kodas	Privalomas
N17_PAV	C(120)	Pavadinimas
N17_PAVU	C(150)	Pavadinimas kita kalba
N17_KODAS_KS	C(12)	Tiekėjo kodas
N17_KOD_T	C(25)	Kodas tiekėjo kataloguose
N17_KODAS_KS1	C(12)	Pirmas alternatyvus tiekėjo kodas
N17_KOD_T1	C(25)	Kodas pirmo alternatyvaus tiekėjo kataloguose
N17_KODAS_KS2	C(12)	Antras alternatyvus tiekėjo kodas
N17_KOD_T2	C(25)	Kodas antro alternatyvaus tiekėjo kataloguose
N17_KODAS_VS	C(12)	Vietovės kodas
N17_KODAS_ES	C(12)	Sezono kodas
N17_UZSIGUL	N(6,2)	Prekės užsigulėjimo procentas
N17_BAZ_KIEKIS	N(14)	Metų bazinis(vidutinis) kiekis
N17_ASSEMBLY	N(1)	Rūšis: 1-paprasta, 2-komplektuojama, 3-išskaidoma, 4-generavimui, 5-sudėtinė, 6-komplektuojama/išskaidoma, 7-mišri, 8-tara
N17_KODAS_LS_1	C(12)	Logistikos 1 kodas
N17_KODAS_LS_2	C(12)	Logistikos 2 kodas
N17_KODAS_LS_3	C(12)	Logistikos 3 kodas
N17_KODAS_LS_4	C(12)	Logistikos 4 kodas
N17_KODAS_DS	C(12)	Sąskaitos ryšio kodas	Privalomas
N17_NUOL_GR	C(6)	Nuolaidos grupė
N17_GALIOJA	N(5)	Galiojimo dienos
N17_MOKESTIS	N(1)	Ar prekė apmokestinama:0-ne,1-taip
N17_TAX	N(1)	PVM mokestis,1-A,2-B,3-C,4-D
N17_KODAS_KS_G	C(12)	Prekės gamintojo kodas
N17_KODAS_GS	C(12)	Grupės kodas
N17_INSTR_POZ	N(1)	Ar reikia instrukcijos prekei?:0-ne,1-taip
N17_INSTR_TIP	C(1)	Instrukcijos tipas
N17_INSTR_VYK	N(1)	Ar reikia daryti instrukciją?:0-ne,1-taip
N17_INSTR_DATE	T(8)	Instrukcijos data
N17_INSTR_FILE	C(12)	Instrukcijos failo pavadinimas
N17_URM_POZ	N(1)	Urmo pozymis:0-ne,1-taip
N17_URM_DATEIN	T(8)	Pateko į urmą
N17_URM_DATEOU	T(8)	iškrito iš urmo
N17_KREPS_POZ	N(1)	Ar krepšelio prekė:0-ne,1-taip
N17_KREPS_KTG	C(1)	Krepšelio kategorija
N17_KREPS_MIN	N(14)	Krepšelio minimumas
N17_GARANT_POZ	N(1)	Ar yra garantija:0-ne,1-taip
N17_GARANT_MEN	N(3)	Garantija mėnesiais
N17_KODAS_KS3	C(12)	Garantija atlieka tiekėjas.Kliento kodas
N17_TEMPER_POZ	N(1)	Temperatūros požymis:0-ne,1-taip
N17_TEMPER_MAX	N(3)	Max temperatūra
N17_TEMPER_MIN	N(3)	Min temperatūra
N17_TEMPER_TXT	C(20)	Kitos laikymo sąlygos
N17_SERTIF_POZ	N(1)	Ar reikia sertifikato:0-ne,1-taip
N17_KODAS_MS	C(12)	Marketologo kodas(iš menedžerių sąrašo)
N17_ANTKAINIS	N(6,2)	Antkainio procentas
N17_MAX_NUOL	N(6,2)	Maksimalus nuolaidos procentas parduodant
N17_EX_IM_FRAC	N(4)	Rezervas
N17_G_TIME	N(6)	Rezervas
N17_KODAS_OS	C(12)	Objekto kodas
N17_VAZ_LAIK	N(4)	Vežimo laikas
N17_UZS_LAIK	N(4)	Užsakymo laikas
N17_PAP_LAIK	N(4)	Papildomas laikas
N17_SAN_COST	N(10,2)	Sandėliavimo sąnaudos
N17_UZS_COST	N(10,2)	Užsakymo sąnaudos
N17_TRA_COST	N(10,2)	Transportavimo sąnaudos
N17_MEN_PAV	C(150)	Pavadinimas skirtas menedžeriams
N17_MUIT_KOD	C(16)	Muitinėje prekės kodas
N17_SK_KODAS	N(2)	Prekės skyrius kasoje
N17_INTERNET	N(1)	Interneto požymis:0-ne,1-taip
N17_DUM_POZ	N(1)	Ar užsigulėjusi prekė:0-ne,1-taip
N17_DUM_TIP	C(1)	Užsigulėjimo tipas
N17_DUM_D_IN	T(8)	Kada pateko į užsigulėjimą
N17_DUM_D_OUT	T(8)	Kada iškrito iš išsigulėjimo
N17_MUITO_PROC	N(6,2)	Muito procentas
N17_AKCIZO_PROC	N(6,2)	Akcizo procentas
N17_PASTABOS	M(4)	Pastabos
N17_POZ_DATE	N(1)	Terminuota:0-ne,1-taip
N17_BEG_DATE	T(8)	Termino pradžia
N17_END_DATE	T(8)	Termino pabaiga
N17_USERIS	C(12)	Kas koregavo
N17_R_DATE	T(8)	Kada koregavo
N17_ADD_DATE	T(8)	Kada sukurta kortelė
N17_ADDUSR	C(12)	Kas sukūrė
N17_MIN_VISO	N(14)	Minimumas įmonės mastu
N17_SERT_POZ	C(1)	Sertifikavimo požymis
N17_KAT_POZ	C(1)	Kategorijos požymis
N17_BROK_POZ	N(1)	Broko pozymis
N17_KODAS_PS_G	C(12)	Geras prekės kodas
N17_DATA_BR	T(8)	Iki kada_brokas
N17_KODAS_VS_T	C(12)	Šalis tiekėja
N17_KODAS_MS_A	C(12)	Analitikas
N17_KODAS_MS_M	C(12)	Menedžeris
N17_AR_NAUJA	N(1)	Ar nauja prekė
N17_DATA_NAUJA	T(8)	Iki kada nauja
N17_MIN_ANTK	N(6,2)	Minimalus antkainis
N17_KODAS_LS_5	C(12)	Logistikos kodas 5
N17_KODAS_LS_6	C(12)	Logistikos kodas 6
N17_KODAS_LS_7	C(12)	Logistikos kodas 7
N17_KODAS_LS_8	C(12)	Logistikos kodas 8
N17_MIN_ANTK_UR	N(6,2)	Minimalus urminių kainų antkainis
N17_MIN_ANTK_UR_D	T(8)	Minimalaus urminio antkainio galiojimas
N17_MAX_ANTK	N(6,2)	Maksimalus antkainis
N17_SVS_GALIOJA	N(1)	SVS-e būtina galiojimo data
N17_SVS_GALIOJA_D	N(5)	SVS galiojimo dienos
N17_SVS_PARTIJA	N(1)	SVS būtina partija: 0-Ne,1-Taip
N17_PAV_K1	C(100)	Pavadinimas kita kalba 1
N17_PAV_K2	C(100)	Pavadinimas kita kalba 2
N17_PAV_K3	C(100)	Pavadinimas kita kalba 3
N17_BUSENA	N(3,0)	Būsena	nuo v118.0200
NUORODA	C(4000)	Nuoroda į dokumentą, failą ar paveiksliuką