GET_N06_LIST

Aprašymas

Objektų 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_N06_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N06 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ą „porcijomis“ per kelis kartus, filtruojant pagal paskutinio gauto įrašo rakto reikšmę.

pvz application/xml:

<body>
    <method>GET_N06_LIST</method>
    <params>
        <fil>n06_kodas_os='2709'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_N06_LIST",
    "params": {
        "fil": "n06_kodas_os='2709'"
    }
}
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ą N06_KODAS_OS

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>
    <N06>
        <Row_number>1</Row_number>
        <N06_KODAS_OS>2709</N06_KODAS_OS>
        <N06_PAV>2709</N06_PAV>
        <N06_LYGIS>2</N06_LYGIS>
        <N06_TEVAS>CENTRO_KODAS</N06_TEVAS>
        <N06_TIPAS>2</N06_TIPAS>
        <N06_APRAS></N06_APRAS>
        <N06_POZ_DATE>0</N06_POZ_DATE>
        <N06_BEG_DATE>2020-01-21T00:00:00</N06_BEG_DATE>
        <N06_END_DATE>2020-01-21T00:00:00</N06_END_DATE>
        <N06_STATUS>1</N06_STATUS>
        <N06_KODAS_PS></N06_KODAS_PS>
        <N06_SERIJA></N06_SERIJA>
        <N06_GALIOJA>0</N06_GALIOJA>
        <N06_KODAS_KS></N06_KODAS_KS>
        <N06_ADDUSR>MASTER</N06_ADDUSR>
        <N06_USERIS>MASTER</N06_USERIS>
        <N06_R_DATE>2020-01-29T19:30:21</N06_R_DATE>
        <n06_aprasymas1></n06_aprasymas1>
        <n06_aprasymas2></n06_aprasymas2>
        <n06_aprasymas3></n06_aprasymas3>
    </N06>
</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 'n06_kodas_ops'.</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 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_N06_LIST",
    "params": {
        "fil": "n06_kodas_os=\'2709\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N06

Nuoroda į lentelės aprašymą: N06