Back to Gidas

GET_N16_LIST

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

latest4.2 KB
Original Source

PDF

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

GET_N16_LIST

Aprašymas

Sąskaitų ryšių sąrašas

Specifikacija

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

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

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_N16_LIST</method>
    <params>
        <fil> N16_KODAS_DS = 'PR001' </fil>
    </params>
</body>

pvz application/json:

json
{
    "method": "GET_N16_LIST",
    "params": {
        "fil": "N16_KODAS_DS = 'PR001'"
    }
}
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ą N16_KODAS_DS

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

xml
<RET_DOK>
    <N16>
      <Row_number>1</Row_number>
      <N16_KODAS_DS>PR001 </N16_KODAS_DS>
      <N16_PAV>Prekių sąskaitų ryšys </N16_PAV>
      <N16_RUSIS>1</N16_RUSIS>
      <N16_KODAS_SS1>2040 </N16_KODAS_SS1>
      <N16_KODAS_SS2>6000 </N16_KODAS_SS2>
      <N16_KODAS_SS3>5000 </N16_KODAS_SS3>
      <N16_KODAS_SS4>509 </N16_KODAS_SS4>
      <N16_KODAS_SS5>6002 </N16_KODAS_SS5>
      <N16_KODAS_SS6>5001 </N16_KODAS_SS6>
      <N16_KODAS_SS7>6001 </N16_KODAS_SS7>
      <N16_KODAS_SS8>4493 </N16_KODAS_SS8>
      <N16_KODAS_SS9>4493 </N16_KODAS_SS9>
      <N16_KODAS_SS10>6000 </N16_KODAS_SS10>
      <N16_KODAS_SS11>2049 </N16_KODAS_SS11>
      <N16_KODAS_SS12>6000 </N16_KODAS_SS12>
      <N16_KODAS_SS13>291 </N16_KODAS_SS13>
      <N16_KODAS_SS14>2045 </N16_KODAS_SS14>
      <N16_KODAS_SS15>2441 </N16_KODAS_SS15>
      <N16_KODAS_SS16>272 </N16_KODAS_SS16>
      <N16_KODAS_SS17>6004 </N16_KODAS_SS17>
      <N16_KODAS_SS18>4493 </N16_KODAS_SS18>
      <N16_KODAS_SS19>4493 </N16_KODAS_SS19>
      <N16_KODAS_SS20>509 </N16_KODAS_SS20>
      <N16_KODAS_SS21> </N16_KODAS_SS21>
      <N16_KODAS_SS22> </N16_KODAS_SS22>
      <N16_KODAS_SS23> </N16_KODAS_SS23>
      <N16_KODAS_SS24> </N16_KODAS_SS24>
      <N16_KODAS_SS25> </N16_KODAS_SS25>
      <N16_POZ_DATE>0</N16_POZ_DATE>
      <N16_BEG_DATE>1999-02-06T00:00:00</N16_BEG_DATE>
      <N16_END_DATE>1999-02-06T00:00:00</N16_END_DATE>
      <N16_USERIS>MASTER </N16_USERIS>
      <N16_R_DATE>2025-08-08T11:51:40</N16_R_DATE>
      <N16_ADDUSR>MASTER </N16_ADDUSR>
      <N16_ADD_DATE>1999-02-06T14:24:55</N16_ADD_DATE>
      <N16_SK1>2.000</N16_SK1>
      <N16_SK2>2.000</N16_SK2>
      <N16_SK3>0.000</N16_SK3>
      <N16_SK4>0.000</N16_SK4>
      <N16_SK5>0.000</N16_SK5>
      <N16_KODAS_SS26> </N16_KODAS_SS26>
      <N16_KODAS_SS27> </N16_KODAS_SS27>
      <N16_KODAS_SS28> </N16_KODAS_SS28>
    </N16>
</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>4641133481.3d11c2a9.1773136925474</id>
    <durationMs>3</durationMs>
    <errorMessage>Invalid column name 'fake_col'.</errorMessage>
</RET_DOK>

PHP pvz

php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: ABCDEFG.ABCDEFG',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "GET_N16_LIST",
    "params": {
        "fil": "N16_KODAS_DS = 'PR001'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);