GET_N72_LIST

Aprašymas

Automobilių 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_N72_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N72 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:

<body>
    <method>GET_N72_LIST</method>
    <params>
        <fil>n72_kodas_au='AUTO'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_N72_LIST",
    "params": {
        "fil": "n72_kodas_au='AUTO'"
    }
}
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ą N72_KODAS_AU

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>
    <N72>
        <Row_number>1</Row_number>
        <N72_KODAS_AU>AUTO        </N72_KODAS_AU>
        <N72_VAL_NR>HAZ325          </N72_VAL_NR>
        <N72_PAV>MAN                                                         </N72_PAV>
        <N72_KODAS_IS>           </N72_KODAS_IS>
        <N72_KODAS_GS>           </N72_KODAS_GS>
        <N72_GARAZAS>           </N72_GARAZAS>
        <N72_PRIKL>1</N72_PRIKL>
        <N72_KODAS_MS>           </N72_KODAS_MS>
        <N72_KODAS_PP>           </N72_KODAS_PP>
        <N72_AMOR_KM>0.00</N72_AMOR_KM>
        <N72_AMOR_1H>0.00</N72_AMOR_1H>
        <N72_VERTE>0.00</N72_VERTE>
        <N72_AUKSTIS>0.00</N72_AUKSTIS>
        <N72_ILGIS>0.00</N72_ILGIS>
        <N72_PLOTIS>0.00</N72_PLOTIS>
        <N72_SVORIS>0.000</N72_SVORIS>
        <N72_PASTABOS></N72_PASTABOS>
        <N72_POZ_DATE>0</N72_POZ_DATE>
        <N72_BEG_DATE>2020-01-17T00:00:00</N72_BEG_DATE>
        <N72_END_DATE>2020-01-17T00:00:00</N72_END_DATE>
        <N72_USERIS>MASTER      </N72_USERIS>
        <N72_R_DATE>2020-01-17T09:54:16</N72_R_DATE>
        <N72_ADDUSR>MASTER      </N72_ADDUSR>
        <N72_PG_DATA>2020-01-17T00:00:00</N72_PG_DATA>
        <N72_SPALVA>                             </N72_SPALVA>
        <N72_VAR_NR>                             </N72_VAR_NR>
        <N72_VAZ_NR>                             </N72_VAZ_NR>
        <N72_KEB_NR>                             </N72_KEB_NR>
        <N72_MASE>0</N72_MASE>
        <N72_KODAS_KS>           </N72_KODAS_KS>
        <N72_TURIS>0.00</N72_TURIS>
        <N72_KODAS_LS_1>           </N72_KODAS_LS_1>
        <N72_KODAS_LS_2>           </N72_KODAS_LS_2>
        <N72_KODAS_LS_3>           </N72_KODAS_LS_3>
        <N72_KODAS_LS_4>           </N72_KODAS_LS_4>
        <N72_RUSIS>1</N72_RUSIS>
        <N72_AUT_TIPAS1>1</N72_AUT_TIPAS1>
        <N72_AUT_TIPAS2>1</N72_AUT_TIPAS2>
        <N72_KODAS_SM>           </N72_KODAS_SM>
        <N72_TIR>0</N72_TIR>
        <N72_CEMT>0</N72_CEMT>
        <N72_ADR>0</N72_ADR>
        <N72_ORO_PAG>0</N72_ORO_PAG>
    </N72>
</RET_DOK>
Response (status 400)

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

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id>3451ded.be556121580910178112</id>
    <durationMs>25</durationMs>
    <errorMessage>Invalid column name 'n72_kodas_psb'.</errorMessage>
</RET_DOK>
Response (status 401)

Blogai nurodytas adresas / neteisingai nurodytas API raktas / nenurodytas API raktas / pasibaigęs API rakto galiojimas, 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 502)

Nepaleistas MANO Rivile Gateway arba kitaip sutrikusi jo veikla

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>0</durationMs>
    <errorMessage>Rivile GAMA database is unavailable. Please check if the gateway is running and is set up correctly.</errorMessage>
</RET_DOK>
Response (status 504)

Laiku nebuvo gautas Rivile API užklausos atsakymas, pavyzdžiui, apkrauta GAMA duomenų bazė

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>0</durationMs>
    <errorMessage>No response received from client gateway</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_N72_LIST",
    "params": {
        "fil": "n72_kodas_au=\'AUTO\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N72

Automobilių lentelės aprašymas

Laukas Tipas Aprašymas Pastabos
N72_KODAS_AU C(12) Automobilio kodas
N72_VAL_NR C(16) Automobilio valstybinis numeris
N72_PAV C(60) Aprašymas
N72_KODAS_IS C(12) Padalinys į kurį bus pilamas kuras (Resursas-automobilio bakas)
N72_KODAS_GS C(12) Automobilių grupė
N72_GARAZAS C(12) Garažo Nr.
N72_PRIKL N(1) Automobilio priklausomybe:1-firmos;2-kito juridinio asmens;3-kito fizinio asmens
N72_KODAS_MS C(12) Vairuotojo kodas
N72_KODAS_PP C(12) Inventorinis numeris pagrindinėse priemonėse
N72_AMOR_KM N(6,2) Amortizacinė norma 1000 km.
N72_AMOR_1H N(6,2) Amortizacinė norma nuo laiko
N72_VERTE N(12,2) Mašinos vertė
N72_AUKSTIS N(6,2) Krovinio max aukštis
N72_ILGIS N(6,2) Krovinio maksimalus ilgis
N72_PLOTIS N(6,2) Krovinio max plotis
N72_SVORIS N(8,3) Krovinio maksimalus svoris
N72_PASTABOS M(4) Pastabos
N72_POZ_DATE N(1) Galiojimo požymis
N72_BEG_DATE T(8) Galiojimo pradžios data
N72_END_DATE T(8) Galiojimo pabaigos data
N72_USERIS C(12) Kas koregavo
N72_R_DATE T(8) Kada koregavo
N72_ADDUSR C(12) Kas sukūrė
N72_PG_DATA T(8) Pagaminimo data
N72_SPALVA C(30) Spalva
N72_VAR_NR C(30) Variklio numeris
N72_VAZ_NR C(30) Važiuoklės numeris
N72_KEB_NR C(30) Kėbulo numeris
N72_MASE N(6) Masė Kg
N72_KODAS_KS C(12) Klientas
N72_TURIS N(6,2) Tūris
N72_KODAS_LS_1 C(12) Pirmas logistikos kodas
N72_KODAS_LS_2 C(12) Antras logistikos kodas
N72_KODAS_LS_3 C(12) Trečias logistikos kodas
N72_KODAS_LS_4 C(12) Ketvirtas logistikos kodas
N72_RUSIS N(2) A/m rūšis
N72_AUT_TIPAS1 N(2) A/m tipas 1
N72_AUT_TIPAS2 N(2) A/m tipas 2
N72_KODAS_SM C(12) Asmuo
N72_TIR N(1) TIR
N72_CEMT N(1) CEMT
N72_ADR N(1) ADR
N72_ORO_PAG N(1) Oro pagalvės