EDIT_I09

Aprašymas

Vidinių dokumentų koregavimas (antraštės)

Specifikacija

Address

POST https://api.manorivile.lt/client/v2

  • 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_I09
  • params :
    • oper :
      • I - naujo įrašo sukūrimas
      • U - įrašo koregavimas
      • D - įrašo ištrynimas
      • P - informacijos perkėlimas
  • data: perduodami duomenys:
    • I09 - atitinkamos lentelės laukai (i09)

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.

Koreguoti galima tik to paties API vartotojo sukurtas operacijas. Teisės valdomos parametru RGI_ALL_EDIT

Yra galimybė dirbti su papildomomis dimensijomis, jeigu tokios naudojamos Rivile GAMA sistemoje. Tam naudojami tag'ai <I49_DIM01> ... <I49_DIM15>

pvz application/xml:

<body>
    <method>EDIT_I09</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
      <I09>
         <I09_TIPAS>2</I09_TIPAS>
         <I09_DOK_NR>VID20191029</I09_DOK_NR>
         <I09_IS_DATA>2019-10-29</I09_IS_DATA>
         <I09_GAV_DATA>2019-10-29</I09_GAV_DATA>
         <I09_KODAS_IS1>PAD1</I09_KODAS_IS1>
         <I09_KODAS_IS2>PAD1</I09_KODAS_IS2>
         <I49_DIM01>MEN1</I49_DIM01> <!--Jeigu naudojamos dimensijos -->
     </I09>  
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_I09",
    "params": {
        "oper": "I"
    },
    "data": {
        "I09": {
            "I09_TIPAS": 2,
            "I09_DOK_NR": "VID20191029",
            "I09_IS_DATA": "2019-10-29",
            "I09_GAV_DATA": "2019-10-29",
            "I09_KODAS_IS1":"PAD1",
            "I09_KODAS_IS2":"PAD2",
            "I49_DIM01": "MEN1"
        }
    }
}
Response (status 200 OK)

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

pvz:

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <I09>
         <I09_KODAS_VD>010R00000063</I09_KODAS_VD>
         <I09_TIPAS>2</I09_TIPAS>
         <I09_DOK_NR>VID20191029 </I09_DOK_NR>
         <I09_IS_DATA>2019-10-29 00:00:00.000</I09_IS_DATA>
         <I09_GAV_POZ>0</I09_GAV_POZ>
         <I09_GAV_DATA>2019-10-29 00:00:00.000</I09_GAV_DATA>
         <I09_KODAS_IS1>PAD1 </I09_KODAS_IS1>
         <I09_KODAS_SS_T> </I09_KODAS_SS_T>
         <I09_NUTOL1>0</I09_NUTOL1>
         <I09_KODAS_IS2>PAD1 </I09_KODAS_IS2>
        ...
         <i09_busena>1</i09_busena>
         <I49_DIM01>MEN1</I49_DIM01>
     </I09>
</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>14433105830.9def1bf4.1584217427751</id>
    <durationMs>45</durationMs>
    <errorMessage>nepavyko įvykdyti metodo</errorMessage>
    <errors>
        <error>
            <data>&lt;I09>&lt;/I09></data>
            <dataErrors>
                <dataError>
                    <tag>I09_KODAS_VD</tag>
                    <code>21001</code>
                    <message>Nėra operacijos</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 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, perkėlimas ir trynimas

Koregavimas, trynimas vyksta pagal lentelės raktą (Primary Key)

Koreguojant informaciją bus koreguojami tik perduodami laukai.

pvz koregavimas:

<body>
    <method>EDIT_I09</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
      <I09>
         <I09_KODAS_VD>01R000000001</I09_KODAS_VD>
         <I09_IS_DATA>2019-10-29</I09_IS_DATA>
         <I09_GAV_DATA>2019-10-29</I09_GAV_DATA>
         <I09_KODAS_IS1>PAD1</I09_KODAS_IS1>
         <I09_KODAS_IS2>PAD1</I09_KODAS_IS2>
     </I09>    
    </data>
</body>

pvz trynimas:

<body>
    <method>EDIT_I09</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <I09>
            <I09_KODAS_VD>01R000000001</I09_KODAS_VD>
        </I09>      
    </data>
</body>

pvz perkėlimas:

<body>
    <method>EDIT_I09</method>
    <params>
        <oper>P</oper>
    </params>
    <data>
        <I09>
            <I09_KODAS_VD>01R000000001</I09_KODAS_VD>
        </I09>      
    </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

I09

Vidinių dokumentų koregavimas (antraštė)

Laukas Tipas Aprašymas Pastabos naudojant EDIT metodus
I09_KODAS_VD C(12) Operacijos numeris Privalomas (kai oper=U,D,P)
I09_TIPAS N(1) Dokumento tipas:1-važtaraštis,2-užsakymas Privalomas, kai oper=I
I09_DOK_NR C(12) Dokumento numeris Privalomas, kai oper=I
I09_IS_DATA T(8) Išvežimo data Privalomas, kai oper=I
I09_GAV_POZ N(1) Rezervas
I09_GAV_DATA T(8) Prekių gavimo data Privalomas, kai oper=I
I09_KODAS_IS1 C(12) Padalinio kodas iš kurio veža Privalomas, kai oper=I
I09_KODAS_SS_T C(12) Analitinės operacijos numeris
I09_NUTOL1 N(1) Padalinys iš kurio veža nutolęs?:0-ne,1-taip
I09_EIL1 C(40) Padalinio aprašymo 1 eilutė
I09_EIL2 C(40) Padalinio aprašymo 2 eilutė
I09_EIL3 C(40) Padalinio aprašymo 3 eilutė
I09_KODAS_IS2 C(12) Padalinio gavėjo kodas Privalomas, kai oper=I
I09_NUTOL2 N(1) Ar padalinys gavėjas nutolęs?:0-ne,1-taip
I09_A_EIL1 C(40) Padalinio gavėjo aprašymo 1 eilutė
I09_A_EIL2 C(40) Padalinio gavėjo aprašymo 2 eilutė
I09_A_EIL3 C(40) Padalinio gavėjo aprašymo 3 eilutė
I09_PERKELTA1 N(1) Pirmos dalies perkėlimas:1-neperkelta,2-perkelta,3-kore
I09_PERKELTA2 N(1) Antros dalies perkėlimas:1-neperkelta,2-perkelta,3-kore
I09_IMP_EXP N(1) Rezervas
I09_USERIS C(12) Kas koregavo
I09_R_DATE T(8) Koregavimo Laikas
I09_ADDUSR C(12) Kas sukūrė
I09_EIL_SK N(12,2) Eilučių skaičius
I09_KODAS_SM1 C(12) Asmuo
I09_KODAS_SM2 C(12) Asmuo 2
I09_PAV C(60) Aprašymas
I09_KODAS_MS C(12) Menedžerio kodas
I09_KODAS_LS_1 C(12) Logistika 1
I09_KODAS_LS_2 C(12) Logistika 2
I09_KODAS_LS_3 C(12) Logistika 3
I09_KODAS_LS_4 C(12) Logistika 4
I09_ADD_DATE T(8) Kada sukūrė
I09_PER1_DATE T(8) Kada koreguotas pirmas perkėlimas
I09_PER1_USER C(12) Kas koregavo pirmą perkėlimą
I09_KODAS_AU C(12) Automobilio kodas
I09_KODAS_ZN C(12) Zona
I09_KODAS_MS2 C(12) Menedžeris 2
I09_BUSENA N(3) Būsena
I49_DIM01, ... , I49_DIM15 C(12) Dimensijos