EDIT_I51

Aprašymas

Kaupiklio operacijos 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_I51
params :
- oper :
  - I - naujo įrašo sukūrimas (numatytasis)
  - U - įrašo koregavimas
  - D - įrašo ištrynimas
- user : vartotojo vardas (naudojamas dokumentų skaitliukams, parametrams ir kt.), veikia tik rakto prefix'ui įjungus parametrą RGI_USR_EDIT
data: perduodami duomenys:
- I51 - atitinkamos lentelės laukai (i51)

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

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

XML request

<body>
    <method>EDIT_I51</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <I51>
            <I51_LAIKAS>2024-01-01</I51_LAIKAS>
            <I51_PAV>Kaupiklis 1</I51_PAV>
        </I51>    
    </data>
</body>

JSON request

{
    "method": "EDIT_I51",
    "params": {
        "oper": "I"
    },
    "data": {
        "I51": {
            "I51_LAIKAS": "2024-01-01",
            "I51_PAV": "Kaupiklis 1"
        }
    }
}

Response (status 200 OK)

XML response

<RET_DOK>
    <I51>
        <I51_KODAS_KP>010R00000001</I51_KODAS_KP>
        <I51_KODAS_KK></I51_KODAS_KK>
        <I51_LAIKAS>2024-01-01T00:00:00</I51_LAIKAS>
        <I51_PAV>Kaupiklis 1</I51_PAV>
        <I51_PERKELTA>1</I51_PERKELTA>
        <I51_USERIS>WS</I51_USERIS>
        <I51_R_DATE>2024-01-01T00:00:01</I51_R_DATE>
        <I51_ADDUSR>WS</I51_ADDUSR>
        <I51_KODAS_SM></I51_KODAS_SM>
        <i51_busena>1</i51_busena>
    </I51>
</RET_DOK>

JSON response

{
    "I51": {
        "I51_KODAS_KP": "010R00000001",
        "I51_KODAS_KK": "",
        "I51_LAIKAS": "2024-01-01T00:00:00",
        "I51_PAV": "Kaupiklis 1",
        "I51_PERKELTA": 1,
        "I51_USERIS": "WS",
        "I51_R_DATE": "2024-01-01T00:00:01",
        "I51_ADDUSR": "WS",
        "I51_KODAS_SM": "",
        "i51_busena": 1
    }
}

Response (status 400)

Klaida paduodant duomenis / SQL sintaksės klaidos / kitos duomenų klaidos

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>0</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data></data>
            <dataErrors>
                <dataError>
                    <tag>I51_KODAS_KK</tag>
                    <code>552190</code>
                    <message>Nerastas įrenginys A1</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>2024-01-01T00:00:01.001+0000</timestamp>
    <status>500</status>
    <error>Internal Server Error</error>
    <message>No message available</message>
    <path>/v2</path>
</Map>

Koregavimas, trynimas ir perkėlimas

Koregavimas, trynimas ir perkėlimas vyksta pagal atitinkamos lentelės raktą (Primary Key)

Koreguojant informaciją bus koreguojami tik perduodami laukai.

pvz koregavimas:

<body>
    <method>EDIT_I51</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <I51>
            <I51_KODAS_KP>010R00000001</I51_KODAS_KP>
            <I51_PAV>Koreguota</I51_PAV>
        </I51>    
    </data>
</body>

pvz trynimas:

<body>
    <method>EDIT_I51</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <I51>
            <I51_KODAS_KP>010R00000001</I51_KODAS_KP>
        </I51>
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: uUCz7UY.sKVrjaWRDJAH1c7l4qL322nn2K0jARkkkHDdYTss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "EDIT_I51",
    "params": {
        "oper": "I"
    },
    "data": {
        "I51": {
            "I51_LAIKAS": "2024-01-01",
            "I51_PAV": "Kaupiklis 1"
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I51

Kaupiklio operacijų antraštės lentelė

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
I51_KODAS_KP	C(12)	Operacijos numeris	Privalomas , kai oper=U,D
I51_KODAS_KK	C(12)	Kaupiklio numeris
I51_LAIKAS	T(8)	Koregavimo laikas
I51_PAV	C(40)	Aprašymas
I51_PERKELTA	N(1)	Perkėlimo požymis 1-nauja,2-perkelta, 3-koreguota
I51_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I51_R_DATE	T(8)	Koregavimo data	Neperduodamas. Pildomas automatiškai, Current Datetime
I51_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I51_KODAS_SM	C(12)	Asmuo
I51_BUSENA	N(3)	Būsena