EDIT_N87

Aprašymas

Prekės tiekėjo kodų 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_N87
params :
- oper :
  - I - naujo įrašo sukūrimas
  - U - įrašo koregavimas
  - D - įrašo ištrynimas
data: perduodami duomenys:
- N87 - atitinkamos lentelės laukai (N87)

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_N87</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N87>
            <N87_KODAS_PS>PREKEX</N87_KODAS_PS>
            <N87_KODAS_US>VNT</N87_KODAS_US>
            <N87_KODAS_KS>123456789</N87_KODAS_KS>
            <N87_KODAS>TK-123</N87_KODAS>
        </N87>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N87",
    "params": {
        "oper": "I"
    },
    "data": {
          "N87": {
            "N87_KODAS_PS": "PREKEX",
            "N87_KODAS_US": "VNT",
            "N87_KODAS_KS": "123456789",
            "N87_KODAS": "TK-123"
          }
    }
}

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>
        <N87>
            <N87_KODAS_PS>PREKEX</N87_KODAS_PS>
            <N87_KODAS_US>VNT</N87_KODAS_US>
            <N87_KODAS_KS>123456789</N87_KODAS_KS>
            <N87_KODAS>TK-123</N87_KODAS>
            ...
        </N87>
</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;N87>&lt;/N87></data>
            <dataErrors>
                <dataError>
                    <tag>N87_KODAS_PS</tag>
                    <code>8003</code>
                    <message>Tokio įrašo nėra</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_N87</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N87>
            <N87_KODAS_PS>PREKEX</N87_KODAS_PS>
            <N87_KODAS_US>VNT</N87_KODAS_US>
            <N87_KODAS_KS>123456789</N87_KODAS_KS>
            <N87_KODAS>TK-123NEW</N87_KODAS>
        </N87>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_N87</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N87>
            <N87_KODAS_PS>PREKEX</N87_KODAS_PS>
            <N87_KODAS_US>VNT</N87_KODAS_US>
            <N87_KODAS_KS>123456789</N87_KODAS_KS>
        </N87>
    </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

N87

Prekės tiekėjo kodų lentelė

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
N87_KODAS_PS	C(12)	Prekė	Privalomas
N87_KODAS_US	C(12)	Mat.Vnt.	Privalomas
N87_KODAS_KS	C(12)	Klientas	Privalomas
N87_PAV	C(100)	Pavadinimas
N87_KODAS	C(100)	Kliento prekės kodas
N87_APRASYMAS	C(100)	Aprašymas
N87_EIL1	C(100)	Eilutė 1
N87_EIL2	C(100)	Eilutė 2
N87_EIL3	C(100)	Eilutė 3
N87_NUM1	N(14,4)	Skaičius 1
N87_NUM2	N(14,4)	Skaičius 2
N87_NUM3	N(14,4)	Skaičius 3
N87_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N87_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime
N87_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai