Back to Gidas

EDIT_I01

internetiniai-underscore-moduliai-api-underscore-rest-edit-underscore-i01.md

latest4.9 KB
Original Source

PDF

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

EDIT_I01

Aprašymas

DK žurnalo koregavimas.

Specifikacija

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

Body
  • method : EDIT_I01

  • params :

    • oper :

      • I - naujo žurnalo sukūrimas (numatytasis)
      • U - žurnalo koregavimas
      • D - žurnalo ištrynimas
    • user : vartotojo vardas (naudojamas dokumentų skaitliukams, parametrams ir kt.), veikia tik rakto prefix'ui įjungus parametrą RGI_USR_EDIT

  • data: perduodami duomenys:

    • I01 - atitinkamos lentelės laukai (I01)
XML request
xml
<body>
    <method>EDIT_I01</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <I01>
            <I01_KODAS_ZS>DK1</I01_KODAS_ZS>
            <I01_PAV>API test</I01_PAV>
        </I01>
    </data>
</body>
JSON request
json
{
    "method": "EDIT_I01",
    "params": {
        "oper": "I"
    },
    "data": {
        "I01": {
            "I01_KODAS_ZS": "DK1",
            "I01_PAV": "API test"
        }
    }
}
Response (status 200 OK)
XML response
xml
<RET_DOK>
    <I01>
        <I01_KODAS_ZS>DK1</I01_KODAS_ZS>
        <I01_PAV>API test</I01_PAV>
        <I01_EXP_IMP>0</I01_EXP_IMP>
        <I01_POZ>2</I01_POZ>
        <I01_POZ_DATE>0</I01_POZ_DATE>
        <I01_BEG_DATE>2024-01-01T00:00:00</I01_BEG_DATE>
        <I01_END_DATE>2024-01-01T00:00:00</I01_END_DATE>
        <I01_ADDUSR>WS</I01_ADDUSR>
        <I01_USERIS>WS</I01_USERIS>
        <I01_R_DATE>2024-01-01T00:00:01</I01_R_DATE>
        <I01_MODUL></I01_MODUL>
    </I01>
</RET_DOK>
JSON response
json
{
    "I01": {
        "I01_KODAS_ZS": "DK1",
        "I01_PAV": "API test",
        "I01_EXP_IMP": 0,
        "I01_POZ": 2,
        "I01_POZ_DATE": 0,
        "I01_BEG_DATE": "2024-01-01T00:00:00",
        "I01_END_DATE": "2024-01-01T00:00:00",
        "I01_ADDUSR": "WS",
        "I01_USERIS": "WS",
        "I01_R_DATE": "2024-01-01T00:00:01",
        "I01_MODUL": ""
    }
}
Response (status 400)

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

xml
<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>1</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data></data>
            <dataErrors>
                <dataError>
                    <tag>I01_KODAS_ZS</tag>
                    <code>552177</code>
                    <message>Toks žurnalas jau yra</message>
                </dataError>
            </dataErrors>
        </error>
    </errors>
</RET_DOK>
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 :

xml
<body>
    <method>EDIT_I01</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <I01>
            <I01_KODAS_ZS>DK1</I01_KODAS_ZS>
            <I01_PAV>API test - papildyta</I01_PAV>
        </I01>
    </data>
</body>

pvz trynimas :

xml
<body>
    <method>EDIT_I01</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <I01>
            <I01_KODAS_ZS>DK1</I01_KODAS_ZS>
        </I01>
    </data>
</body>

PHP pvz

php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: uUCz6UY.sKVrjaWRDJAH1c7l4qL2nOok2K0jARkklHDdYsss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "EDIT_I01",
    "params": {
        "oper": "I"
    },
    "data": {
        "I01": {
            "I01_KODAS_ZS": "DK1",
            "I01_PAV": "API test"
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I01

DK žurnalų sąrašas

LaukasTipasAprašymasPastabos
I01_KODAS_ZSC(12)DK Žurnalo kodasPrivalomas
I01_PAVC(40)DK žurnalo pavadinimas
I01_EXP_IMPN(1)Rezervas
I01_POZN(1)Požymis:1-sisteminis,2-nesisteminis
I01_POZ_DATEN(1)Terminuotas:0-Ne,1-Taip
I01_BEG_DATET(8)Pradžios data
I01_END_DATET(8)Pabaigos data
I01_ADDUSRC(12)Kas sukūrėNeperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I01_USERISC(12)Kas koregavoNeperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I01_R_DATET(8)Koregavimo laikasNeperduodamas. Pildomas automatiškai, Current Datetime
I01_MODULC(2)Modulio Id.