Redaguoti

Pradžia Internetiniai moduliai Rivile API v2 (REST web servisai) EDIT_N77

EDIT_N77

Aprašymas

Dovanų čekių 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_N77
params :
- oper :
  - I - naujo įrašo sukūrimas (numatytasis)
  - U - dokumento koregavimas
  - D - dokumento ištrynimas
data: perduodami duomenys:
- N77 - atitinkamos lentelės laukai (n77)

Pirmi 7 ApiKey simboliai (pvz USERABC.JQKPGdd7Pkjxj37ObsgdfEkvfEfvF1oL7h7UMOLo -> USERABC) yra vartotojo vardas Rivile GAMA programoje, kuriuo bus kuriami ar koreguojami įrašai.

Vienu metu veiksmai atliekami tik su vienu įrašu.

XML request

<body>
    <method>EDIT_N77</method>
    <params>
        <Oper>I</Oper>
    </params>
    <data>
        <N77>
            <N77_KODAS_IS>001</N77_KODAS_IS>
            <N77_KODAS_AS>PASL01</N77_KODAS_AS>
            <N77_KODAS_US>VNT</N77_KODAS_US>
            <N77_NOMINALAS>4.99</N77_NOMINALAS>
            <N77_KODAS_DC>D001</N77_KODAS_DC>
        </N77>
  </data>
</body>

JSON request

{
    "method": "EDIT_N77",
    "params": {
        "oper": "I"
    },
    "data": {
        "N77": {
            "N77_KODAS_IS": "001",
            "N77_KODAS_AS": "PASL01",
            "N77_KODAS_US": "VNT",
            "N77_NOMINALAS": "4.99",
            "N77_KODAS_DC": "D001"
        }
    }
}

Response (status 200 OK)

XML response

<RET_DOK>
    <N77>
        <Row_number>1</Row_number>
        <N77_KODAS_DC>D001</N77_KODAS_DC>
        <N77_PAV></N77_PAV>
        <N77_DATE>2023-12-31T00:00:00</N77_DATE>
        <N77_TIPAS>0</N77_TIPAS>
        <N77_KODAS_IS>001</N77_KODAS_IS>
        <N77_NOMINALAS>4.99</N77_NOMINALAS>
        <N77_POZ_DATE>0</N77_POZ_DATE>
        <N77_BEG_DATE>2023-12-31T00:00:00</N77_BEG_DATE>
        <N77_END_DATE>2023-12-31T00:00:00</N77_END_DATE>
        <N77_GALIOJA>0</N77_GALIOJA>
        <N77_GALIOJA_D>0</N77_GALIOJA_D>
        <N77_KARTAS>0</N77_KARTAS>
        <N77_BLOK>0</N77_BLOK>
        <N77_BLOK_USERIS></N77_BLOK_USERIS>
        <N77_BLOK_DATE>1900-01-01T00:00:00</N77_BLOK_DATE>
        <N77_KODAS_AS>PASL01</N77_KODAS_AS>
        <N77_KODAS_US>VNT</N77_KODAS_US>
        <N77_KODAS_LS_1></N77_KODAS_LS_1>
        <N77_KODAS_LS_2></N77_KODAS_LS_2>
        <N77_KODAS_LS_3></N77_KODAS_LS_3>
        <N77_KODAS_LS_4></N77_KODAS_LS_4>
        <N77_ADDUSR>RIVILE</N77_ADDUSR>
        <N77_ADD_DATE>2023-12-31T23:59:59</N77_ADD_DATE>
        <N77_USERIS>RIVILE</N77_USERIS>
        <N77_R_DATE>2023-12-31T23:59:59</N77_R_DATE>
        <T78_KODAS_DC>D001</T78_KODAS_DC>
        <T78_KODAS_IS>001</T78_KODAS_IS>
        <T78_NURASYTA>0</T78_NURASYTA>
        <T78_SUMA>0.00</T78_SUMA>
        <T78_NUR_REZ>0.00</T78_NUR_REZ>
        <T78_PAJ_REZ>0.00</T78_PAJ_REZ>
        <T78_USERIS>RIVILE</T78_USERIS>
        <T78_R_DATE>2023-12-31T23:59:59</T78_R_DATE>
        <pardavimas>1</pardavimas>
        <atsiskaitymas>0</atsiskaitymas>
        <vidinis>1</vidinis>
        <nurasymas>1</nurasymas>
    </N77>
</RET_DOK>

JSON response

