Back to Gidas

GET_N63_LIST

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

latest3.8 KB
Original Source

PDF

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

GET_N63_LIST

Aprašymas

PVM klasifikatorių sąrašas

Specifikacija

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

Body
  • method : GET_N63_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N63 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 į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ų rezultatas apribojimas 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_N63_LIST</method>
    <params>
        <fil>n63_kodas_kl='PVM1'</fil>
    </params>
</body>

pvz application/json:

json
{
    "method": "GET_N63_LIST",
    "params": {
        "fil": "n63_kodas_Kl='PVM1'"
    }
}
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ą N63_KODAS_KL

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>
    <N63>
        <Row_number>1</Row_number>
        <N63_KODAS_KL>PVM1 </N63_KODAS_KL>
        <N63_PAV> </N63_PAV>
        <N63_KLASI>PVM1 </N63_KLASI>
        <N63_POZ_DATE>0</N63_POZ_DATE>
        <N63_BEG_DATE>2019-10-23T00:00:00</N63_BEG_DATE>
        <N63_END_DATE>2019-10-23T00:00:00</N63_END_DATE>
        <N63_ADDUSR>MASTER </N63_ADDUSR>
        <N63_ADD_DATE>2019-10-23T15:37:39</N63_ADD_DATE>
        <N63_USERIS>MASTER </N63_USERIS>
        <N63_R_DATE>2019-10-23T15:37:55</N63_R_DATE>
    </N63>
</RET_DOK>
Response (status 400)

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

xml
<RET_DOK type="error">
    <id>2552c6d.dd81a1c1580324646507</id>
    <durationMs>53</durationMs>
    <errorMessage>Invalid column name 'n63_kodasxx_kl'.</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_N63_LIST",
    "params": {
        "fil": "n63_kodas_kl=\'PVM1\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N63

PVM klasifaktorių lentelė.

LaukasTipasAprašymasPastabos
N63_KODAS_KLC(12)Kodas
N63_PAVC(150)Pavadinimas
N63_KLASIC(12)PVM klasifikatorius
N63_APRASYMAS1C(250)Aprašymas 1
N63_APRASYMAS2C(250)Aprašymas 2
N63_APRASYMAS3C(250)Aprašymas 3
N63_POZ_DATEN(1)Terminuota
N63_BEG_DATET(8)Pradžios data
N63_END_DATET(8)Pabaigos data
N63_ADDUSRC(12)Kas sukūrė
N63_ADD_DATET(8)Kada sukūrė
N63_USERISC(12)Kas koregavo
N63_R_DATET(8)Kada koregavo