EDIT_K45

Aprašymas

Rinkinio sukūrimas, koregavimas, išmetimas.

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

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.

Kuriant naują įrašą (Oper = I) nebūtina nurodyti rinkinio kodo <K45_KODAS_RI>. Jeigu rinkinio kodas nenurodytas, programa jį sugeneruoja automatiškai. Jeigu rinkinys su užklausoje nurodytomis rinkinio dalimis <K45_RIN01>, ... <K45_RIN15> jau egzistuoja - naujas rinkinys nesukuriamas, o atsakyme grąžinamas jau egziztuojančio rinkinio kodas.

pvz application/xml:

<body>
    <method>EDIT_K45</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <K45>
            <K45_PAV>Testas</K45_PAV>
            <K45_KODAS_LS_1>01</K45_KODAS_LS_1>
            <K45_KODAS_LS_2>02</K45_KODAS_LS_2>
            <K45_RIN01>RINKINYS1</K45_RIN01>
            <K45_RIN02>RINKINYS2</K45_RIN02>
        </K45>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_K45",
    "params": {
        "oper": "I"
    },
    "data": {
        "K45": {
            "K45_PAV": "Testas",
            "K45_KODAS_LS_1": "01",
            "K45_KODAS_LS_2": "01",
            "K45_RIN01": "RINKINYS1",
            "K45_RIN02": "RINKINYS2"
        }
    }
}

Response (status 200 OK)

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

pvz:

<?xml version='1.0'?>
<RET_DOK>
    <K45_RIN>
        <K45_KODAS_RI>010R00000010</K45_KODAS_RI>
        <K45_PAV>Testas</K45_PAV>
        <K45_RIN01>RINKINYS1   </K45_RIN01>
        <K45_RIN02>RINKINYS2   </K45_RIN02>
        <K45_KODAS_LS_1>01          </K45_KODAS_LS_1>
        <K45_KODAS_LS_2>01          </K45_KODAS_LS_2>
        <K45_BUSENA>1</K45_BUSENA>
        <K45_POZ_DATE>0</K45_POZ_DATE>
        <K45_BEG_DATE>2022-02-14T00:00:00</K45_BEG_DATE>
        <K45_END_DATE>2022-02-14T00:00:00</K45_END_DATE>
        <K45_USERIS>USERIS</K45_USERIS>
        <K45_R_DATE>2022-02-14T15:58:32</K45_R_DATE>
    </K45_RIN>
</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>2501504701.1815175c.1644848133422</id>
    <durationMs>586</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data>{"K45":{"K45_RIN02":"RINKINYS4","K45_RIN01":"RINKINYS3","K45_PAV":"Testas","K45_KODAS_RI":"RINK","K45_KODAS_LS_1":"099","K45_KODAS_LS_2":"01"}}</data>
            <dataErrors>
                <dataError>
                    <tag>K45_KODAS_LS_1</tag>
                    <code>2043</code>
                    <message>Nėra tokio logistikos kodo kodo</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_K45</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <K45>
             <K45_KODAS_RI>010000000019</K45_KODAS_RI>
             <K45_PAV>Testavimui</K45_PAV>
             <K45_KODAS_LS_1>Logistika1</K45_KODAS_LS_1>
         </K45>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_K45</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <K45>
             <K45_KODAS_RI>010000000019</K45_KODAS_RI>
         </K45>
    </data>
</body>

PHP pvz

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

Lentelės

K45

Prekės komponenčių lentelė.

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
K45_KODAS_RI	C(12)	Rinkinio ID	Privaloma (kai Oper = U arba D)
K45_PAV	C(150)	Pavadinimas
K45_RIN01	C(12)	Rinkinys 1
K45_RIN02	C(12)	Rinkinys 2
K45_RIN03	C(12)	Rinkinys 3
K45_RIN04	C(12)	Rinkinys 4
K45_RIN05	C(12)	Rinkinys 5
K45_RIN06	C(12)	Rinkinys 6
K45_RIN07	C(12)	Rinkinys 7
K45_RIN08	C(12)	Rinkinys 8
K45_RIN09	C(12)	Rinkinys 9
K45_RIN10	C(12)	Rinkinys 10
K45_RIN11	C(12)	Rinkinys 11
K45_RIN12	C(12)	Rinkinys 12
K45_RIN13	C(12)	Rinkinys 13
K45_RIN14	C(12)	Rinkinys 14
K45_RIN15	C(12)	Rinkinys 15
K45_KODAS_LS_1	C(12)	Logistika 1
K45_KODAS_LS_2	C(12)	Logistika 2
K45_KODAS_LS_3	C(12)	Logistika 3
K45_KODAS_LS_4	C(12)	Logistika 4
K45_BUSENA	N(3)	Būsena
K45_POZ_DATE	N(1)	Terminuota:0-ne;1-taip
K45_BEG_DATE	T(8)	Periodo pradžia
K45_END_DATE	T(8)	Periodo pabaiga
K45_USERIS	C(12)	Kas koregavo
K45_R_DATE	T(8)	Kada koregavo