EDIT_I51_FULL

Aprašymas

Naujos kaupiklio operacijos sukūrimas (kartu su detaliomis eilutėmis)

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_I51_FULL
  • params :
    • errorAction - klaidos parametras nurodantis koks veiksmas bus atliekamas įvykus klaidai perkainavimo operacijos formavimo metu, kai yra sukuriama operacija (I51) ir gaunama klaida vykdant veiksmus su detaliomis eilutėmis (I52). Parametras gali turėti tris reikšmes: EXIT, CONTINUE, ROLLBACK (default reikšmė). Reikšmė turi būti paduodama dydžiosiomis raidėmis!
    • user - vartotojo vardas (naudojamas dokumentų skaitliukams, parametrams ir kt.), veikia tik rakto prefix'ui įjungus parametrą RGI_USR_EDIT
  • data: perduodami duomenys:
    • I51 - atitinkamos lentelės laukai (i51)
    • I52 - atitinkamos lentelės laukai (i52)

errorAction reikšmė turi būti paduodama didžiosiomis raidėmis!

errorAction reikšmių aprašymai:

Reikšmė Aprašymas
ROLLBACK (default reikšmė) Įvykus klaidai tolimesnės procedūros nebus vykdamos, bus ištrinamas dokumentas (I51) ir grąžinama klaida. Klaidos statusas 400
EXIT Įvykus klaidai tolimesnės procedūros nebus vykdamos, bus grąžinamas sukurtas dokumentas (I51) ir klaidų sąrašas. Klaidos statusas 207
CONTINUE Įvykus klaidai procedūros bus vykdamos iki pabaigos, o klaidos dedamos į sąrašą. Grąžinamas sukurtas dokumentas (I51) ir klaidų sąrašas pabaigoje. Klaidos statusas 207

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

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

XML request
<body>
    <method>EDIT_I51_FULL</method>
    <params>
        <errorAction>CONTINUE</errorAction>
    </params>
    <data>
        <I51>
            <I51_LAIKAS>2024-01-01</I51_LAIKAS>
            <I51_PAV>Kaupiklis 1</I51_PAV>
            <I52>
                <I52_BAR_KODAS>000000000123</I52_BAR_KODAS>
                <I52_KIEKIS>10</I52_KIEKIS>
            </I52>
            <I52>
                <I52_BAR_KODAS>000000123456</I52_BAR_KODAS>
                <I52_KIEKIS>5</I52_KIEKIS>
                <I52_KAINA>1.09</I52_KAINA>
            </I52>
        </I51>
    </data>
</body>
JSON request
{
    "method": "EDIT_I51_FULL",
    "params": {
        "errorAction": "CONTINUE"
    },
    "data": {
        "I51": {
            "I51_LAIKAS": "2024-01-01",
            "I51_PAV": "Kaupiklis 1",
            "I52":[
                {
                "I52_BAR_KODAS": "000000000123",
                "I52_KIEKIS": 10
                },
                {
                "I52_BAR_KODAS": "000000123456",
                "I52_KIEKIS": 5,
                "I52_KAINA": 1.09
                }
            ]
        }
    }
}
Response (status 200 OK)
XML response
<RET_DOK>
    <I51>
        <I51_KODAS_KP>010R00000001</I51_KODAS_KP>
        <I51_KODAS_KK></I51_KODAS_KK>
        <I51_LAIKAS>2024-01-01T00:00:00</I51_LAIKAS>
        <I51_PAV>Kaupiklis 1</I51_PAV>
        <I51_PERKELTA>1</I51_PERKELTA>
        ...
        <I52>
            <I52_KODAS_KP>010R00000001</I52_KODAS_KP>
            <I52_EIL_NR>1</I52_EIL_NR>
            <I52_BAR_KODAS>000000000123</I52_BAR_KODAS>
            <I52_KIEKIS>10.0000</I52_KIEKIS>
            <I52_KAINA>0.0000</I52_KAINA>
            ...
        </I52>
        <I52>
            <I52_KODAS_KP>010R00000001</I52_KODAS_KP>
            <I52_EIL_NR>2</I52_EIL_NR>
            <I52_BAR_KODAS>000000001170</I52_BAR_KODAS>
            <I52_KIEKIS>5.0000</I52_KIEKIS>
            <I52_KAINA>1.0900</I52_KAINA>
            ...
        </I52>
    </I51>
</RET_DOK>
Response (status 207)

207 statusas gaunamas, kai procedūros yra vykdamos perduodant parametrą errorAction su reikšme EXIT arba CONTINUE ir gaunama klaida kažkurioje iš procedūrų, pvz.:

<RET_DOK>
    <I51>
        <I51_KODAS_KP>010R00000001</I51_KODAS_KP>
        <I51_KODAS_KK></I51_KODAS_KK>
        <I51_LAIKAS>2024-01-01T00:00:00</I51_LAIKAS>
        <I51_PAV>Kaupiklis 1</I51_PAV>
        <I51_PERKELTA>1</I51_PERKELTA>
        ...
        <I52>
            <I52_KODAS_KP>010R00000001</I52_KODAS_KP>
            <I52_EIL_NR>1</I52_EIL_NR>
            <I52_BAR_KODAS>000000000123</I52_BAR_KODAS>
            <I52_KIEKIS>10.0000</I52_KIEKIS>
            <I52_KAINA>0.0000</I52_KAINA>
            ...
        </I52>
    </I51>
    <errors>
        <error>
            <data>&lt;I52>&lt;num_row>2&lt;/num_row>&lt;I52_KIEKIS>5.0000&lt;/I52_KIEKIS>&lt;I52_KAINA>1.0900&lt;/I52_KAINA>&lt;I52_BAR_KODAS>0008800123456&lt;/I52_BAR_KODAS>&lt;/I52></data>
            <dataErrors>
                <dataError>
                    <tag>I52_BAR_KODAS</tag>
                    <code>6026</code>
                    <message>Bar kodas nerastas</message>
                </dataError>
            </dataErrors>
        </error>
    </errors>
</RET_DOK>
Response (status 400)

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

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>0</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data>&lt;I51>&lt;I51_KODAS_KK>A1&lt;/I51_KODAS_KK>&lt;I51_PAV>Kaupiklis1&lt;/I51_PAV>&lt;I51_LAIKAS>2024-01-01T00:00:00&lt;/I51_LAIKAS>&lt;/I51></data>
            <dataErrors>
                <dataError>
                    <tag>I51_KODAS_KK</tag>
                    <code>552190</code>
                    <message>Nerastas įrenginys A1</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>2024-01-01T00:00:01.001+0000</timestamp>
    <status>500</status>
    <error>Internal Server Error</error>
    <message>No message available</message>
    <path>/v2</path>
</Map>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: uUCz6Hh.sKVrjWHRDJAH1c7l4qL2kOoN2K0jAWHvuHhdYsYT',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I51

Nuoroda į lentelės aprašymą: i51

I52

Nuoroda į lentelės aprašymą: i52