EDIT_N15

Aprašymas

Menedžerio kortelės 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_N15
params :
- oper :
  - I - naujo įrašo sukūrimas
  - U - įrašo koregavimas
  - D - įrašo ištrynimas
data: perduodami duomenys:
- N15 - atitinkamos lentelės laukai (N15)

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_N15</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N15>
            <N15_KODAS_MS>MS001</N15_KODAS_MS>
            <N15_PAV>Menedzerio pavadinimas 001</N15_PAV>
        </N15>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N15",
    "params": {
        "oper": "I"
    },
    "data": {
        "N15": {
            "N15_KODAS_GS": "MS001",
            "N15_PAV": "Menedzerio pavadinimas 001"
        }
    }
}

Response (status 200 OK)

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

pvz:

<RET_DOK>
    <N15>
        <N15_KODAS_MS>MS001       </N15_KODAS_MS>
        <N15_RUSIS>0</N15_RUSIS>
        <N15_PAV></N15_PAV>
        <N15_LYGIS>1</N15_LYGIS>
        <N15_TEVAS>            </N15_TEVAS>
        <N15_TIPAS>1</N15_TIPAS>
        <N15_POZ_DATE>0</N15_POZ_DATE>
        <N15_BEG_DATE>2024-09-30T00:00:00</N15_BEG_DATE>
        <N15_END_DATE>2024-09-30T00:00:00</N15_END_DATE>
        <N15_ADDUSR>WS          </N15_ADDUSR>
        <N15_USERIS>WS          </N15_USERIS>
        <N15_R_DATE>2024-09-30T00:00:00</N15_R_DATE>
        <N15_TAB_NO>0</N15_TAB_NO>
        <N15_PAJ_KOD>0</N15_PAJ_KOD>
        <N15_KODAS_SS>            </N15_KODAS_SS>
        <N15_KODAS_BS>            </N15_KODAS_BS>
        <N15_PAREIGOS>                                        </N15_PAREIGOS>
        <N15_ADRESAS></N15_ADRESAS>
        <N15_TEL>                                        </N15_TEL>
        <N15_E_MAIL></N15_E_MAIL>
        <N15_PASTABOS>                                        </N15_PASTABOS>
        <N15_FLG_PO>0</N15_FLG_PO>
        <N15_FLG_RO>0</N15_FLG_RO>
        <N15_FLG_KR>0</N15_FLG_KR>
        <N15_FLG_CI>0</N15_FLG_CI>
        <N15_FLG_CH>0</N15_FLG_CH>
        <N15_FLG_TR>0</N15_FLG_TR>
        <N15_FLG_PP>0</N15_FLG_PP>
        <N15_FLG_AL>0</N15_FLG_AL>
        <N15_FLG_RR1>0</N15_FLG_RR1>
        <N15_FLG_RR2>0</N15_FLG_RR2>
        <N15_FLG_RR3>0</N15_FLG_RR3>
        <N15_FLG_RR4>0</N15_FLG_RR4>
        <N15_FLG_RR5>0</N15_FLG_RR5>
        <N15_MAX_NUOL>0.00</N15_MAX_NUOL>
    </N15>
</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.8ec4537a.1716271246499</id>
    <durationMs>569</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data>&lt;N15>&lt;/N15></data>
            <dataErrors>
                <dataError>
                    <tag>N15_KODAS_MS</tag>
                    <code>5009</code>
                    <message>Kodas nerastas</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_N15</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N15>
            <N15_KODAS_MS>MS001</N15_KODAS_MS>
            <N15_PAV>Menedzerio pavadinimas naujas</N15_PAV>
        </N15>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_N15</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N15>
            <N15_KODAS_MS>MS001</N15_KODAS_MS>
        </N15>
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: 9999999.12345678910',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
        "method": "EDIT_N15",
        "params": {
            "oper": "I"
        },
        "data": {
            "N15": {
                "N15_KODAS_MS": "MS001",
                "N15_PAV": "Menedzerio pavadinimas 001"
            }
    }
    }');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N15

Menedžerio informacija

Laukas	Tipas	Aprašymas
N15_KODAS_MS	char(12)	Menedžerio kodas
N15_RUSIS	numeric(1,0)	Rūšis:1-pardavėjas,2-pirkėjas,3-pardavėjas/pirkėjas,4-ats.asmuo,5-vairuotojas
N15_PAV	char(150)	Pavadinimas
N15_LYGIS	numeric(3,0)	Lygis
N15_TEVAS	char(12)	Aukštesnio lygio menedžerio kodas
N15_TIPAS	numeric(1,0)	Tipas:1-suminis,2-detalus
N15_POZ_DATE	numeric(1,0)	Terminuotas:0-ne,1-taip
N15_BEG_DATE	datetime	Pradžios data
N15_END_DATE	datetime	Pabaigos data
N15_ADDUSR	char(12)	Kas sukūrė
N15_USERIS	char(12)	Kas koregavo
N15_R_DATE	datetime	Koregavimo laikas
N15_TAB_NO	numeric(5,0)	Tabelinis numeris iš atlyginimų
N15_PAJ_KOD	numeric(5,0)	Priskaitymo kodas iš atlyginimų
N15_KODAS_SS	char(12)	Sąskaitos kodas
N15_KODAS_BS	char(12)	Dienpinigių kodas
N15_PAREIGOS	char(40)	Pareigos
N15_ADRESAS	char(150)	Adresas
N15_TEL	char(40)	Telefonai
N15_E_MAIL	char(150)	E-mail
N15_PASTABOS	char(40)	Pastabos
N15_FLG_PO	numeric(1,0)	Pirkimų modulis
N15_FLG_RO	numeric(1,0)	Pardavimų modulis
N15_FLG_KR	numeric(1,0)	Debitorinių/Kred. op. modulis
N15_FLG_CI	numeric(1,0)	Išmokos
N15_FLG_CH	numeric(1,0)	Įplaukųi modulis
N15_FLG_TR	numeric(1,0)	Transporto modulis
N15_FLG_PP	numeric(1,0)	Pagrindinės priemonės
N15_FLG_AL	numeric(1,0)	Algų modulis
N15_FLG_RR1	numeric(1,0)	Vidiniai
N15_FLG_RR2	numeric(1,0)	Rezervas
N15_FLG_RR3	numeric(1,0)	Rezervas
N15_FLG_RR4	numeric(1,0)	Rezervas
N15_FLG_RR5	numeric(1,0)	Rezervas
N15_MAX_NUOL	numeric(6,2)	Maksimali nuolaida
N15_APRASYMAS1	char(150)	Aprašymas 1
N15_APRASYMAS2	char(150)	Aprašymas 2
N15_APRASYMAS3	char(150)	Aprašymas 3