EDIT_I53

Aprašymas

Mokėjimo operacijų 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_I53
params :
- oper :
  - I - naujo įrašo sukūrimas
  - U - įrašo koregavimas
  - D - įrašo išmetimas
data: perduodami duomenys:
- I53 - atitinkamos lentelės laukai (i53)

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_I53</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <I53>
            <I53_OP_RUSIS>1</I53_OP_RUSIS>
            <I53_DOK_NR>RIV01</I53_DOK_NR>
            <I53_KODAS_KS>123456789</I53_KODAS_KS>
            <I53_SUMA>100</I53_SUMA>
        </I53>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_I53",
    "params": {
        "oper": "I"
    },
    "data": {
        "I53": {
            "I53_OP_RUSIS": 1,
            "I53_DOK_NR":"RIV01",
            "I53_KODAS_KS": "123456789",
            "I53_SUMA": 100
        }
    }
}

Response (status 200 OK)

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

pvz:

<?xml version='1.0'?>
<RET_DOK>
    <I53>
        <I53_KODAS_OI>010R00000002</I53_KODAS_OI>
        <I53_OP_RUSIS>1</I53_OP_RUSIS>
        <I53_PAV>                                                           </I53_PAV>
        <I53_DOK_NR>RIV01               </I53_DOK_NR>
        <I53_DATA>2021-05-03T00:00:00</I53_DATA>
        <I53_KODAS_KS>123456789   </I53_KODAS_KS>
        <I53_KODAS_SS>           </I53_KODAS_SS>
        <I53_KODAS_VL>           </I53_KODAS_VL>
        <I53_SUMA>100.00</I53_SUMA>
        <I53_MOKETOJAS>1</I53_MOKETOJAS>
        ...
    </I53>
</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>14433105830.9def1bf4.1584217427751</id>
    <durationMs>45</durationMs>
    <errorMessage>nepavyko įvykdyti metodo</errorMessage>
    <errors>
        <error>
            <data>&lt;I64>&lt;/I64></data>
            <dataErrors>
                <dataError>
                    <tag>I53_DATA</tag>
                    <code>16004</code>
                    <message>Neprieinamas periodas</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_I53</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <I53>
            <I53_KODAS_OI>010R00000002</I53_KODAS_OI>
            <I53_DOK_NR>RIV01/1</I53_DOK_NR>
        </I53>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_I53</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <I53>
            <I53_KODAS_OI>010R00000002</I53_KODAS_OI>
        </I53>
    </data>
</body>

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, $body);
$response = curl_exec($ch);
curl_close($ch);