{
    "N77": {
        "Row_number": "1",
        "N77_KODAS_DC": "D001",
        "N77_PAV": "",
        "N77_DATE": "2023-12-31T00:00:00",
        "N77_TIPAS": "0",
        "N77_KODAS_IS": "001",
        "N77_NOMINALAS": "4.99",
        "N77_POZ_DATE": "0",
        "N77_BEG_DATE": "2023-12-31T00:00:00",
        "N77_END_DATE": "2023-12-31T00:00:00",
        "N77_GALIOJA": "0",
        "N77_GALIOJA_D": "0",
        "N77_KARTAS": "0",
        "N77_BLOK": "0",
        "N77_BLOK_USERIS": "",
        "N77_BLOK_DATE": "1900-01-01T00:00:00",
        "N77_KODAS_AS": "PASL01",
        "N77_KODAS_US": "VNT",
        "N77_KODAS_LS_1": "",
        "N77_KODAS_LS_2": "",
        "N77_KODAS_LS_3": "",
        "N77_KODAS_LS_4": "",
        "N77_ADDUSR": "RIVILE",
        "N77_ADD_DATE": "2023-12-31T23:59:59",
        "N77_USERIS": "RIVILE",
        "N77_R_DATE": "2023-12-31T23:59:59",
        "T78_KODAS_DC": "D001",
        "T78_KODAS_IS": "001",
        "T78_NURASYTA": "0",
        "T78_SUMA": "0.00",
        "T78_NUR_REZ": "0.00",
        "T78_PAJ_REZ": "0.00",
        "T78_USERIS": "RIVILE",
        "T78_R_DATE": "2023-12-31T23:59:59",
        "pardavimas": "1",
        "atsiskaitymas": "0",
        "vidinis": "1",
        "nurasymas": "1"
    }
}

Response (status 400)

Klaida paduodant duomenis / SQL sintaksės klaidos / kitos duomenų klaidos

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>2</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data>&lt;N77_KODAS_US>VNT&lt;/N77_KODAS_US>&lt;N77_KODAS_DC>D001&lt;/N77_KODAS_DC>&lt;/N77></data>
            <dataErrors>
                <dataError>
                    <tag>n77_kodas_is</tag>
                    <code>11002</code>
                    <message>Nenurodytas padalinio kodas</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>2023-12-31T23:59:59.999+0000</timestamp>
    <status>500</status>
    <error>Internal Server Error</error>
    <message>No message available</message>
    <path>/v2</path>
</Map>

Koregavimas, trynimas ir perkėlimas

Koregavimas, trynimas ir perkėlimas vyksta pagal atitinkamos lentelės raktą (Primary Key)

Koreguojant informaciją bus koreguojami tik perduodami laukai.

pvz koregavimas:

<body>
    <method>EDIT_N77</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N77>
            <N77_KODAS_DC>D001</N77_KODAS_DC>
            <N77_PAV>Koregavimas</N77_PAV>
        </N77>
    </data>
</body>

pvz trynimas:

<body>
    <method>EDIT_N77</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N77>
            <N77_KODAS_DC>D001</N77_KODAS_DC>
        </N77>
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: uUCz6UY.sKVrjaWRDJAH1c7l4qL2nOnn2K0jARkkkHDdYsss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "EDIT_N77",
    "params": {
        "oper": "I"
    },
    "data": {
        "N77": {
            "N77_KODAS_IS": "001",
            "N77_KODAS_AS": "PASL01",
            "N77_KODAS_US": "VNT",
            "N77_NOMINALAS": "4.99",
            "N77_KODAS_DC": "D001"
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N77

Dovanų čekių lentelės aprašymas

Laukas	Tipas	Aprašymas	Pastabos
N77_KODAS_DC	C(12)	Kodas	Privalomas , kai oper=U,D
N77_PAV	C(60)	Pavadinimas
N77_DATE	T(8)	Data
N77_TIPAS	N(3)	Tipas
N77_KODAS_IS	C(12)	Padalinys
N77_NOMINALAS	N(12,2)	Nominalas	Privalomas , kai oper=I
N77_POZ_DATE	N(1)	Ar terminuota: 1- aip,0-Ne
N77_BEG_DATE	T(8)	Pradžios data
N77_END_DATE	T(8)	Pabaigos data
N77_GALIOJA	N(1)	Galiojantis laike DČ
N77_GALIOJA_D	N(5)	Galioja dienų
N77_KARTAS	N(1)	Vienkartinio požymis
N77_BLOK	N(1)	Blokavimo požymis
N77_BLOK_USERIS	C(12)	Kas koregavo požymį
N77_BLOK_DATE	T(8)	Kada koregavo požimį
N77_KODAS_AS	C(12)	Paslaugos kodas	Privalomas , kai oper=I
N77_KODAS_US	C(12)	Matavimo vieneto kodas
N77_KODAS_LS_1	C(12)	Logistikos kodas 1
N77_KODAS_LS_2	C(12)	Logistikos kodas 2
N77_KODAS_LS_3	C(12)	Logistikos kodas 3
N77_KODAS_LS_4	C(12)	Logistikos kodas 4
N77_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N77_ADD_DATE	T(8)	Kada sukūrė	Neperduodamas. Pildomas automatiškai, Current Datetime
N77_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N77_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime

T78

Dovanų čekių būklės lentelės aprašymas

Laukas	Tipas	Aprašymas
T78_KODAS_DC	C(12)	Dovanų Čekis
T78_KODAS_IS	C(12)	Padalinys
T78_GALIOJA_IKI	T(8)	Galioja iki
T78_NURASYTA	N(1)	Nurašyta
T78_SUMA	N(12,2)	Suma
T78_NUR_REZ	N(12,2)	Nurašymos rezervas
T78_PAJ_REZ	N(12,2)	Pajamavimo rezervas
T78_USERIS	C(12)	Kas koregavo
T78_R_DATE	T(8)	Kada koregavo