EDIT_N67

Aprašymas

Intrastato klasifikatorių kortelės koregavimas

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

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_N67</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N67>
          <N67_KODAS_IA>INTRAK_001</N67_KODAS_IA>
          <N67_PAV></N67_PAV>
          <N67_APR></N67_APR>
          <N67_TIPAS>1</N67_TIPAS>
          <N67_POZ_DATE>0</N67_POZ_DATE>
          <N67_BEG_DATE>2024-09-13T00:00:00</N67_BEG_DATE>
          <N67_END_DATE>2024-09-13T00:00:00</N67_END_DATE>
        </N67>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N67",
    "params": {
        "oper": "I"
    },
    "data": {
        "N67": {
            "N67_KODAS_IA": "INTRAK_001",
            "N67_PAV": "",
            "N67_APR": "",
            "N67_TIPAS": "1",
            "N67_POZ_DATE": "0",
            "N67_BEG_DATE": "2024-09-13T00:00:00",
            "N67_END_DATE": "2024-09-13T00:00:00"
        }
    }
}
Response (status 200 OK)

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

pvz:

<RET_DOK>
    <N67>
      <N67_KODAS_IA>INTRAK_001</N67_KODAS_IA>
      <N67_PAV></N67_PAV>
      <N67_APR></N67_APR>
      <N67_TIPAS>1</N67_TIPAS>
      <N67_POZ_DATE>0</N67_POZ_DATE>
      <N67_BEG_DATE>2024-09-13T00:00:00</N67_BEG_DATE>
      <N67_END_DATE>2024-09-13T00:00:00</N67_END_DATE>
      <N67_ADDUSR>USER          </N67_ADDUSR>
      <N67_USERIS>USER          </N67_USERIS>
      <N67_R_DATE>2024-09-13T11:20:28</N67_R_DATE>
      <N67_ADD_DATE>2024-09-13T11:20:28</N67_ADD_DATE>
    </N67>
</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>4641133481.8ec4537a.1716271246499</id>
    <durationMs>569</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data>&lt;N67>&lt;/N67></data>
            <dataErrors>
                <dataError>
                    <tag>N67_KODAS_IA</tag>
                    <code>19018</code>
                    <message>Nerastas 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 ir išmetimas

Koregavimas, išmetimas vyksta pagal lentelės raktą (Primary Key)

Koreguojant informaciją bus koreguojami tik perduodami laukai.

pvz koregavimas:

<body>
    <method>EDIT_N67</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N67>
            <N67_KODAS_IA>INTRAK_001</N67_KODAS_IA>
            <N67_PAV>Intrastato klasifikatoriaus naujas pavadinimas</N67_PAV>
        </N67>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_N67</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N67>
            <N67_KODAS_IA>INTRAK_001</N67_KODAS_IA>
        </N67>
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: 9999999.12345678910',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
        "method": "EDIT_N67",
        "params": {
            "oper": "I"
        },
        "data": {
            "N67": {
                "N67_KODAS_IA": "INTRAK_001",
                "N67_PAV": "",
                "N67_APR": "",
                "N67_TIPAS": "1",
                "N67_POZ_DATE": "0",
                "N67_BEG_DATE": "2024-09-13T00:00:00",
                "N67_END_DATE": "2024-09-13T00:00:00"
            }
        }
    }');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N67

Intrastato klasifikatoriaus informacija

Laukas Tipas Aprašymas Pastabos
N67_KODAS_IA CHAR(12) Klasifikatoriaus kodas
N67_PAV CHAR(100) Pavadinimas
N67_APR CHAR(100) Pastabos
N67_TIPAS NUMERIC(3) Tipas
N67_POZ_DATE NUMERIC(1) Ar terminuota?
N67_BEG_DATE DATETIME Termino pradžios data
N67_END_DATE DATETIME Termino pabaigos data
N67_ADDUSR CHAR(12) Kas sukūrė
N67_USERIS CHAR(12) Kas koregavo
N67_R_DATE DATETIME Kada koregavo
N67_ADD_DATE DATETIME Kada sukūrė