GET_N15_LIST

Aprašymas

Menedžerių 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_N15_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N15 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_N15_LIST</method>
    <params>
        <fil>n15_kodas_ms='M01'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_N15_LIST",
    "params": {
        "fil": "n15_kodas_ms='M01'"
    }
}
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ą N15_KODAS_MS

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>
    <N15>
        <Row_number>1</Row_number>
        <N15_KODAS_MS>M01         </N15_KODAS_MS>
        <N15_RUSIS>0</N15_RUSIS>
        <N15_PAV>M01</N15_PAV>
        <N15_LYGIS>1</N15_LYGIS>
        <N15_TEVAS></N15_TEVAS>
        <N15_TIPAS>2</N15_TIPAS>
        <N15_POZ_DATE>0</N15_POZ_DATE>
        <N15_BEG_DATE>2018-01-17T00:00:00</N15_BEG_DATE>
        <N15_END_DATE>2018-01-17T00:00:00</N15_END_DATE>
        <N15_ADDUSR>MASTER</N15_ADDUSR>
        <N15_USERIS>MASTER</N15_USERIS>
        <N15_R_DATE>2020-06-25T09:21:57</N15_R_DATE>
        <N15_TAB_NO>0</N15_TAB_NO>
        <N15_PAJ_KOD>0</N15_PAJ_KOD>
        <N15_KODAS_SS></N15_KODAS_SS>
        <N15_KODAS_BS></N15_KODAS_BS>
        <N15_PAREIGOS></N15_PAREIGOS>
        <N15_ADRESAS></N15_ADRESAS>
        <N15_TEL></N15_TEL>
        <N15_E_MAIL></N15_E_MAIL>
        <N15_PASTABOS></N15_PASTABOS>
        <N15_FLG_PO>1</N15_FLG_PO>
        <N15_FLG_RO>1</N15_FLG_RO>
        <N15_FLG_KR>1</N15_FLG_KR>
        <N15_FLG_CI>1</N15_FLG_CI>
        <N15_FLG_CH>1</N15_FLG_CH>
        <N15_FLG_TR>0</N15_FLG_TR>
        <N15_FLG_PP>1</N15_FLG_PP>
        <N15_FLG_AL>1</N15_FLG_AL>
        <N15_FLG_RR1>0</N15_FLG_RR1>
        <N15_FLG_RR2>0</N15_FLG_RR2>
        <N15_FLG_RR3>0</N15_FLG_RR3>
        <N15_FLG_RR4>0</N15_FLG_RR4>
        <N15_FLG_RR5>0</N15_FLG_RR5>
        <N15_MAX_NUOL>0.00</N15_MAX_NUOL>
    </N15>
</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>3451ded.be556121580910178112</id>
    <durationMs>25</durationMs>
    <errorMessage>Invalid column name 'n15_kodas_psb'.</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_N15_LIST",
    "params": {
        "fil": "n15_kodas_ms=\'M01\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N15

Menedžerių lentelės aprašymas

Laukas Tipas Aprašymas Pastabos
N15_KODAS_MS C(12) Menedžerio kodas
N15_RUSIS N(1) Rūšis:1-pardavėjas,2-pirkėjas,3-pardavėjas/pirkėjas,4-ats.asmuo,5-vairuotojas
N15_PAV C(150) Pavadinimas
N15_LYGIS N(3) Lygis
N15_TEVAS C(12) Aukštesnio lygio menedžerio kodas
N15_TIPAS N(1) Tipas:1-suminis,2-detalus
N15_POZ_DATE N(1) Terminuotas:0-ne,1-taip
N15_BEG_DATE T(8) Pradžios data
N15_END_DATE T(8) Pabaigos data
N15_ADDUSR C(12) Kas sukūrė
N15_USERIS C(12) Kas koregavo
N15_R_DATE T(8) Koregavimo laikas
N15_TAB_NO N(5) Tabelinis numeris iš atlyginimų
N15_PAJ_KOD N(5) Priskaitymo kodas iš atlyginimų
N15_KODAS_SS C(12) Sąskaitos kodas
N15_KODAS_BS C(12) Dienpinigių kodas
N15_PAREIGOS C(40) Pareigos
N15_ADRESAS C(150) Adresas
N15_TEL C(40) Telefonai
N15_E_MAIL C(150) E-mail
N15_PASTABOS C(40) Pastabos
N15_FLG_PO N(1) Pirkimų modulis
N15_FLG_RO N(1) Pardavimų modulis
N15_FLG_KR N(1) Debitorinių/Kred. op. modulis
N15_FLG_CI N(1) Išmokos
N15_FLG_CH N(1) Įplaukųi modulis
N15_FLG_TR N(1) Transporto modulis
N15_FLG_PP N(1) Pagrindinės priemonės
N15_FLG_AL N(1) Algų modulis
N15_FLG_RR1 N(1) Vidiniai
N15_FLG_RR2 N(1) Rezervas
N15_FLG_RR3 N(1) Rezervas
N15_FLG_RR4 N(1) Rezervas
N15_FLG_RR5 N(1) Rezervas
N15_MAX_NUOL N(6,2) Maksimali nuolaida