EDIT_I31

Aprašymas

Debitorinių/Kreditorinių operacijų koregavimas (antraštės)

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_I31
params :
- oper :
  - I - naujo įrašo sukūrimas
  - U - įrašo koregavimas
  - D - įrašo ištrynimas
  - P - informacijos perkėlimas
data: perduodami duomenys:
- I31 - atitinkamos lentelės laukai (i31)

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.

Koreguoti galima tik to paties API vartotojo sukurtas operacijas. Teisės valdomos parametru RGI_ALL_EDIT

Yra galimybė dirbti su papildomomis dimensijomis, jeigu tokios naudojamos Rivile GAMA sistemoje. Tam naudojami tag'ai <I49_DIM01> ... <I49_DIM15>

pvz application/xml:

<body>
    <method>EDIT_I31</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
      <I31>
        <I31_RUSIS>1</I31_RUSIS>
        <I31_DOK_NR>DK001</I31_DOK_NR>
        <I31_OP_DATA>2022-07-20</I31_OP_DATA>
      </I31> 
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_I31",
    "params": {
        "errorAction": "CONTINUE"
    },
    "data": {
        "I31": {
            "I31_RUSIS": 1,
            "I31_DOK_NR": "DK001",
            "I31_OP_DATA": "2022-07-20"
        }
    }
}

Response (status 200 OK)

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

pvz:

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <i31>
        <I31_KODAS_KR>000R00000004</I31_KODAS_KR>
        <I31_RUSIS>1</I31_RUSIS>
        <I31_DOK_NR>DK001       </I31_DOK_NR>
        <I31_OP_DATA>2022-07-20T00:00:00</I31_OP_DATA>
        <I31_PASTABOS>                                       </I31_PASTABOS>
        <I31_PERKELTA>1</I31_PERKELTA>
        <I31_USERIS>XXAW2VW     </I31_USERIS>
        <I31_R_DATE>2022-07-20T00:00:00</I31_R_DATE>
        <I31_ADDUSR>XXAW2VW     </I31_ADDUSR>
        <I31_KODAS_SM>           </I31_KODAS_SM>
        <I31_KODAS>           </I31_KODAS>
        <I31_KODAS_LS_1>           </I31_KODAS_LS_1>
        <I31_KODAS_LS_2>           </I31_KODAS_LS_2>
        <I31_KODAS_LS_3>           </I31_KODAS_LS_3>
        <I31_KODAS_LS_4>           </I31_KODAS_LS_4>
        <I31_KODAS_ZN>           </I31_KODAS_ZN>
    </i31>
</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>615386280.9d658372.1658326542237</id>
    <durationMs>0</durationMs>
    <errorMessage>For input string: "a1"</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>/v2</path>
</Map>

Koregavimas, perkėlimas ir trynimas

Koregavimas, trynimas vyksta pagal lentelės raktą (Primary Key)

Koreguojant informaciją bus koreguojami tik perduodami laukai.

pvz koregavimas:

<body>
    <method>EDIT_I31</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
      <I31>
        <I31_KODAS_KR>000R00000006</I31_KODAS_KR>
        <I31_DOK_NR>DK005</I31_DOK_NR>
      </I31>   
    </data>
</body>

pvz trynimas:

<body>
    <method>EDIT_I31</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <I31>
            <I31_KODAS_KR>000R00000007</I31_KODAS_KR>
        </I31>      
    </data>
</body>

pvz perkėlimas:

<body>
    <method>EDIT_I31</method>
    <params>
        <oper>P</oper>
    </params>
    <data>
        <I31>
            <I31_KODAS_KR>000R00000006</I31_KODAS_KR>
        </I31>      
    </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/xml',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I31

Nuoroda į lentelės aprašymą: I31