EDIT_I45

Aprašymas

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

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_I45</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <I45>
            <I45_KODAS_SS>7</I45_KODAS_SS>
            <I45_KODAS_IS>999999999999</I45_KODAS_IS>
        </I45>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_I45",
    "params": {
        "oper": "I"
    },
    "data": {
        "I45": {
            "I45_KODAS_SS": "7",
            "I45_KODAS_IS": "999999999999"
        }
    }
}

Response (status 200 OK)

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

pvz:

<RET_DOK>
    <I45>
        <I45_KODAS_IV>000R00000037</I45_KODAS_IV>
        <I45_KODAS_IS>999999999999</I45_KODAS_IS>
        <I45_DOK_NR>IV0000000024</I45_DOK_NR>
        <I45_TIPAS>1</I45_TIPAS>
        <I45_RUSIS>2</I45_RUSIS>
        <I45_PASTABOS>                                       </I45_PASTABOS>
        <I45_KODAS_IN>           </I45_KODAS_IN>
        <I45_SASK_POZ>0</I45_SASK_POZ>
        <I45_KODAS_SS>7           </I45_KODAS_SS>
        <I45_OP_DATA>2025-01-08T00:00:00</I45_OP_DATA>
        <I45_FIX_DATA>2025-01-08T00:00:00</I45_FIX_DATA>
        <I45_KODAS_OS_C>           </I45_KODAS_OS_C>
        <I45_PERKELTA>1</I45_PERKELTA>
        <I45_USERIS>abcdef     </I45_USERIS>
        <I45_R_DATE>2025-01-08T08:42:00</I45_R_DATE>
        <I45_ADDUSR>abcdef     </I45_ADDUSR>
        <I45_KODAS_SM>           </I45_KODAS_SM>
        <I45_BUSENA>1</I45_BUSENA>
    </I45>
</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.fbdfed8d.1736318586477</id>
    <durationMs>44</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data></data>
            <dataErrors>
                <dataError>
                    <tag>I45_KODAS_IS</tag>
                    <code>44015</code>
                    <message>Nerastas padalinio kodas [99999999999 ]</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_I45</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <I45>
            <I45_KODAS_IV>000R00000001</I45_KODAS_IV>
            <I45_PASTABOS>koregotas pastabu laukas</I45_PASTABOS>
        </I45>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_I45</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <I45>
            <I45_KODAS_IV>000R00000001</I45_KODAS_IV>
        </I45>
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: abcdef.12345678910',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
        "method": "EDIT_I45",
        "params": {
            "oper": "I"
        },
        "data": {
            "I45": {
                "I45_KODAS_IV": "000R00000001"
            }
    }
    }');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I45

Inventorizuojamų prekių sąrašo informacija

Laukas	Tipas	Aprašymas
I45_KODAS_IV	char(12)	Operacijos numeris
I45_KODAS_IS	char(12)	Padalinio kodas
I45_DOK_NR	char(12)	Dokumento numeris
I45_TIPAS	numeric(1,0)	Sąrašo tipas:1-su kiekiais,2-be kiekių, 3-be sąrašo
I45_RUSIS	numeric(1,0)	Rūšis:1-tik pagal kodus,2-pagal kodus,objektus,serijas
I45_PASTABOS	char(40)	Aprašymas
I45_KODAS_IN	char(12)	Operacijos su atsargomis Nr.
I45_SASK_POZ	numeric(1,0)	Sąskaitos požymis:1-iš ryšio lentelės,0-nurodytą sąskaitą
I45_KODAS_SS	char(12)	Sąskaitos kodas
I45_OP_DATA	datetime	Inventorizacijos data
I45_FIX_DATA	datetime	Likučių fiksavimo laikas
I45_KODAS_OS_C	char(12)	Operacijų su atsargomis centras
I45_PERKELTA	numeric(1,0)	Perkėlimas:1-nauja,2-perkelta, 3-koreguota
I45_USERIS	char(12)	Kas koregavo
I45_R_DATE	datetime	Koregavimo laikas
I45_ADDUSR	char(12)	Kas sukūrė
I45_KODAS_SM	char(12)	Asmuo
I45_KODAS_ZN	char(12)	Zona
I45_BUSENA	numeric(3,0)	Būsena