GET_I24_LIST

Aprašymas

Išorinių įrenginių sąrašas

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 : GET_I24_LIST
params :
- list :H - grąžinama tik pagrindinė informacija (I24) (default). Jeigu A - grąžinama visa susijusi informacija (I24+I63).
- fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės I24 nenurodant pačio where tag'o. Neprivaloma
- pagenumber: įrašų puslapio numeris. GET_LIST metodai rezultatus grąžina puslapiais po 100 įrašų, pagenumber parametras nurodo kelintą puslapį grąžinti. Jei nenurodomas, tuomet grąžinamas pirmas puslapis su 100 naujausių įrašų. Neprivaloma

Sąraše su daugiau nei 1 įrašu informacija visada grąžinama surūšiuota pagal atitinkamos lentelės raktą (Primary Key)

GET_LIST metodų apribojima 100 įrašų, todėl norint gauti visą sąrašą, turite naudoti filtrus, kurie grąžins rezultatą dalimis per kelis kartus, filtruojant pagal paskutinio gauto įrašo rakto reikšmę.

pvz application/xml:

<body>
    <method>GET_I24_LIST</method>
    <params>
        <fil>i24_kodas_kk='KAUPIKLIS'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_I24_LIST",
    "params": {
        "fil": "i24_kodas_kk='KAUPIKLIS'"
    }
}

Response (status 200 OK)

Grąžinama informacija XML formate tarp tag'ų <RET_DOK>..</RET_DOK>. Esant daugiau nei vienam įrašui informacija rūšiuojama (order) pagal lentelės raktinį lauką I24_KODAS_KK

Jeigu įrašų nerasta pagal užduotas sąlygas, tuomet gražinama status=200 bei tuščias tag'as

pvz:

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <I24>
        <Row_number>1</Row_number>
        <I24_KODAS_KK>KAUPIKLIS   </I24_KODAS_KK>
        <I24_KODAS_IS>01</I24_KODAS_IS>
        <I24_KODAS_KS></I24_KODAS_KS>
        <I24_KODAS_MS></I24_KODAS_MS>
        <I24_KODAS_OS></I24_KODAS_OS>
        <I24_KODAS_SS></I24_KODAS_SS>
        <I24_KOMP_PAV>KOMP</I24_KOMP_PAV>
        <I24_TIPAS>11</I24_TIPAS>
        <I24_NUOL_PROC>0.00</I24_NUOL_PROC>
        <I24_MAX_PLU>0</I24_MAX_PLU>
        <I24_FIZ_NR></I24_FIZ_NR>
        <I24_BAT></I24_BAT>
        <I24_KIT_LIK>0</I24_KIT_LIK>
        <I24_MIN_LIK>1</I24_MIN_LIK>
        <I24_ATS_M>1</I24_ATS_M>
        <I24_K_FILE></I24_K_FILE>
        <I24_K_ERROR></I24_K_ERROR>
        <I24_COMPORT>1</I24_COMPORT>
        <I24_VISAS>0</I24_VISAS>
        <I24_PAR_TXT1></I24_PAR_TXT1>
        <I24_PAR_TXT2></I24_PAR_TXT2>
        <I24_PAR_TXT3></I24_PAR_TXT3>
        <I24_PAR_TXT4></I24_PAR_TXT4>
        <I24_PAR_TXT5></I24_PAR_TXT5>
        <I24_PAR_TXT6></I24_PAR_TXT6>
        <I24_PAR_TXT7>                            1    1000   </I24_PAR_TXT7>
        <I24_PAR_TXT8>                                     1  </I24_PAR_TXT8>
        <I24_PAR_TXT9>                                       </I24_PAR_TXT9>
        <I24_PAR_TXT10>                                       </I24_PAR_TXT10>
        <I24_PAR_TXT11>                                       </I24_PAR_TXT11>
        <I24_PAR_TXT12>                                       </I24_PAR_TXT12>
        <I24_PAR_TXT13> 1                     1                </I24_PAR_TXT13>
        <I24_PAR_TXT14>                                       </I24_PAR_TXT14>
        <I24_PAR_TXT15>                                       </I24_PAR_TXT15>
        <I24_PAR_NUM1>0</I24_PAR_NUM1>
        <I24_PAR_NUM2>0</I24_PAR_NUM2>
        <I24_PAR_NUM3>2</I24_PAR_NUM3>
        <I24_PAR_NUM4>0</I24_PAR_NUM4>
        <I24_PAR_NUM5>0</I24_PAR_NUM5>
        <I24_PAR_NUM6>0</I24_PAR_NUM6>
        <I24_PAR_NUM7>1</I24_PAR_NUM7>
        <I24_PAR_NUM8>1</I24_PAR_NUM8>
        <I24_PAR_NUM9>1</I24_PAR_NUM9>
        <I24_PAR_NUM10>0</I24_PAR_NUM10>
        <I24_PAR_NUM11>1</I24_PAR_NUM11>
        <I24_PAR_NUM12>0</I24_PAR_NUM12>
        <I24_PAR_NUM13>0</I24_PAR_NUM13>
        <I24_PAR_NUM14>3</I24_PAR_NUM14>
        <I24_PAR_NUM15>0</I24_PAR_NUM15>
        <I24_R_DATE>2020-07-31T14:38:00</I24_R_DATE>
        <I24_USERIS>MASTER</I24_USERIS>
        <I24_ADDUSR>MASTER      </I24_ADDUSR>
        <I24_LOJ_POZ>0</I24_LOJ_POZ>
        <I24_KODAS_FR_PS>           </I24_KODAS_FR_PS>
        <I24_KODAS_FR>           </I24_KODAS_FR>
        <I24_LOJ_MOK>0</I24_LOJ_MOK>
        <I24_KODAS_SS_LOJ>           </I24_KODAS_SS_LOJ>
        <I24_LOJ_PS>0</I24_LOJ_PS>
        <I24_KODAS_FS>           </I24_KODAS_FS>
        <I24_KODAS_FR_MOK>           </I24_KODAS_FR_MOK>
        <I24_PAR_TXT16>        0.00                            </I24_PAR_TXT16>
        <I24_PAR_TXT17>   0   0                                </I24_PAR_TXT17>
        <I24_PAR_TXT18>                                       </I24_PAR_TXT18>
        <I24_PAR_TXT19>                                       </I24_PAR_TXT19>
        <I24_PAR_TXT20>                                       </I24_PAR_TXT20>
    </I24>
