GET_N45_LIST

Aprašymas

Valiutų 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_N45_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N45 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_N45_LIST</method>
    <params>
        <fil>n45_kodas_vl='USD'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_N45_LIST",
    "params": {
        "fil": "n45_kodas_vl='USD'"
    }
}
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ą N45_KODAS_VL

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

pvz:

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <N45>
        <Row_number>1</Row_number>
        <N45_KODAS_VL>USD         </N45_KODAS_VL>
        <N45_PAV>JAV doleris                             </N45_PAV>
        <N45_VAL_ID>USD</N45_VAL_ID>
        <N45_CENT_ID>ct          </N45_CENT_ID>
        <N45_BAZE>1.000</N45_BAZE>
        <N45_EURO>0.0000000000</N45_EURO>
        <N45_POZ_DATE>0</N45_POZ_DATE>
        <N45_BEG_DATE>1999-02-06T00:00:00</N45_BEG_DATE>
        <N45_END_DATE>1999-02-06T00:00:00</N45_END_DATE>
        <N45_USERIS>MASTER      </N45_USERIS>
        <N45_R_DATE>2001-10-22T14:43:51</N45_R_DATE>
        <N45_ADDUSR>MASTER      </N45_ADDUSR>
        <N45_ADD_DATE>1999-02-06T14:22:57</N45_ADD_DATE>
    </N45>
</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 'n45_kodasxx_vl'.</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>/v2</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_N45_LIST",
    "params": {
        "fil": "n45_kodas_vl=\'USD\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N45

Valiutų lentelė.

Laukas Tipas Aprašymas Pastabos naudojant EDIT metodus
N45_KODAS_VL C(12) Valiutos kodas
N45_PAV C(40) Valiutos pavadinimas
N45_VAL_ID C(3) Valiutos žymėjimas
N45_CENT_ID C(12) Monetų žymėjimas
N45_BAZE N(10,3) Bazinis valiutos dydis naudojamas konvertavime
N45_EURO N(20,10) Euro koeficientas
N45_POZ_DATE N(1) Terminuotas:0-ne,1-taip
N45_BEG_DATE T(8) Pradžios data
N45_END_DATE T(8) Pabaigos data
N45_USERIS C(12) Kas koregavo
N45_R_DATE T(8) Kada koregavo
N45_ADDUSR C(12) Kas sukūrė
N45_ADD_DATE T(8) Kada sukūrė