Redaguoti

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

EDIT_I20_FULL

Aprašymas

Naujos perkainavimo 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_I20_FULL
params :
- errorAction - klaidos parametras nurodantis koks veiksmas bus atliekamas įvykus klaidai perkainavimo operacijos formavimo metu, kai yra sukuriama operacija (I20) ir gaunama klaida vykdant veiksmus su detaliomis eilutėmis (I21, I28, I29, I34, I14). 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:
- I20 - atitinkamos lentelės laukai (i20)
- I21 - atitinkamos lentelės laukai (i21)
- I28 - atitinkamos lentelės laukai (i28)
- I29 - atitinkamos lentelės laukai (i29)
- I34 - atitinkamos lentelės laukai (i34)
- I14 - atitinkamos lentelės laukai (i14)

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 (I20) ir grąžinama klaida. Klaidos statusas 400
EXIT	Įvykus klaidai tolimesnės procedūros nebus vykdamos, bus grąžinamas sukurtas dokumentas (I20) 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 (I20) ir klaidų sąrašas pabaigoje. Klaidos statusas 207

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

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

XML request

<body>
    <method>EDIT_I20_FULL</method>
    <params>
        <errorAction>CONTINUE</errorAction>
    </params>
    <data>
        <I20>
            <I20_TIPAS>1</I20_TIPAS>
            <I20_OP_DATE>2024.01.01</I20_OP_DATE>
            <I20_DOK_NR>PERK001</I20_DOK_NR>
            <I20_KODAS_IS>01</I20_KODAS_IS>
            <I21>
                <I21_KODAS_PS>PREKE1</I21_KODAS_PS>
                <I21_KAINA_N>1.1900</I21_KAINA_N>
            </I21>
            <I21>
                <I21_KODAS_PS>PREKE2</I21_KODAS_PS>
                <I21_KAINA_N>1.0900</I21_KAINA_N>
            </I21>
        </I20>    
    </data>
</body>

JSON request

{
    "method": "EDIT_I20_FULL",
    "params": {
        "errorAction": "CONTINUE"
    },
    "data": {
        "I20": {
            "I20_TIPAS": 1,
            "I20_OP_DATE": "2024.01.01",
            "I20_DOK_NR": "PERK001",
            "I20_KODAS_IS": "01",
            "I21":[
                {
                "I21_KODAS_PS": "PREKE1",
                "I21_KAINA_N": 1.19
                },
                {
                "I21_KODAS_PS": "PREKE2",
                "I21_KAINA_N": 1.09
                }
            ]
        }
    }
}

Response (status 200 OK)

XML response

<RET_DOK>
    <I20>
        <I20_KODAS_PK>010R00000001</I20_KODAS_PK>
        <I20_DOK_NR>PERK001</I20_DOK_NR>
        <I20_TIPAS>1</I20_TIPAS>
        <I20_OP_DATE>2024-01-01T00:00:00</I20_OP_DATE>
        <I20_APRAS></I20_APRAS>
        <I20_KODAS_IS>01</I20_KODAS_IS>
        ...
        <I21_PERD>
            <I21>
                <I21_KODAS_PK>010R00000001</I21_KODAS_PK>
                <I21_EIL_NR>1</I21_EIL_NR>
                <I21_KODAS_PS>PREKE1</I21_KODAS_PS>
                <I21_KODAS_US>VNT</I21_KODAS_US>
                ...
            </I21>
            <I21>
                <I21_KODAS_PK>010R00000001</I21_KODAS_PK>
                <I21_EIL_NR>2</I21_EIL_NR>
                <I21_KODAS_PS>PREKE2</I21_KODAS_PS>
                <I21_KODAS_US>VNT</I21_KODAS_US>
                ...
            </I21>
        </I21_PERD>
    </I20>
</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>
    <I20>
        <I20_KODAS_PK>010R00000001</I20_KODAS_PK>
        <I20_DOK_NR>PERK001</I20_DOK_NR>
        <I20_TIPAS>1</I20_TIPAS>
        <I20_OP_DATE>2024-01-01T00:00:00</I20_OP_DATE>
        <I20_APRAS></I20_APRAS>
        <I20_KODAS_IS>01          </I20_KODAS_IS>
        ...
        <I21_PERD>
            <I21>
                <I21_KODAS_PK>010R00000001</I21_KODAS_PK>
                <I21_EIL_NR>1</I21_EIL_NR>
                <I21_KODAS_PS>PREKE1</I21_KODAS_PS>
                <I21_KODAS_US>VNT</I21_KODAS_US>
                ...
            </I21>
        </I21_PERD>
    </I20>
    <errors>
        <error>
            <data>&lt;I21>&lt;num_row>1&lt;/num_row>&lt;i21_kaina_n>1.1900&lt;/i21_kaina_n>&lt;i21_kodas_ps>PREKES_NERA&lt;/i21_kodas_ps>&lt;/I21></data>
            <dataErrors>
                <dataError>
                    <tag>I21_KODAS_PS</tag>
                    <code>19014</code>
                    <message>Nerastas prekės/paslaugos kodas</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;I20>&lt;i20_op_date>2024-01-01T00:00:00&lt;/i20_op_date>&lt;i20_tipas>1&lt;/i20_tipas>&lt;i20_dok_nr>PERK001&lt;/i20_dok_nr>&lt;i20_kodas_is>0100000&lt;/i20_kodas_is>&lt;/I20></data>
            <dataErrors>
                <dataError>
                    <tag>I20_KODAS_IS</tag>
                    <code>34015</code>
                    <message>Nerastas 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>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.sKVrjWHRDJAH1c7l4qL2NOoN2K0jAWHvuHhdYsYT',
      '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

I20

Nuoroda į lentelės aprašymą: i20

I21

Nuoroda į lentelės aprašymą: i21

I28

Nuoroda į lentelės aprašymą: i28

I29

Nuoroda į lentelės aprašymą: i29

I34

Nuoroda į lentelės aprašymą: i34

I14

Nuoroda į lentelės aprašymą: i14