Back to Gidas

GET_N18_LIST

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

latest4.2 KB
Original Source

PDF

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

GET_N18_LIST

Aprašymas

Mato vienetų sąrašas

Specifikacija

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

Body
  • method : GET_N18_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N18 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_N18_LIST</method>
    <params>
        <fil>n18_kodas_us='KG'</fil>
    </params>
</body>

pvz application/json:

json
{
    "method": "GET_N18_LIST",
    "params": {
        "fil": "n18_kodas_us='KG'"
    }
}
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ą N18_KODAS_US

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

pvz :

xml
<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <N18>
        <Row_number>1</Row_number>
        <N18_KODAS_US>KG </N18_KODAS_US>
        <N18_FRAKCIJA>1000</N18_FRAKCIJA>
        <N18_M_VNT_U1> </N18_M_VNT_U1>
        <N18_M_VNT_U2> </N18_M_VNT_U2>
        <N18_ADDUSR>MASTER </N18_ADDUSR>
        <N18_POZ_DATE>0</N18_POZ_DATE>
        <N18_BEG_DATE>1999-02-06T00:00:00</N18_BEG_DATE>
        <N18_END_DATE>1999-02-06T00:00:00</N18_END_DATE>
        <N18_R_DATE>1999-02-06T15:08:31</N18_R_DATE>
        <N18_USERIS>MASTER </N18_USERIS>
        <N18_ADD_DATE>1999-02-06T15:08:22</N18_ADD_DATE>
        <N18_PAV_K1> </N18_PAV_K1>
        <N18_PAV_K2> </N18_PAV_K2>
        <N18_PAV_K3> </N18_PAV_K3>
        <n18_vsi> </n18_vsi>
    </N18>
</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 'n18_kodasxx_us'.</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_N18_LIST",
    "params": {
        "fil": "n18_kodas_us=\'KG\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N18

Mato vienetų lentelė.

LaukasTipasAprašymasPastabos naudojant EDIT metodus
N18_KODAS_USC(12)Matavimo vieneto kodas
N18_FRAKCIJAN(4)Matavimo vieneto frakcija
N18_M_VNT_U1C(12)Matavimo vienetas kita kalba 1
N18_M_VNT_U2C(12)Matavimo vienetas kita kalba 2
N18_ADDUSRC(12)Kas sukūrė
N18_POZ_DATEN(1)Terminuotas:0-ne,1-taip
N18_BEG_DATET(8)Pradžios data
N18_END_DATET(8)Pabaigos data
N18_R_DATET(8)Koregavimo laikas
N18_USERISC(12)Kas koregavo
N18_ADD_DATET(8)Kada sukūrė
N18_PAV_K1C(100)Pavadinimas kita kalba 1
N18_PAV_K2C(100)Pavadinimas kita kalba 2
N18_PAV_K3C(100)Pavadinimas kita kalba 3
N18_VSIC(20)Matavimas VŠĮ sistemoje