EDIT_K78

Aprašymas

Dovanų čekių operacijų dokumento koregavimas (antraštės)

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

Pirmi 7 ApiKey simboliai (pvz USERABC.JQKPG1d7Pkjxj37ObsgdfEvvfEfvF1oL7h7UMOLo -> 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_K78</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <K78>
            <K78_KODAS_KS>121411842</K78_KODAS_KS>
            <K78_KODAS_IS_1>001</K78_KODAS_IS_1>
            <K78_MOD>RO</K78_MOD>
            <K78_KODAS_OP>010R00000001</K78_KODAS_OP>
        </K78>    
    </data>
</body>

JSON request

{
    "method": "EDIT_K78",
    "params": {
        "oper": "I"
    },
    "data": {
        "K78": {
            "K78_KODAS_KS": "121411842",
            "K78_KODAS_IS_1": "001",
            "K78_MOD": "RO",
            "K78_KODAS_OP": "010R00000001"
        }
    }
}

Response (status 200 OK)

XML response

<RET_DOK>
    <K78>
        <K78_KODAS_DO>010R00000001</K78_KODAS_DO>
        <K78_ID></K78_ID>
        <K78_TIPAS>1</K78_TIPAS>
        <K78_DATE>2023-12-31T00:00:00</K78_DATE>
        <K78_DOK_NR>DOK_NR1</K78_DOK_NR>
        <K78_PAV></K78_PAV>
        <K78_KODAS_IS_1>001</K78_KODAS_IS_1>
        <K78_KODAS_IS_2></K78_KODAS_IS_2>
        <K78_KODAS_KS>121411842</K78_KODAS_KS>
        <K78_MOD></K78_MOD>
        <K78_KODAS_OP></K78_KODAS_OP>
        <K78_EIL_NR>0</K78_EIL_NR>
        <K78_EIL_SK>0</K78_EIL_SK>
        <K78_PERKELTA>1</K78_PERKELTA>
        <K78_PERKELTA2>1</K78_PERKELTA2>
        <K78_ADDUSR>RIVILE</K78_ADDUSR>
        <K78_ADD_DATE>2023-12-31T23:59:59</K78_ADD_DATE>
        <K78_USERIS>RIVILE</K78_USERIS>
        <K78_R_DATE>2023-12-31T23:59:59</K78_R_DATE>
    </K78>
</RET_DOK>

JSON response

{
    "K78": {
        "K78_KODAS_DO": "010R00000001",
        "K78_ID": "",
        "K78_TIPAS": "1",
        "K78_DATE": "2023-12-31T00:00:00",
        "K78_DOK_NR": "DOK_NR1",
        "K78_PAV": "",
        "K78_KODAS_IS_1": "001",
        "K78_KODAS_IS_2": "",
        "K78_KODAS_KS": "121411842",
        "K78_MOD": "",
        "K78_KODAS_OP": "",
        "K78_EIL_NR": "0",
        "K78_EIL_SK": "0",
        "K78_PERKELTA": "1",
        "K78_PERKELTA2": "1",
        "K78_ADDUSR": "RIVILE",
        "K78_ADD_DATE": "2023-12-31T23:59:59",
        "K78_USERIS": "RIVILE",
        "K78_R_DATE": "2023-12-31T23:59:59"
    }
}

Response (status 400)

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

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>1</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data>&lt;K78>&lt;K78_KODAS_IS_1>001&lt;/K78_KODAS_IS_1>&lt;/K78></data>
            <dataErrors>
                <dataError>
                    <tag>k78_kodas_ks</tag>
                    <code>2049</code>
                    <message>Nenurodytas kliento 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>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, 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_K78</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <K78>
            <K78_KODAS_DO>010R00000001</K78_KODAS_DO>
            <K78_DOK_NR>DOK_NR2</K78_DOK_NR>
        </K78>    
    </data>
</body>

pvz trynimas:

<body>
    <method>EDIT_K78</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <K78>
            <K78_KODAS_DO>010R00000001</K78_KODAS_DO>
        </K78>
    </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_K78",
    "params": {
        "oper": "I"
    },
    "data": {
        "K78": {
            "K78_KODAS_KS": "121411842",
            "K78_KODAS_IS_1": "001",
            "K78_MOD": "RO",
            "K78_KODAS_OP": "010R00000001"
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

K78

Dovanų čekių operacijų lentelė

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
K78_KODAS_DO	C(12)	Operacijos Nr.	Privalomas , kai oper=U,D
K78_ID	C(12)	Operacijos Id.
K78_TIPAS	N(3)	Tipas:1-Pardavimas,2-Atsiskaitymas,3-Vidinis,4-Nurašymas
K78_DATE	T(8)	Operacijos data
K78_DOK_NR	C(12)	Dokumento numeris
K78_PAV	C(60)	Pastabos
K78_KODAS_IS_1	C(12)	Padalinys 1
K78_KODAS_IS_2	C(12)	Padalinys 2
K78_KODAS_KS	C(12)	Kliento kodas	Privalomas, kai oper=I
K78_MOD	C(2)	Anal. modulis
K78_KODAS_OP	C(12)	Anal. operacijos Nr.
K78_EIL_NR	N(6)	Anal. eilutės Nr.
K78_EIL_SK	N(6)	Eilučių skaičius operacijoje
K78_PERKELTA	N(1)	Perkelta
K78_PERKELTA2	N(1)	Perkelta 2
K78_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
K78_ADD_DATE	T(8)	Kada sukūrė	Neperduodamas. Pildomas automatiškai, Current Datetime
K78_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
K78_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime
K78_KODAS_LS_1	C(12)	Logistika 1
K78_KODAS_LS_2	C(12)	Logistika 2
K78_KODAS_LS_3	C(12)	Logistika 3
K78_KODAS_LS_4	C(12)	Logistika 4