GET_N07_LIST

Aprašymas

Padalinių 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_N07_LIST
params :
- fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N07 nenurodant pačio where tag'o. Neprivaloma
- pageNumber : puslapio numeris. GET_LIST metodai rezultatus grąžina puslapiais po 100 įrašų, pageNumber parametras nurodo kelintą puslapį grąžinti. Pagal nutylėjimą grąžinamas pirmas puslapis.

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_N07_LIST</method>
    <params>
        <fil>n07_kodas_is='01'</fil>
        <pageNumber>2</pageNumber>
    </params>
</body>

pvz application/json:

{
    "method": "GET_N07_LIST",
    "params": {
        "fil": "n07_kodas_is='01'",
        "pageNumber": 2
    }
}

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ą N07_KODAS_IS

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>
    <N07>
        <Row_number>1</Row_number>
        <N07_KODAS_IS>999999999999</N07_KODAS_IS>
        <N07_PAV>UAB &quot;Rivilė&quot;                            </N07_PAV>
        <N07_RESURSAS>0</N07_RESURSAS>
        <N07_KODAS_RE>            </N07_KODAS_RE>
        <N07_PAD_TIP>  </N07_PAD_TIP>
        <N07_PAD_GR1>  </N07_PAD_GR1>
        <N07_PAD_GR2>  </N07_PAD_GR2>
        <N07_EIL1>                                        </N07_EIL1>
        <N07_EIL2>                                        </N07_EIL2>
        <N07_EIL3>                                        </N07_EIL3>
        <N07_NUTOLES>0</N07_NUTOLES>
        <N07_FIX_POZ>0</N07_FIX_POZ>
        <N07_PVM_KAIN>0</N07_PVM_KAIN>
        <N07_IM_ID>00</N07_IM_ID>
        <N07_NUOLAIDOS>1</N07_NUOLAIDOS>
        <N07_KAINA_POZ>0</N07_KAINA_POZ>
        <N07_KODAS_SS>            </N07_KODAS_SS>
        <N07_POZ_DATE>0</N07_POZ_DATE>
        <N07_BEG_DATE>2008-01-31 00:00:00.000</N07_BEG_DATE>
        <N07_END_DATE>2008-01-31 00:00:00.000</N07_END_DATE>
        <N07_ADDUSR>MASTER      </N07_ADDUSR>
        <N07_USERIS>MASTER      </N07_USERIS>
        <N07_R_DATE>2008-01-31 11:23:08.000</N07_R_DATE>
        <N07_KODAS_VS>            </N07_KODAS_VS>
        <N07_KODAS_LS_1>            </N07_KODAS_LS_1>
        <N07_KODAS_LS_2>            </N07_KODAS_LS_2>
        <N07_KODAS_LS_3>            </N07_KODAS_LS_3>
        <N07_KODAS_LS_4>            </N07_KODAS_LS_4>
        <N07_KODAS_TM>            </N07_KODAS_TM>
        <N07_REZERVAS>0                                       </N07_REZERVAS>
        <N07_KODAS_LS_5>            </N07_KODAS_LS_5>
        <N07_KODAS_LS_6>            </N07_KODAS_LS_6>
        <N07_KODAS_LS_7>            </N07_KODAS_LS_7>
        <N07_KODAS_LS_8>            </N07_KODAS_LS_8>
        <N07_VADOVAS>                                                            </N07_VADOVAS>
        <N07_TELEF>                                        </N07_TELEF>
        <N07_FAX>                                        </N07_FAX>
        <N07_EIL4>                                                            </N07_EIL4>
        <N07_EIL5>                                                            </N07_EIL5>
        <N07_EIL6>                                                            </N07_EIL6>
        <N07_KODAS_FR_LNF>            </N07_KODAS_FR_LNF>
        <N07_KODAS_TM_P>            </N07_KODAS_TM_P>
        <N07_KODAS_ZN>            </N07_KODAS_ZN>
        <N07_GLN>                    </N07_GLN>
    </N07>
</RET_DOK>

Response (status 400)

Klaida paduodant duomenis / SQL sintaksės klaidos / kitos DB klaidos

<RET_DOK type="error">
    <id>2552c6d.dd81a1c1580324646507</id>
    <durationMs>53</durationMs>
    <errorMessage>Invalid column name 'n07_kodas_xx'.</errorMessage>
</RET_DOK>

Response (status 401)

Blogai nurodytas adresas / neteisingai nurodytas API raktas / nenurodytas API raktas / pasibaigęs API rakto galiojimas / API raktas neturi teisių vykdyti šį metodą, 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_N07_LIST",
    "params": {
        "fil": "n07_kodas_is=\'1214\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N07

Nuoroda į lentelės aprašymą: N07