</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>21313695680.659726ff.1596195824528</id>
    <durationMs>3</durationMs>
    <errorMessage>Invalid column name 'i24_kodas_kkd'.</errorMessage>
</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>/v1</path>
</Map>

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": "GET_I24_LIST",
    "params": {
        "fil": "i24_kodas_kk=\'KAUPIKLIS\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I24

Išorinių įrenginių lentelė

Laukas	Tipas	Aprašymas
I24_KODAS_KK	C(12)	Kasos kodas
I24_KODAS_IS	C(12)	Padalinio kodas
I24_KODAS_KS	C(12)	Kliento kodas
I24_KODAS_MS	C(12)	Menedžeris pardavėjas
I24_KODAS_OS	C(12)	Pardavimo centras
I24_KODAS_SS	C(12)	Grinų pinigų mokėjimo sąskaita
I24_KOMP_PAV	C(40)	Kompiuterio vardas prie kurio pajungtos kasos
I24_TIPAS	N(3)	Kasų tipas 1-RS28MF, 2- RS40MF,3-SANYO 630,....
I24_NUOL_PROC	N(6,2)	Nuolaidos procentas RS40MF jungiant per rs portą
I24_MAX_PLU	N(6)	Maksimalus PLU numerislaikas
I24_FIZ_NR	C(40)	Fizinis kasos adresaslogas
I24_BAT	C(12)	Paleidžiamas bat failiuko vardas siuntimui į kasas
I24_KIT_LIK	N(1)	Ar galima pardavinėti nuo kitų mat. vnt.:0-ne,1-taip
I24_MIN_LIK	N(1)	Ar galima pardavinėti į minusą?:0-ne,1-taip
I24_ATS_M	N(1)	Galimi mišrūs atsiskaitymai:0-ne,1-taip
I24_K_FILE	C(40)	Kasos failiuko kelias
I24_K_ERROR	C(40)	Kasos klaidos failiukas
I24_COMPORT	N(1)	Com porto numeris
I24_VISAS	N(1)	Kvito spausdinimo būdas:1-realiai,0-kvito pabaigoje
I24_PAR_TXT1	C(40)	1.Tekstinis parametras kvito pabaigoje
I24_PAR_TXT2	C(40)	2.Tekstinis parametras kvito pabaigoje
I24_PAR_TXT3	C(40)	3.Tekstinis parametras kvito pabaigoje
I24_PAR_TXT4	C(40)	Kasos ataskaito failukas su keliu
I24_PAR_TXT5	C(150)	Sveriamų prekių maketai
I24_PAR_TXT6	C(40)	Tekstinis parametras 6
I24_PAR_TXT7	C(40)	Tekstinis parametras 7
I24_PAR_TXT8	C(40)	Tekstinis parametras 8
I24_PAR_TXT9	C(40)	Tekstinis parametras 9
I24_PAR_TXT10	C(40)	Tekstinis parametras 10
I24_PAR_TXT11	C(40)	Tekstinis parametras 11
I24_PAR_TXT12	C(40)	Tekstinis parametras 12
I24_PAR_TXT13	C(40)	Tekstinis parametras 13
I24_PAR_TXT14	C(40)	Tekstinis parametras 14
I24_PAR_TXT15	C(40)	Tekstinis parametras 15
I24_PAR_NUM1	N(5)	Sveriamos prekės požymis
I24_PAR_NUM2	N(5)	Sveriamos prekės kodo ilgis bar kode
I24_PAR_NUM3	N(5)	Ekranėlio parametras 1-nėra,2-1 eil.,3-2 eil.
I24_PAR_NUM4	N(5)	Skaitmeninis parametras 4
I24_PAR_NUM5	N(5)	Skaitmeninis parametras 5
I24_PAR_NUM6	N(5)	Skaitmeninis parametras 6
I24_PAR_NUM7	N(5)	Skaitmeninis parametras 7
I24_PAR_NUM8	N(5)	Skaitmeninis parametras 8
I24_PAR_NUM9	N(5)	Skaitmeninis parametras 9
I24_PAR_NUM10	N(5)	Skaitmeninis parametras 10
I24_PAR_NUM11	N(5)	Skaitmeninis parametras 11
I24_PAR_NUM12	N(5)	Skaitmeninis parametras 12
I24_PAR_NUM13	N(5)	Skaitmeninis parametras 13
I24_PAR_NUM14	N(5)	Skaitmeninis parametras 14
I24_PAR_NUM15	N(5)	Skaitmeninis parametras 15
I24_PAR_NUM1	C(12)	Skaitmeninis parametras 4
I24_R_DATE	T(8)	Kada koregavo
I24_USERIS	C(12)	Kas koregavo
I24_ADDUSR	C(12)	Kas sukūrė
I24_LOJ_POZ	N(1)	Naudoti lojalumą: 0-ne;1-taip
I24_KODAS_FR_PS	C(12)	Formulė prekei
I24_KODAS_FR	C(12)	Formulė kvitui
I24_LOJ_MOK	N(1)	Lojalumo atsiskaitymas mokėjimu: 0-ne;1-taip
I24_KODAS_SS_LOJ	C(12)	Lojalumo apmokėjimo sąskaita
I24_LOJ_PS	N(1)	Lojalumo apmokėjimas preke: 0-ne;1-taip
I24_KODAS_FS	C(12)	Lojalumo apmokėjimo preke filt.lentelė
I24_KODAS_FR_MOK	C(12)	Lojalumo apmokėjimo pinigų koeficiento formulė
I24_PAR_TXT16	C(40)	Tekstinis parametras 16
I24_PAR_TXT17	C(40)	Tekstinis parametras 17
I24_PAR_TXT18	C(40)	Tekstinis parametras 18
I24_PAR_TXT19	C(40)	Tekstinis parametras 19
I24_PAR_TXT20	C(40)	Tekstinis parametras 20