Redaguoti

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

EDIT_N07

Aprašymas

Objekto kortelės koregavimas.

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

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.

pvz application/xml:

<body>
    <method>EDIT_N07</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N07>
            <N07_KODAS_IS>01</N07_KODAS_IS>
            <N07_PAV>UAB Rivilė Vilnius</N07_PAV>
        </N07>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N07",
    "params": {
        "oper": "I"
    },
    "data": {
        "N07": {
            "N07_KODAS_IS": "01",
            "N07_PAV": "UAB Rivilė Vilnius"
        }
    }
}

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>
    <N07>
        <Row_number>1</Row_number>
        <N07_KODAS_IS>01</N07_KODAS_IS>
        <N07_PAV>UAB Rivilė Vilnius</N07_PAV>
        <N07_RESURSAS>0</N07_RESURSAS>
        <N07_KODAS_RE>            </N07_KODAS_RE>
        <N07_PAD_TIP>  </N07_PAD_TIP>
        <N07_PAD_GR1>  </N07_PAD_GR1>
        <N07_PAD_GR2>  </N07_PAD_GR2>
        <N07_EIL1>                                        </N07_EIL1>
        <N07_EIL2>                                        </N07_EIL2>
        <N07_EIL3>                                        </N07_EIL3>
        <N07_NUTOLES>0</N07_NUTOLES>
        <N07_FIX_POZ>0</N07_FIX_POZ>
        <N07_PVM_KAIN>0</N07_PVM_KAIN>
        <N07_IM_ID>00</N07_IM_ID>
        <N07_NUOLAIDOS>1</N07_NUOLAIDOS>
        <N07_KAINA_POZ>0</N07_KAINA_POZ>
        <N07_KODAS_SS>            </N07_KODAS_SS>
        <N07_POZ_DATE>0</N07_POZ_DATE>
        <N07_BEG_DATE>2020-09-25 00:00:00.000</N07_BEG_DATE>
        <N07_END_DATE>2020-09-25 00:00:00.000</N07_END_DATE>
        <N07_ADDUSR>USERABC      </N07_ADDUSR>
        <N07_USERIS>USERABC      </N07_USERIS>
        <N07_R_DATE>2020-09-25 11:23:08.000</N07_R_DATE>
        <N07_KODAS_VS>            </N07_KODAS_VS>
        <N07_KODAS_LS_1>            </N07_KODAS_LS_1>
        <N07_KODAS_LS_2>            </N07_KODAS_LS_2>
        <N07_KODAS_LS_3>            </N07_KODAS_LS_3>
        <N07_KODAS_LS_4>            </N07_KODAS_LS_4>
        <N07_KODAS_TM>            </N07_KODAS_TM>
        <N07_REZERVAS>0                                       </N07_REZERVAS>
        <N07_KODAS_LS_5>            </N07_KODAS_LS_5>
        <N07_KODAS_LS_6>            </N07_KODAS_LS_6>
        <N07_KODAS_LS_7>            </N07_KODAS_LS_7>
        <N07_KODAS_LS_8>            </N07_KODAS_LS_8>
        <N07_VADOVAS>                                                            </N07_VADOVAS>
        <N07_TELEF>                                        </N07_TELEF>
        <N07_FAX>                                        </N07_FAX>
        <N07_EIL4>                                                            </N07_EIL4>
        <N07_EIL5>                                                            </N07_EIL5>
        <N07_EIL6>                                                            </N07_EIL6>
        <N07_KODAS_FR_LNF>            </N07_KODAS_FR_LNF>
        <N07_KODAS_TM_P>            </N07_KODAS_TM_P>
        <N07_KODAS_ZN>            </N07_KODAS_ZN>
        <N07_GLN>                    </N07_GLN>
    </N07>
</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;N07>&lt;/N07></data>
            <dataErrors>
                <dataError>
                    <tag>N06_KODAS_IS</tag>
                    <code>2029</code>
                    <message>Nenurodytas 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 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). Negalima išmesti įrašo, jeigu jis jau dalyvauja apskaitoje.

Koreguojant informaciją bus koreguojami tik perduodami laukai.

