EDIT_K79

Aprašymas

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

Pirmi 7 ApiKey simboliai (pvz USERABC.JQKPG1d7Pkjxj38ObsgdfEvvfEfvF1oL7h7UMOL0 -> 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_K79</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <K79>
            <K79_KODAS_DO>010R00000001</K79_KODAS_DO>
            <K79_KODAS_DC>D001</K79_KODAS_DC>
            <K79_PAV>Dovanų čekio detali eilutė</K79_PAV>
        </K79>    
    </data>
</body>

JSON request

{
    "method": "EDIT_K79",
    "params": {
        "oper": "I"
    },
    "data": {
        "K79": {
            "K79_KODAS_DO": "010R00000001",
            "K79_KODAS_DC": "D001",
            "K79_PAV": "Dovanų čekio detali eilutė"
        }
    }
}

Response (status 200 OK)

XML response

<RET_DOK>
    <K79>
        <K79_KODAS_DO>010000000001</K79_KODAS_DO>
        <K79_ID></K79_ID>
        <K79_EIL_NR>1</K79_EIL_NR>
        <K79_KODAS_DC>D001</K79_KODAS_DC>
        <K79_PAV>Dovanų čekio detali eilutė</K79_PAV>
        <K79_NOMINALAS>9.00</K79_NOMINALAS>
        <K79_SUMA>9.00</K79_SUMA>
        <K79_MOD_EIL>0</K79_MOD_EIL>
        <K79_PERKELTA>1</K79_PERKELTA>
        <K79_ADDUSR>RIVILE</K79_ADDUSR>
        <K79_ADD_DATE>2023-12-31T23:59:59</K79_ADD_DATE>
        <K79_R_DATE>2023-12-31T23:59:59</K79_R_DATE>
        <K79_USERIS>RIVILE</K79_USERIS>
    </K79>
</RET_DOK>

JSON response

{
    "K79": {
        "K79_KODAS_DO": "010000000001",
        "K79_ID": "",
        "K79_EIL_NR": "1",
        "K79_KODAS_DC": "D001",
        "K79_PAV": "Dovanų čekio detali eilutė",
        "K79_NOMINALAS": "9.00",
        "K79_SUMA": "9.00",
        "K79_MOD_EIL": "0",
        "K79_PERKELTA": "1",
        "K79_ADDUSR": "RIVILE",
        "K79_ADD_DATE": "2023-12-31T23:59:59",
        "K79_R_DATE": "2023-12-31T23:59:59",
        "K79_USERIS": "RIVILE"
    }
}

Response (status 400)

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

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id>3165751561.c32adf4a.1701680636442</id>
    <durationMs>3</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data>&lt;K79>&lt;K79_KODAS_DC>D001&lt;/K79_KODAS_DC>&lt;K79_KODAS_DO>010000000001&lt;/K79_KODAS_DO>&lt;/K79></data>
            <dataErrors>
                <dataError>
                    <tag>n77_kodas_dc</tag>
                    <code>552026</code>
                    <message>Čekis jau parduotas</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_K79</method>
    <params>
        <Oper>U</Oper>
    </params>
    <data>
        <K79>
            <K79_KODAS_DO>010000000001</K79_KODAS_DO>
            <K79_EIL_NR>1</K79_EIL_NR>
            <K79_PAV>Kitas pavadinimas</K79_PAV>
        </K79>
    </data>
</body>

pvz trynimas:

<body>
    <method>EDIT_K79</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <K79>
            <K79_KODAS_DO>010000000001</K79_KODAS_DO>
        </K79>
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: uUCz7UY.sKVrjaWRDJAH1c7l4qL222nn2K0jARkkkHDdYTss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "EDIT_K79",
    "params": {
        "oper": "I"
    },
    "data": {
        "K79": {
            "K79_KODAS_DO": "010R00000001",
            "K79_KODAS_DC": "D001",
            "K79_PAV": "Dovanų čekio detali eilutė"
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

K79

Dovanų čekių operacijos detalios eilutės

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
K79_KODAS_DO	C(12)	Operacijos Nr.	Privalomas , kai oper=U,D
K79_ID	C(12)	Operacijos Id.
K79_EIL_NR	N(6)	Eil. numeris	Privalomas , kai oper=U,D
K79_KODAS_DC	(12)	Dovanų čekio kodas	Privalomas, kai oper=I
K79_PAV	C(60)	Pavadinimas
K79_NOMINALAS	N(12,2)	Nominalas
K79_SUMA	N(12,2)	Dovanų čekio suma
K79_MOD_EIL	N(6)	Eilutė modulyje
K79_PERKELTA	N(1)	Perkelta
K79_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
K79_ADD_DATE	T(8)	Kada sukūrė	Neperduodamas. Pildomas automatiškai, Current Datetime
K79_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
K79_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime