EDIT_K00

Aprašymas

Operacijų ir kortelių dokumentų sąrašo nuorodų koregavimas

Specifikacija

Informacija apie autorizaciją, bendruosius parametrus ir klaidų kodus: Rivile API v2 naudojimo pagrindai

Body

method : EDIT_K00
params :
- oper :
  - I - naujos operacijos sukūrimas
  - U - operacijos koregavimas
  - D - operacijos išmetimas
- user - vartotojo vardas (naudojamas dokumentų skaitliukams, parametrams ir kt.), veikia tik rakto prefix'ui įjungus parametrą RGI_USR_EDIT
data: perduodami duomenys:
- K00 - operacijų dokumentai (k00)

K00_MODUL nurodomas modulis į kurį norėsime importuoti perduotą informaciją. Keli modulių kodų pvz.: RO - pardavimai, PO - pirkimai, CH - įplaukos, CI - išmokos, PS - prekių kortelės, KS - klientų kortelės.

K00_MODUL_NR nurodomas operacijos arba kortelės raktas, gali būti raktų junginys jei jį sudero kelios dalys. Operacijoms nurodomas operacijos kodas (pvz. pirkimai / pardavimai - I06_KODAS_PO, įplaukos / išmokos - I04_KODAS_CH), kortelėms - kortelės kodas (pvz. prekių kortelės - N17_KODAS_PS, klientų kortelės - N08_KODAS_KS). Jungtinių raktų pavyzdžiai: pirkimo operacijos detali eilutė - I07_KODAS_PO + RIGHT(' ' + I07_EIL_NR, 6), prekės kortelės matavimo vienetas - RIGHT(' ' + N37_KODAS_PS, 12) + RIGHT(' ' + N37_KODAS_US, 12).

Operacijų arba kortelių raktams perduoti vietoje lauko K00_MODUL_NR galima naudoti KODAS1, KODAS2, ..., KODAS5 laukus. Pvz. prekės kortelės matavimo vienetas: KODAS1 - N37_KODAS_PS, KODAS2 - N37_KODAS_US.

Failų perdavimas nepalaikomas, metodas skirtas tik nuorodų išsaugojimui operacijų ar kortelių dokumentų sąraše.

K00_TIPAS reikšmių aprašymai:

Reikšmė	Aprašymas
1	Failas - NEPALAIKOMA
2 (reikšmė pagal nutylėjimą)	Nuoroda į failą
3	Nuoroda į katalogą
4	Internetinė nuoroda

pvz application/xml:

xml

<body>
    <method>EDIT_K00</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <K00>
            <K00_MODUL>PS</K00_MODUL>
            <K00_MODUL_NR>ITEM_NO1</K00_MODUL_NR>
            <K00_TIPAS>4</K00_TIPAS>
            <K00_PAV>Internetinė nuoroda prie prekės "ITEM_NO1" kortelės</K00_PAV>
            <K00_DOK>https://gidas.rivile.lt/internetiniai_moduliai</K00_DOK>
        </K00>
    </data>
</body>

xml

<body>
    <method>EDIT_K00</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <K00>
            <K00_MODUL>RO</K00_MODUL>
            <KODAS1>010000000001</KODAS1>
            <KODAS2> 1</KODAS2>
            <K00_TIPAS>3</K00_TIPAS>
            <K00_PAV>Nuoroda į katalogą prie pardavimo operacijos 1-os eilutės</K00_PAV>
            <K00_DOK>C:\RIV_GAMA\RIV-API\</K00_DOK>
        </K00>
    </data>
</body>

pvz application/json:

json

{
    "method": "EDIT_K00",
    "params": {
        "oper": "I"
    },
    "data": {
        "K00": {
            "K00_MODUL": "CH",
            "KODAS1": "010000000001",
            "KODAS2": " 3",
            "K00_TIPAS": 2,
            "K00_PAV": "Nuoroda į failą prie įplaukų operacijos 3-čios eilutės",
            "K00_DOK": "C:\RIV_GAMA\RIV-API\README.TXT"
        }
    }
}

json

{
    "method": "EDIT_K00",
    "params": {
        "oper": "I"
    },
    "data": {
        "K00": {
            "K00_MODUL": "KS",
            "KODAS1": "121411842",
            "KODAS2": "VILNIUS",
            "K00_TIPAS": 4,
            "K00_PAV": "Internetinė nuoroda prie kliento alternatyvaus adreso",
            "K00_DOK": "https://gidas.rivile.lt/internetiniai_moduliai"
        }
    }
}

Response (status 200 OK)

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

pvz :

xml

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <K00>
        <K00_KODAS_D3>010R00000001</K00_KODAS_D3>
        <K00_USERIS>B1NOONQ </K00_USERIS>
        <K00_R_DATE>2024-10-16T00:00:01</K00_R_DATE>
    </K00>
</RET_DOK>

Response (status 400)

Klaida paduodant duomenis / SQL sintaksės klaidos / kitos DB klaidos

xml

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>0</durationMs>
    <errorMessage>Invalid data</errorMessage>
</RET_DOK>

Koregavimas ir trinimas

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

Koreguojant informaciją bus koreguojami tik perduodami laukai.

pvz trinimas :

xml

<body>
    <method>EDIT_K00</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <K00>
            <K00_KODAS_D3>010R00000001</K00_KODAS_D3>
        </K00>
    </data>
</body>

pvz koregavimas :

xml

<body>
    <method>EDIT_K00</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <K00>
            <K00_KODAS_D3>010R00000001</K00_KODAS_D3>
            <K00_PAV>Pakoreguotas nuorodos aprašymas</K00_PAV>
        </K00>
    </data>
</body>

PHP pvz

php

<?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, '{
    "method": "EDIT_K00",
    "params": {
        "oper": "I"
    },
    "data": {
        "K00": {
            "K00_MODUL": "PO",
            "KODAS1": "010000000001",
            "KODAS2": " 2",
            "K00_TIPAS": 2,
            "K00_PAV": "Nuoroda į failą prie pirkimo operacijos 2-os eilutės",
            "K00_DOK": "C:\RIV_GAMA\RIV-API\SETUP.EXE"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

K00

Operacijų dokumentų lentelė.

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
K00_KODAS_D3	C(12)	Operacijos Nr.	Privalomas kai oper=U,D
K00_MODUL	C(2)	Modulis	Privalomas kai oper=I
K00_MODUL_NR	C(60)	Analitinės Op.Nr.	Privalomas kai oper=I
K00_TIPAS	N(1)	Tipas. 2 - nuoroda į failą (reikšmė pagal nutylėjimą), 3 - nuoroda į katalogą, 4 - internetinė nuoroda
K00_PAV	C(100)	Aprašymas
K00_PLET	C(12)	Plėtinys	Perduota reikšmė ignoruojama
K00_DOK	C(4000)	Nuoroda	Reikšmės ilgis ribojamas iki 4000 simbolių
K00_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
K00_ADD_DATE	T(8)	Kada sukūrė	Neperduodamas. Pildomas automatiškai, Current Datetime
K00_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
K00_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime
K00_APRASYMAS1	C(150)	Aprašymas 1	Nuo v123.0000
K00_APRASYMAS1	C(150)	Aprašymas 2	Nuo v123.0000
K00_APRASYMAS1	C(150)	Aprašymas 3	Nuo v123.0000