GET_N09_LIST

Aprašymas

Vietovių sąrašas

Specifikacija

Address

POST https://api.manorivile.lt/client/v2

Header
  • ApiKey : Privalomas. Unikalus API raktas išduodamas užsakant paslaugą
  • Content-Type : Privalomas. Kokiu formatu paduodami parametrai ir duomenys (request):
    • application/xml
    • application/json
  • Accept: Neprivalomas. Gražinamo rezultato (response) formatas
    • application/xml(default)
    • application/json (veikia nuo Manorivile-Gateway-1.1.0 versijos)
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ą „porcijomis“ per kelis kartus, filtruojant pagal paskutinio gauto įrašo rakto reikšmę.

pvz application/xml:

<body>
    <method>GET_N09_LIST</method>
    <params>
        <fil>n09_kodas_vs='01'</fil>
        <pageNumber>2</pageNumber>
    </params>
</body>

pvz application/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 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

<RET_DOK type="error">
    <id>2552c6d.dd81a1c1580324646507</id>
    <durationMs>53</durationMs>
    <errorMessage>Invalid column name 'n09_kodasxx_ks'.</errorMessage>
</RET_DOK>
Response (status 401)

Blogai nurodytas adresas / neteisingai nurodytas API raktas / nenurodytas API raktas / pasibaigęs API rakto galiojimas / API raktas neturi teisių vykdyti šį metodą, pvz

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>0</durationMs>
    <errorMessage>Api key is not valid</errorMessage>
</RET_DOK>
Response (status 500)

Bendrinė sistemos klaida, pvz

<?xml version='1.0' encoding='UTF-8'?>
<Map>
    <timestamp>2020-02-05T12:34:26.890+0000</timestamp>
    <status>500</status>
    <error>Internal Server Error</error>
    <message>No message available</message>
    <path>/v1</path>
</Map>

PHP pvz

<?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.

Laukas Tipas Aprašymas Pastabos
N09_KODAS_VS C(12) Vietovės kodas
N09_PAV C(40) Pavadinimas
N09_LYGIS N(3) Lygis
N09_TIPAS N(1) Tipas:2-detalus,1-suminis
N09_TEVAS C(12) Aukštesnio lygio vietovės kodas
N09_UZS_LAIKAS N(4) Užsakymo laikas
N09_VEZ_LAIKAS N(4) Vežimo laikas
N09_PAP_LAIKAS N(4) Papildomas laikas
N09_POZ_DATE N(1) Terminuotas:0-ne,1-taip
N09_BEG_DATE T(8) Pradžios data
N09_END_DATE T(8) Pabaigos data
N09_ADDUSR C(12) Kas sukūrė
N09_USERIS C(12) Kas koregavo
N09_R_DATE T(8) Kada koregavo
N09_KODAS_VL C(12) Valiutos kodas
N09_SUMA_KOM N(18,2) Dienpinigių norma valiuta
N09_KITAS C(40) Vietovės kodas kitose sistemose
N09_KODAS_LS_K C(12) Kryptis