GET_K56_LIST

Aprašymas

CRM operacijų 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_K56_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės K56 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_K56_LIST</method>
    <params>
        <fil>k56_kodas_ho='010000000001'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_K56_LIST",
    "params": {
        "fil": "k56_kodas_ho='010000000001'"
    }
}
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ą K56_KODAS_HO

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>
    <K56>
        <Row_number>1</Row_number>
        <K56_KODAS_HO>010000000001</K56_KODAS_HO>
        <K56_KODAS_HP>PVZ_P01</K56_KODAS_HP>
        <K56_PAV_HP>Pardavimas</K56_PAV_HP>
        <K56_KODAS_HU>PVZ_U01</K56_KODAS_HU>
        <K56_PAV_HU>Pirminis kontaktas</K56_PAV_HU>
        <K56_DATE>2020-05-14T00:00:00</K56_DATE>
        <K56_KODAS_KS>121411842   </K56_KODAS_KS>
        <K56_PAV_KS>UAB "Rivilė"</K56_PAV_KS>
        <K56_KODAS_SM></K56_KODAS_SM>
        <K56_ADRESAS>Geležinio Vilko 5-48, Vilnius</K56_ADRESAS>
        <K56_E_MAIL>rivile@rivile.lt</K56_E_MAIL>
        <K56_TELEFONAS> 8 5 2395535</K56_TELEFONAS>
        <K56_KODAS_MS></K56_KODAS_MS>
        <K56_ADDUSR>MASTER</K56_ADDUSR>
        <K56_ADD_DATE>2020-05-14T21:03:54</K56_ADD_DATE>
        <K56_USERIS>MASTER</K56_USERIS>
        <K56_R_DATE>2020-05-14T21:06:50</K56_R_DATE>
        <K56_DATE_PRP>2020-05-14T00:00:00</K56_DATE_PRP>
        <K56_DATE_PBP>2020-05-17T00:00:00</K56_DATE_PBP>
        <K56_DATE_PRV>2020-05-14T00:00:00</K56_DATE_PRV>
        <K56_DATE_PBV>2020-05-14T00:00:00</K56_DATE_PBV>
        <K56_PASTABOS></K56_PASTABOS>
        <K56_KODAS_HV>PVZ_V01</K56_KODAS_HV>
        <K56_PAV_REZ>Produkto pristatymas</K56_PAV_REZ>
        <K56_PERKELTA>1</K56_PERKELTA>
        <K56_KODAS_LS_1></K56_KODAS_LS_1>
        <K56_KODAS_LS_2></K56_KODAS_LS_2>
        <K56_KODAS_LS_3></K56_KODAS_LS_3>
        <K56_KODAS_LS_4></K56_KODAS_LS_4>
        <K56_BUSENA>1</K56_BUSENA>
    </K56>
</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.4776b8ea.1589480770351</id>
    <durationMs>61</durationMs>
    <errorMessage>Invalid column name 'k56_kodass_ho'.</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_K56_LIST",
    "params": {
        "fil": "k56_kodas_ho=\'010000000001\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

K56

Nuoroda į lentelės aprašymą: K56