EDIT_N35

Aprašymas

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

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_N35</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N35>
            <N35_KODAS_LS>LS001</N35_KODAS_LS>
            <N35_PAV>Logistikos pavadinimas 001</N35_PAV>
        </N35>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N35",
    "params": {
        "oper": "I"
    },
    "data": {
        "N35": {
            "N35_KODAS_LS": "LS001",
            "N35_PAV": "Logistikos pavadinimas 001"
        }
    }
}

Response (status 200 OK)

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

pvz:

<RET_DOK>
    <N35>
      <N35_KODAS_LS>LS001       </N35_KODAS_LS>
      <N35_PAV>Logistikos pavadinimas 001</N35_PAV>
      <N35_LYGIS>1</N35_LYGIS>
      <N35_TEVAS>            </N35_TEVAS>
      <N35_TIPAS>0</N35_TIPAS>
      <N35_POZ_DATE>0</N35_POZ_DATE>
      <N35_BEG_DATE>2024-10-01T00:00:00</N35_BEG_DATE>
      <N35_END_DATE>2024-10-01T00:00:00</N35_END_DATE>
      <N35_USERIS>WS          </N35_USERIS>
      <N35_R_DATE>2024-10-01T00:00:00</N35_R_DATE>
      <N35_ADDUSR>WS          </N35_ADDUSR>
      <N35_ADD_DATE>2024-10-01T00:00:00</N35_ADD_DATE>
      <N35_EIL1>                                                            </N35_EIL1>
      <N35_EIL2>                                                            </N35_EIL2>
      <N35_EIL3>                                                            </N35_EIL3>
      <N35_PAV_K1></N35_PAV_K1>
      <N35_PAV_K2></N35_PAV_K2>
      <N35_PAV_K3></N35_PAV_K3>
    </N35>
</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;N35>&lt;/N35></data>
            <dataErrors>
                <dataError>
                    <tag>N35_KODAS_LS</tag>
                    <code>5009</code>
                    <message>Kodas nerastas</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_N35</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N35>
            <N35_KODAS_LS>LS001</N35_KODAS_LS>
            <N35_PAV>Logistikos pavadinimas naujas</N35_PAV>
        </N35>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_N35</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N35>
            <N35_KODAS_LS>LS001</N35_KODAS_LS>
        </N35>
    </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_N35",
        "params": {
            "oper": "I"
        },
        "data": {
            "N35": {
                "N35_KODAS_LS": "LS001",
                "N35_PAV": "Logistikos pavadinimas 001"
            }
    }
    }');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N35

Logistikos informacija

Laukas	Tipas	Aprašymas
N35_KODAS_LS	char(12)	Logistikos kodas
N35_PAV	char(150)	Pavadinimas
N35_LYGIS	numeric(3,0)	Lygis
N35_TEVAS	char(12)	Aukštesnio lygio logistikos kodas
N35_TIPAS	numeric(1,0)	Tipas:1-suminė,2-detali
N35_POZ_DATE	numeric(1,0)	Terminuotas:0-ne,1-taip
N35_BEG_DATE	datetime	Pradžios data
N35_END_DATE	datetime	Pabaigos data
N35_USERIS	char(12)	Kas koregavo
N35_R_DATE	datetime	Kada koregavo
N35_ADDUSR	char(12)	Kas sukūrė
N35_ADD_DATE	datetime	Kada sukūrė
N35_EIL1	char(60)	Aprašymo eilutė 1
N35_EIL2	char(60)	Aprašymo eilutė 2
N35_EIL3	char(60)	Aprašymo eilutė 3
N35_PAV_K1	char(100)	Pavadinimas kita kalba 1
N35_PAV_K2	char(100)	Pavadinimas kita kalba 2
N35_PAV_K3	char(100)	Pavadinimas kita kalba 3