EDIT_N18

Aprašymas

Matavimo vienetų koregavimas.

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 : EDIT_N18
params :
- oper :
  - I - naujo įrašo sukūrimas
  - U - įrašo koregavimas
  - D - įrašo ištrynimas
data: perduodami duomenys:
- N18 - atitinkamos lentelės laukai (N18)

Vienu metu veiksmai atliekami tik su vienu įrašu.

Pirmi 7 ApiKey simboliai (pvz USERABC.JQKPG1d7Pkjxj37ObsgdfEkvfEfvF1oL7h7UMOLo -> USERABC) yra vartotojo vardas Rivile GAMA programoje, kuriuo bus kuriami ar koreguojami įrašai.

pvz application/xml:

<body>
    <method>EDIT_N18</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N18>
            <N18_KODAS_US>CNT</N18_KODAS_US>
            <N18_FRAKCIJA>10</N18_FRAKCIJA>
        </N18>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N18",
    "params": {
        "oper": "I"
    },
    "data": {
        "N18": {
            "N18_KODAS_US": "CNT",
            "N18_FRAKCIJA": 10
        }
    }
}

Response (status 200 OK)

Grąžinama informacija XML formate tarp tag'ų <RET_DOK>..</RET_DOK>.

pvz:

<RET_DOK>
    <N18>
        <N18_KODAS_US>CNT         </N18_KODAS_US>
        <N18_FRAKCIJA>10</N18_FRAKCIJA>
        <N18_M_VNT_U1>           </N18_M_VNT_U1>
        <N18_M_VNT_U2>           </N18_M_VNT_U2>
        <N18_ADDUSR>WS          </N18_ADDUSR>
        <N18_POZ_DATE>0</N18_POZ_DATE>
        <N18_BEG_DATE>2025-05-27T11:10:07</N18_BEG_DATE>
        <N18_END_DATE>2025-05-27T11:10:07</N18_END_DATE>
        <N18_R_DATE>2025-05-27T11:10:07</N18_R_DATE>
        <N18_USERIS>1234567     </N18_USERIS>
        <N18_ADD_DATE>2025-05-27T11:10:07</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 version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id>4641133481.8ec4537a.1716271246499</id>
    <durationMs>569</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data>&lt;N18>&lt;/N18></data>
            <dataErrors>
                <dataError>
                    <tag>N18_KODAS_US</tag>
                    <code>5009</code>
                    <message>Kodas nerastas</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>

Koregavimas ir išmetimas

Koregavimas, išmetimas vyksta pagal lentelės raktą (Primary Key)

Koreguojant informaciją bus koreguojami tik perduodami laukai.

pvz koregavimas:

<body>
    <method>EDIT_N18</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N18>
            <N18_KODAS_US>CNT</N18_KODAS_US>
            <N18_PAV_K1>koreguota</N18_PAV_K1>
        </N18>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_N18</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N18>
            <N18_KODAS_US>CNT</N18_KODAS_US>
        </N18>
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: 9999999.12345678910',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
        "method": "EDIT_N18",
        "params": {
            "oper": "I"
        },
        "data": {
            "N18": {
                "N18_KODAS_US": "CNT",
                "N18_PAV_K1": "Pavadinimas"
            }
    }
    }');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N18

Matavimo vieneto informacija

Laukas	Tipas	Aprašymas
N18_KODAS_US	char(12)	Matavimo vieneto kodas
N18_FRAKCIJA	numeric(4,0)	Matavimo vieneto frakcija
N18_M_VNT_U1	char(12)	Matavimo vienetas kita kalba 1
N18_M_VNT_U2	char(12)	Matavimo vienetas kita kalba 2
N18_ADDUSR	char(12)	Kas sukūrė
N18_POZ_DATE	numeric(1,0)	Terminuotas:0-ne,1-taip
N18_BEG_DATE	datetime	Pradžios data
N18_END_DATE	datetime	Pabaigos data
N18_R_DATE	datetime	Koregavimo laikas
N18_USERIS	char(12)	Kas koregavo
N18_ADD_DATE	datetime	Kada sukūrė
N18_PAV_K1	varchar(100)	Pavadinimas kita kalba 1
N18_PAV_K2	varchar(100)	Pavadinimas kita kalba 2
N18_PAV_K3	varchar(100)	Pavadinimas kita kalba 3
N18_VSI	varchar(20)	Matavimas VŠĮ sistemoje