EDIT_N19

Aprašymas

Grupės 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_N19
  • params :
    • oper :
      • I - naujo įrašo sukūrimas
      • U - įrašo koregavimas
      • D - įrašo ištrynimas
  • data: perduodami duomenys:
    • N19 - atitinkamos lentelės laukai (N19)

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_N19</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N19>
            <N19_KODAS_GS>GRU001</N19_KODAS_GS>
            <N19_PAV>Grupės pavadinimas 001</N19_PAV>
        </N19>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N19",
    "params": {
        "oper": "I"
    },
    "data": {
        "N19": {
            "N19_KODAS_GS": "GRU001",
            "N19_PAV": "Grupės pavadinimas 001"
        }
    }
}
Response (status 200 OK)

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

pvz:

<RET_DOK>
    <N19>
        <N19_KODAS_GS>GRU001</N19_KODAS_GS>
        <N19_RUSIS>1</N19_RUSIS>
        <N19_PAV>Grupės pavadinimas 001            </N19_PAV>
        <N19_LYGIS>1</N19_LYGIS>
        <N19_TEVAS>           </N19_TEVAS>
        <N19_TIPAS>1</N19_TIPAS>
        <N19_POZ_DATE>0</N19_POZ_DATE>
        <N19_BEG_DATE>2024-05-21T00:00:00</N19_BEG_DATE>
        <N19_END_DATE>2024-05-21T00:00:00</N19_END_DATE>
        <N19_IMP_EXP_GR>           </N19_IMP_EXP_GR>
        <N19_APRAS>                                       </N19_APRAS>
        <N19_ASOR_KIEK>0</N19_ASOR_KIEK>
        <N19_FRAC>0</N19_FRAC>
        <N19_ASOR_LIK>0</N19_ASOR_LIK>
        <N19_SK_KASOJE>0</N19_SK_KASOJE>
        <N19_ANTKAINIS>0.00</N19_ANTKAINIS>
        <N19_MAX_NUOL>0.00</N19_MAX_NUOL>
        <N19_ADDUSR>123     </N19_ADDUSR>
        <N19_USERIS>123     </N19_USERIS>
        <N19_R_DATE>2024-05-21T08:29:25</N19_R_DATE>
        <N19_PAV_K1></N19_PAV_K1>
        <N19_PAV_K2></N19_PAV_K2>
        <N19_PAV_K3></N19_PAV_K3>
    </N19>
</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;N19>&lt;/N19></data>
            <dataErrors>
                <dataError>
                    <tag>N19_KODAS_GS</tag>
                    <code>5009</code>
                    <message>Grupės 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_N19</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N19>
            <N19_KODAS_GS>GRU001</N19_KODAS_GS>
            <N19_PAV>Grupės pavadinimas naujas</N19_PAV>
        </N19>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_N19</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N19>
            <N19_KODAS_GS>GRU001</N19_KODAS_GS>
        </N19>
    </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_N19",
        "params": {
            "oper": "I"
        },
        "data": {
            "N19": {
                "N19_KODAS_GS": "GRU001",
                "N19_PAV": "Grupės pavadinimas 001"
            }
    }
    }');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N19

Grupės informacija

Laukas Tipas Aprašymas Pastabos
N19_KODAS_GS C(12) Grupės kodas
N19_RUSIS N(1) Rūšis: 1-prekių, 2-paslaugų, 3-klientų, 4-kodų
N19_PAV C(40) Grupės pavadinimas
N19_LYGIS N(3) Lygis
N19_TIPAS N(1) Tipas: 1-grupė, 2-detali
N19_TEVAS C(12) Aukštesnės grupės kodas
N19_POZ_DATE N(1) Terminuota: 0-ne, 1-taip
N19_BEG_DATE T(8) Pradžios data
N19_END_DATE T(8) Pabaigos data
N19_IMP_EXP_GR C(12) Importo/Eksporto kodas muitinėje
N19_APRAS C(40) Importo/Eksporto aprašymas
N19_ASOR_KIEK N(6) Asortimento kiekis grupėje
N19_FRAC N(4 Asortimento frakcija
N19_ASOR_LIK N(12) Asortimento likutis
N19_SK_KASOJE N(2) Skyrius kasoje
N19_ANTKAINIS N(6,2) Antkainio procentas
N19_MAX_NUOL N(6,2) Maksimalus nuolaidos procentas parduodant
N19_ADDUSR C(12) Kas sukūrė
N19_USERIS C(12) Kas koregavo
N19_R_DATE T(8) Kada koregavo
N19_PAV_K1 C(100) Pavadinimas kita kalba 1
N19_PAV_K2 C(100) Pavadinimas kita kalba 2
N19_PAV_K3 C(100) Pavadinimas kita kalba 3