pvz koregavimas:

<body>
    <method>EDIT_N07</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N07>
            <N07_KODAS_IS>01</N07_KODAS_IS>
            <N07_PAV>UAB Rivilė Vilnius 01</N07_PAV>
        </N07>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_N07</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N07>
            <N07_KODAS_IS>01</N07_KODAS_IS>
        </N07>
    </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

N07

Laukas	Tipas	Aprašymas	Pastabos
N07_KODAS_IS	C(12)	Padalinio kodas	Privalomas
N07_PAV	C(40)	Padalinio pavadinimas
N07_RESURSAS	N(1)	Resurso požymis:0-Ne,1-Taip (default=0)
N07_KODAS_RE	C(12)	Resurso kodas
N07_PAD_TIP	C(2)	Padalinio tipas(informacinis)
N07_PAD_GR1	C(2)	Padalinio grupė 01(informacinė)
N07_PAD_GR2	C(2)	Padalinio grupė 02(informacinė)
N07_EIL1	C(40)	Aprašymo eilutė 1
N07_EIL2	C(40)	Aprašymo eilutė 2
N07_EIL3	C(40)	Aprašymo eilutė 3
N07_NUTOLES	N(1)	Padalinio požymis:0-nenutolęs,1-nutolęs (default=0)
N07_FIX_POZ	N(1)	Pardavimo kainų automatinis keitimas:0-Ne,1-Taip (default=0)
N07_PVM_KAIN	N(1)	Pardavimo kainų požymis:0-be PVM,1-su PVM (default=0)
N07_IM_ID	C(2)	Įmonės identifikacija	Privalomas, kai oper=`I`. Jeigu nepaduodamas, imamas pagal įmonės kurioje dirbama. Nekoreguojamas laukas.
N07_NUOLAIDOS	N(1)	Nuolaidų požymis:0-Netaikomos,1-Taikomos (default=0)
N07_KAINA_POZ	N(1)	Pardavimo kainos pagal serijas: 0-ne,1-taip (default=0)
N07_KODAS_SS	C(12)	Nutolusio padalinio sąskaitos kodas
N07_POZ_DATE	N(1)	Terminuotas:0-Ne,1-Taip (default=0)
N07_BEG_DATE	T(8)	Pradžios data (default=Current Date)
N07_END_DATE	T(8)	Pabaigos data (default=Current Date)
N07_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai (oper=`I`), ApiKey - pirmi 7 simboliai
N07_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N07_R_DATE	T(8)	Koregavimo laikas	Neperduodamas. Pildomas automatiškai, Current Datetime
N07_KODAS_VS	C(12)	Vietovės kodas
N07_KODAS_LS_1	C(12)	Logistika 1
N07_KODAS_LS_2	C(12)	Logistika 2
N07_KODAS_LS_3	C(12)	Logistika 3
N07_KODAS_LS_4	C(12)	Logistika 4
N07_KODAS_TM	C(12)	Terminalas
N07_REZERVAS	C(40)	Rezervas
N07_KODAS_LS_5	C(12)	Logistika 5
N07_KODAS_LS_6	C(12)	Logistika 6
N07_KODAS_LS_7	C(12)	Logistika 7
N07_KODAS_LS_8	C(12)	Logistika 8
N07_VADOVAS	C(60)	Vadovas
N07_TELEF	C(40)	Telefonai
N07_FAX	C(40)	Faksai
N07_EIL4	C(60)	Aprašymo eilutė 4
N07_EIL5	C(60)	Aprašymo eilutė 5
N07_EIL6	C(60)	Aprašymo eilutė 6
N07_KODAS_FR_LNF	C(12)	Formulė lokacijų generavimui
N07_KODAS_TM_P	C(12)	Priėmimo terminalas
N07_KODAS_ZN	C(12)	Zona
N07_GLN	C(20)	GLN kodas

EDIT_N07

Aprašymas

Specifikacija

Address

Header

Body

Response (status 200 OK)

Response (status 400)

Response (status 401)

Response (status 500)

Koregavimas ir išmetimas

PHP pvz

Lentelės

N07