Back to Gidas

GET_I64_LIST

internetiniai-underscore-moduliai-api-underscore-rest-get-underscore-i64-underscore-list.md

latest2.9 KB
Original Source

PDF

Pradžia Internetiniai moduliai Rivile API v2 (REST web servisai) GET_I64_LIST

GET_I64_LIST

Aprašymas

Lojalumo taškų sąrašas

Specifikacija

Informacija apie autorizaciją, bendruosius parametrus ir klaidų kodus: Rivile API v2 naudojimo pagrindai

Body
  • method : GET_I64_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės I64 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:

xml
<body>
    <method>GET_I64_LIST</method>
    <params>
        <fil>i64_kodas_dl='000000000001'</fil>
    </params>
</body>

pvz application/json:

json
{
    "method": "GET_I64_LIST",
    "params": {
        "fil": "i64_kodas_dl='000000000001'"
    }
}
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ą I64_KODAS_DL

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

pvz :

xml
<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <I64>
        <Row_number>1</Row_number>
        <i64_KODAS_DL>000000000001</i64_KODAS_DL>
        <I64_TASKAI>150</I64_TASKAI>
    </I64>
</RET_DOK>
Response (status 400)

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

xml
<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id>3451ded.be556121580910178112</id>
    <durationMs>25</durationMs>
    <errorMessage>Invalid column name 'i64_kodas_dll'.</errorMessage>
</RET_DOK>

PHP pvz

php
<?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_I64_LIST",
    "params": {
        "fil": "i64_kodas_dl=\'000000000001\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I64

Nuoroda į lentelės aprašymą: I64