EDIT_N47

Aprašymas

Koreguoti prekės/paslaugos padalinių informaciją

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

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_N47</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N47>
             <N47_KODAS_IS>PAD2 </N47_KODAS_IS>
             <N47_KODAS_PS>DAZAI </N47_KODAS_PS>
             <N47_KODAS_US>KG </N47_KODAS_US>
             <N47_FRAKCIJA>1000</N47_FRAKCIJA>
             <N47_MINIMUMAS>1000</N47_MINIMUMAS>
             <N47_UZSAKYTI>2000</N47_UZSAKYTI>
             <N47_MIN_P>1000</N47_MIN_P>
             <N47_POZ_DATE>0</N47_POZ_DATE>
             <N47_UZSAKYTI1>0</N47_UZSAKYTI1>
             <N47_UZSAKYTI2>0</N47_UZSAKYTI2>
             <N47_UZSAKYTI3>0</N47_UZSAKYTI3>
             <N47_MIN_UZS>1000</N47_MIN_UZS>
         </N47>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N47",
    "params": {
        "oper": "I"
    },
    "data": {
          "N47": {
              "N47_KODAS_IS": "PAD2 ",
              "N47_KODAS_PS": "DAZAI ",
              "N47_KODAS_US": "KG ",
              "N47_FRAKCIJA": "1000",
              "N47_MINIMUMAS": "1000",
              "N47_UZSAKYTI": "2000",
              "N47_MIN_P": "1000",
              "N47_POZ_DATE": "0",
              "N47_UZSAKYTI1": "0",
              "N47_UZSAKYTI2": "0",
              "N47_UZSAKYTI3": "0",
              "N47_MIN_UZS": "1000"
          }
    }
}

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>
    <N47>
         <N47_KODAS_IS>PAD2 </N47_KODAS_IS>
         <N47_KODAS_PS>DAZAI </N47_KODAS_PS>
         <N47_KODAS_US>KG </N47_KODAS_US>
         <N47_FRAKCIJA>1000</N47_FRAKCIJA>
         <N47_MINIMUMAS>1000</N47_MINIMUMAS>
         <N47_UZSAKYTI>2000</N47_UZSAKYTI>
         <N47_MIN_P>1000</N47_MIN_P>
         <N47_POZ_DATE>0</N47_POZ_DATE>
         <N47_UZSAKYTI1>0</N47_UZSAKYTI1>
         <N47_UZSAKYTI2>0</N47_UZSAKYTI2>
         <N47_UZSAKYTI3>0</N47_UZSAKYTI3>
         <N47_MIN_UZS>1000</N47_MIN_UZS>
        ...
     </N47>
  </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;N47>&lt;/N47></data>
            <dataErrors>
                <dataError>
                    <tag>N47_KODAS_PS</tag>
                    <code>6010</code>
                    <message>Egzistuoja toks 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_N47</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N47>
             <N47_KODAS_IS>PAD2 </N47_KODAS_IS>
             <N47_KODAS_PS>DAZAI </N47_KODAS_PS>
             <N47_KODAS_US>KG </N47_KODAS_US>
             <N47_UZSAKYTI>2000</N47_UZSAKYTI>
         </N47>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_N47</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N47>
             <N47_KODAS_IS>PAD2 </N47_KODAS_IS>
             <N47_KODAS_PS>DAZAI </N47_KODAS_PS>
             <N47_KODAS_US>KG </N47_KODAS_US>
         </N47>
    </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

N47

Papildomos prekės/paslaugos padalinių lentelė.

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
N47_KODAS_IS	C(12)	Padalinio kodas	Privalomas
N47_KODAS_PS	C(12)	Prekės kodas	Privalomas
N47_KODAS_US	C(12)	Matavimo vienetas	Privalomas
N47_FRAKCIJA	N(4)	Frakcija
N47_MINIMUMAS	N(14)	Minimalus kiekis padalinyje
N47_UZSAKYTI	N(14)	Užsakyti, kai trūksta
N47_MIN_P	N(14)	Minimumas pagrindiniu matu
N47_KODAS_IS1	C(12)	Logistikos kodas 01
N47_KODAS_IS2	C(12)	Logistikos kodas 02
N47_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N47_R_DATE	T(8)	Koregavimo laikas	Neperduodamas. Pildomas automatiškai, Current Datetime
N47_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N47_PAV	C(40)	Aprašymas
N47_POZ_DATE	N(1)	Ar terminuota
N47_BEG_DATE	T(8)	Pradžios data
N47_END_DATE	T(8)	Pabaigos data
N47_UZSAKYTI1	N(14)	Užsakymas 1
N47_UZSAKYTI2	N(14)	Užsakymas 2
N47_UZSAKYTI3	N(14)	Užsakymas 3
N47_MIN_UZS	N(14)	Minimalus užsakymas
N47_KODAS_LS_1	C(12)	Logistikos kodas 1
N47_KODAS_LS_2	C(12)	Logistikos kodas 2
N47_KODAS_LS_3	C(12)	Logistikos kodas 3
N47_KODAS_LS_4	C(12)	Logistikos kodas 4
N47_KODAS_LS_5	C(12)	Logistikos kodas 5
N47_KODAS_LS_6	C(12)	Logistikos kodas 6
N47_KODAS_LS_7	C(12)	Logistikos kodas 7
N47_KODAS_LS_8	C(12)	Logistikos kodas 8
N47_SVS	N(1)	Nenaudojama SVS 1-Taip,0-Ne
N47_KODAS_MS	C(12)	Menedžerio kodas