EDIT_N33

Aprašymas

Papildomos kliento informacijos (pristatymo informacija, bankinių sąskaitų informacija ir kita) 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_N33
params :
- oper :
  - I - naujo įrašo sukūrimas
  - U - įrašo koregavimas
  - D - įrašo ištrynimas
data: perduodami duomenys:
- N33 - atitinkamos lentelės laukai (N33)

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_N33</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N33>
            <N33_KODAS_KS>304854595</N33_KODAS_KS>
            <N33_KODAS_AK>2</N33_KODAS_AK>
        </N33>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N33",
    "params": {
        "oper": "I"
    },
    "data": {
          "N33": {
            "N33_KODAS_KS": "304854595",
            "N33_KODAS_AK": "2"
          }
    }
}

Response (status 200 OK)

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

pvz:

<?xml version='1.0'?>
<RET_DOK>
    <N33>
        <N33_KODAS_KS>304854595 </N33_KODAS_KS>
        <N33_EIL_NR>0</N33_EIL_NR>
        <N33_PAV> </N33_PAV>
        <N33_ADRESAS> </N33_ADRESAS>
        <N33_KODAS_VS> </N33_KODAS_VS>
        <N33_FAX> </N33_FAX>
        <N33_KODAS_AK>2 </N33_KODAS_AK>
        ...
     </N33>
 </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;N33>&lt;/N33></data>
            <dataErrors>
                <dataError>
                    <tag>N33_KODAS_AK</tag>
                    <code>3001</code>
                    <message>Tokio alternatyvaus adreso 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_N33</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N33>
            <N33_KODAS_KS>304854595</N33_KODAS_KS>
            <N33_KODAS_AK>2</N33_KODAS_AK>
            <N33_PAV>XXX</N33_PAV>
        </N33>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_N33</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N33>
            <N33_KODAS_KS>304854595</N33_KODAS_KS>
            <N33_KODAS_AK>2</N33_KODAS_AK>
        </N33>
    </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

N33

Papildomos kliento informacijos lentelė.

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
N33_KODAS_KS	C(12)	Kliento kodas	Privalomas
N33_EIL_NR	N(6)	Detalios eilutės numeris
N33_PAV	C(150)	Alternatyvus pavadinimas
N33_ADRESAS	C(150)	Adresas
N33_KODAS_VS	C(12)	Vietovės kodas
N33_FAX	C(40)	Fax - numeriai
N33_TEL	C(40)	Telefono numeriai
N33_PAST_KODAS	C(9)	Pašto kodas
N33_SHIP_VIA	C(15)	Pristatymo būdas
N33_SHIP_FOB	C(15)	Pristatymo sąlygos
N33_NUTYL	N(1)	Adreasas ir bankiniai rekvizitai pagal nutylėjimą
N33_KODAS_WS	C(12)	Banko kodas
N33_S_KODAS	C(45)	Sąskaitos kodas
N33_SWIFT	C(15)	Sąskaitos/Banko swift-as
N33_KODAS_WS_K	C(12)	Korespondetinio banko kodas
N33_KSWIFT	C(15)	Korespondentinio banko swift-as
N33_K_SASK	C(45)	Korespondentinio banko sąskaita
N33_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N33_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime
N33_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N33_KODAS_SS	C(12)	Sąskaitos kodas
N33_KODAS_AK	C(12)	Kliento alternatyvus kodas	Privalomas
N33_WEB_ADR	C(12)	Web adresas
N33_WEB_POZ	N(1)	Web pardavimų eksporto požymis
N33_WEB_ATAS	C(13)	Web pardavimų ataskaita
N33_WEB_SERV	N(2)	Web servisas
N33_WEB_POZT	N(1)	Tiesioginis apsikeitimas
N33_WEB_POZI	N(1)	Internetinis apsikeitimas
N33_WEB_ADRI	C(12)	Internetinis adresas
N33_KODAS_LS_1	C(12)	Logistikos 1 kodas
N33_KODAS_LS_2	C(12)	Logistikos 2 kodas
N33_KODAS_LS_3	C(12)	Logistikos 3 kodas
N33_KODAS_LS_4	C(12)	Logistikos 4 kodas
N33_KODAS_MS	C(12)	Menedžerio kodas
N33_WEB_POZ_PO	N(1)	Pirkimų Web eksportas
N33_WEB_ATAS_PO	C(13)	Pirkimų Web eksporto ataskaita
N33_GLN	C(20)	GLN kodas
N33_E_MAIL	C(150)	E-mail adresas
N33_SALIES_K	C(5)	Šalies kodas