GET_A06_LIST

Aprašymas

Darbuotojoų 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_A06_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės A06 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_A06_LIST</method>
    <params>
        <fil>a06_kodas_tb='tst01'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_A06_LIST",
    "params": {
        "fil": "a06_kodas_tb='tst01'"
    }
}
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ą N72_KODAS_AU

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

pvz.:

<RET_DOK>
    <A06>
        <Row_number>1</Row_number>
        <A06_KODAS_TB>004         </A06_KODAS_TB>
        <A06_VARDAS>v4                                                                                                  </A06_VARDAS>
        <A06_PAV>p4(darbuotojas r1)                                                                                  </A06_PAV>
        <A06_LYTIS>3</A06_LYTIS>
        <A06_KODAS_VS>           </A06_KODAS_VS>
        ...
        <A07_TABP>
            <a07>
                <A07_KODAS_TB>004         </A07_KODAS_TB>
                <A07_KODAS_IS>999999999999</A07_KODAS_IS>
                <A07_PAREIGOS>Darbuotojas                                                 </A07_PAREIGOS>
                <A07_KODAS_LA>S_SISTEMINIS</A07_KODAS_LA>
                ...
            </a07>
        </A07_TABP>
    </A06>
    <A06>
        <Row_number>2</Row_number>
        <A06_KODAS_TB>005         </A06_KODAS_TB>
        <A06_VARDAS>v5                                                                                                  </A06_VARDAS>
        <A06_PAV>p5 (vadovas r2)                                                                                     </A06_PAV>
        <A06_LYTIS>3</A06_LYTIS>
        <A06_KODAS_VS>           </A06_KODAS_VS>
        ...
        <A07_TABP>
            <a07>
                <A07_KODAS_TB>005         </A07_KODAS_TB>
                <A07_KODAS_IS>999999999998</A07_KODAS_IS>
                <A07_PAREIGOS>Darbuotojas                                                 </A07_PAREIGOS>
                <A07_KODAS_LA>S_SISTEMINIS</A07_KODAS_LA>
                <A07_KODAS_DS>AL001       </A07_KODAS_DS>
                ...
            </a07>
            ...
        </A07_TABP>
    </A06>
    ...
</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 'a06_kodas_tbp'.</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_A06_LIST",
    "params": {
        "fil": "a06_kodas_tb=\'tst01\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

A06

Nuoroda į lentelės aprašymą: a06

A07

Nuoroda į lentelės aprašymą: a07

A08

Nuoroda į lentelės aprašymą: a08