GET_PAP_LIST

Aprašymas

Papildomų laukų informacija

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_PAP_LIST
  • params :
    • forma: formos adresas, šį adresą galima sužinoti Rivilėje per papildomų laukų koregavimą. Koreguoti papildomu laukus galima tik prisijungus į Rivilės programą su MASTER vartotoju ir ant papildomų laukų mygtuko paspaudus dešinį pelės klavišą Šablono koregavimas. Pvz.: klientų sąrašo N08 papildomų laukų formos adresas yra KSN08
    • kodas1: raktas pagal kurį žinome, kurio įrašo papildomu laukus grąžinti. Raktų kiekis priklauso nuo formų, gali būti nuo 1 iki 5 raktų. Pvz.: klientų forma turi tik vieną raktą, todėl kodas2, kodas3, kodas4, kodas5 perduoti nereikia
    • kodas2: raktas, privalomas ar ne, priklauso nuo formos raktų kiekio
    • kodas3: raktas, privalomas ar ne, priklauso nuo formos raktų kiekio
    • kodas4: raktas, privalomas ar ne, priklauso nuo formos raktų kiekio
    • kodas5: raktas, privalomas ar ne, priklauso nuo formos raktų kiekio
    • kuris: papildomo lauko numeris. Papildomų laukų gali būti ne vienas, todėl norimą lauką galima pasirinkti pagal numerį arba pavadinimą (pav parametrą)
    • pav: papildomo lauko pavadinimas

pvz application/xml:

<body>
    <method>GET_PAP_LIST</method>
    <params>
        <forma>KSN08</forma>
        <kodas1>121411842</kodas1>
        <kuris>2</kuris>
    </params>
</body>

pvz application/json:

{
    "method": "GET_PAP_LIST",
    "params": {
        "forma": "KSN08",
        "kodas1": "121411842",
        "kuris": 2
    }
}

Prekių kortelių papildomų laukų gavimo atveju reikia nurodyti formos adresą PSN17, raktas taip pat vienas kodas1, jo reikšmė yra prekės kodas. Laukai gaunami pagal pav arba kuris parametrą

Response (status 200 OK)

Grąžinama informacija XML formate tarp tag'ų <RET_DOK>..</RET_DOK>. Jeigu įrašų nerasta pagal užduotas sąlygas, tuomet gražinama status=200 bei tuščias tag'as

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <lpap>
        <forma>KSN08</forma>
        <kodas1>121411842</kodas1>
        <pap>
            <id>2</id>
            <name>Skaitmeninis</name>
            <value>123.5000</value>
            <type>N</type>
            <mask>999999999999.9999</mask>
        </pap>
    </lpap>
</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>21313695680.e367caa0.1591721610094</id>
    <durationMs>5</durationMs>
    <errorMessage>nepavyko įvykdyti metodo</errorMessage>
    <errors>
        <error>
            <data>&lt;PAP>&lt;/PAP></data>
            <dataErrors>
                <dataError>
                    <tag>@forma</tag>
                    <code>19018</code>
                    <message>Nerastas kodas</message>
                </dataError>
            </dataErrors>
        </error>
    </errors>
</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>/v2</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_PAP_LIST",
    "params": {
        "forma": "KSN08",
        "kodas1": "121411842",
        "kuris": 2
    }
}');
$response = curl_exec($ch);
curl_close($ch);