Back to Gidas

GET_N09_LIST

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

latest3.8 KB
Original Source

PDF

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

GET_N09_LIST

Aprašymas

Vietovių sąrašas

Specifikacija

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

Body
  • method : GET_N09_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N09 nenurodant pačio where tag'o. Neprivaloma
    • pageNumber : puslapio numeris. GET_LIST metodai rezultatus grąžina puslapiais po 100 įrašų, pageNumber parametras nurodo kelintą puslapį grąžinti. Pagal nutylėjimą grąžinamas pirmas puslapis.

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_N09_LIST</method>
    <params>
        <fil>n09_kodas_vs='01'</fil>
        <pageNumber>2</pageNumber>
    </params>
</body>

pvz application/json:

json
{
    "method": "GET_N09_LIST",
    "params": {
        "fil": "n09_kodas_vs='01'",
        "pageNumber": 2
    }
}
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ą N09_KODAS_VS

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>
    <N09>
        <Row_number>1</Row_number>
        <N09_KODAS_VS>01</N09_KODAS_VS>
        <N09_LYGIS>1</N09_LYGIS>
        <N09_TIPAS>2</N09_TIPAS>
        <N09_TEVAS></N09_TEVAS>
        <N09_UZS_LAIKAS>0</N09_UZS_LAIKAS>
        <N09_VEZ_LAIKAS>0</N09_VEZ_LAIKAS>
        <N09_PAP_LAIKAS>0</N09_PAP_LAIKAS>
    </N09>
</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 'n09_kodasxx_ks'.</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_N09_LIST",
    "params": {
        "fil": "n09_kodas_vs=\'1214\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N09

Vietovių informacija.

LaukasTipasAprašymasPastabos
N09_KODAS_VSC(12)Vietovės kodas
N09_PAVC(40)Pavadinimas
N09_LYGISN(3)Lygis
N09_TIPASN(1)Tipas:2-detalus,1-suminis
N09_TEVASC(12)Aukštesnio lygio vietovės kodas
N09_UZS_LAIKASN(4)Užsakymo laikas
N09_VEZ_LAIKASN(4)Vežimo laikas
N09_PAP_LAIKASN(4)Papildomas laikas
N09_POZ_DATEN(1)Terminuotas:0-ne,1-taip
N09_BEG_DATET(8)Pradžios data
N09_END_DATET(8)Pabaigos data
N09_ADDUSRC(12)Kas sukūrė
N09_USERISC(12)Kas koregavo
N09_R_DATET(8)Kada koregavo
N09_KODAS_VLC(12)Valiutos kodas
N09_SUMA_KOMN(18,2)Dienpinigių norma valiuta
N09_KITASC(40)Vietovės kodas kitose sistemose
N09_KODAS_LS_KC(12)Kryptis