EDIT_I13

Aprašymas

Pirkimų,pardavimų dokumento apmokėjimo 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_I13
params :
- oper :
  - I - naujo įrašo sukūrimas
  - U - įrašo koregavimas
  - D - įrašo ištrynimas
data: perduodami duomenys:
- I13 - atitinkamos lentelės laukai (i13)

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

pvz application/xml:

<body>
    <method>EDIT_I13</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
      <I13>
        <I13_KODAS_PO>010R00001041</I13_KODAS_PO>
        <I13_KODAS_SS>2703</I13_KODAS_SS>
        <I13_SUMA>19.62</I13_SUMA>
      </I13> 
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_I13",
    "params": {
        "oper": "I"
    },
    "data": {
        "I13": {
            "I13_KODAS_PO": "010R00001041",
            "I13_KODAS_SS": "2703",
            "I13_SUMA":19.62
        }
    }
}

Response (status 200 OK)

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

pvz:

<?xml version='1.0'?>
<RET_DOK>
    <I13>
         <I13_KODAS_PO>010R00001041</I13_KODAS_PO>
         <I13_EIL_NR>1</I13_EIL_NR>
         <I13_KODAS_SS>2703 </I13_KODAS_SS>
         <I13_SUMA>19.62</I13_SUMA>
         <I13_SUMA_VAL>.00</I13_SUMA_VAL>
         <I13_PAV> </I13_PAV>
         <I13_ADDUSR>3 </I13_ADDUSR>
         <I13_USERIS>3 </I13_USERIS>
         <I13_R_DATE>2019-10-29 15:07:12.000</I13_R_DATE>
     </I13>
</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;I13>&lt;/I13></data>
            <dataErrors>
                <dataError>
                    <tag>I13_KODAS_PO</tag>
                    <code>21001</code>
                    <message>Nėra operacijos</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_I13</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <I13>
             <I13_KODAS_PO>010R00001041</I13_KODAS_PO>
             <I13_EIL_NR>1</I13_EIL_NR>
             <I13_SUMA>20.05</I13_SUMA>
         </I13>   
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_I13</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <I13>
             <I13_KODAS_PO>010R00001041</I13_KODAS_PO>
             <I13_EIL_NR>1</I13_EIL_NR>
        </I13>      
    </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);

Lentelės

I13

Pirkimo/Pardavimo apmokėjimo detalios eilutės

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
I13_KODAS_PO	C(12)	Operacijos numeris	Privalomas, kai oper=I,U,D (metode EDIT_I06_FULL neaktualus)
I13_EIL_NR	N(6)	Eil. numeris	Privalomas, kai oper=U,D
I13_KODAS_SS	C(12)	Sąskaita	Privalomas
I13_SUMA	N(12,2)	Suma
I13_SUMA_VAL	N(18,2)	Suma valiuta
I13_PAV	C(40)	Pavadinimas
I13_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai (oper=`I`), ApiKey - pirmi 7 simboliai
I13_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I13_R_DATE	T(8)	Koregavimo data	Neperduodamas. Pildomas automatiškai, Current Datetime