EDIT_N60

Aprašymas

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

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_N60</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N60>
            <N60_KODAS_SM>A003</N60_KODAS_SM>
            <N60_ASMUO>39XXXXXX1</N60_ASMUO>
            <N60_PAV>Testavičius</N60_PAV>
            <N60_VARDAS>Testas</N60_VARDAS>
            <N60_PAREIGOS>IT darbuotojas</N60_PAREIGOS>
        </N60>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N60",
    "params": {
        "oper": "I"
    },
    "data": {
        "N60": {
            "N60_KODAS_SM": "A003",
            "N60_ASMUO": "39XXXXXX1",
            "N60_PAV": "Testavičius",
            "N60_VARDAS": "Testas",
            "N60_PAREIGOS": "IT darbuotojas"
        }
    }
}

Response (status 200 OK)

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

pvz:

<?xml version='1.0'?>
<RET_DOK>
    <N60>
        <N60_KODAS_SM>A003</N60_KODAS_SM>
        <N60_ASMUO>39XXXXXX1</N60_ASMUO>
        <N60_PAV>Testavičius</N60_PAV>
        <N60_VARDAS>Testas</N60_VARDAS>
        <N60_PAREIGOS>IT darbuotojas</N60_PAREIGOS>
        <N60_KODAS_GS></N60_KODAS_GS>
        <N60_KODAS_KS></N60_KODAS_KS>
        <N60_PAV2></N60_PAV2>
        <N60_IGALIOJIMAS>0</N60_IGALIOJIMAS>
        <N60_DOK_NR></N60_DOK_NR>
        <N60_DATE>2020-10-29T00:00:00</N60_DATE>
        <N60_POZ_DATE_G>0</N60_POZ_DATE_G>
        <N60_BEG_DATE_G>2020-10-29T00:00:00</N60_BEG_DATE_G>
        <N60_END_DATE_G>2020-10-29T00:00:00</N60_END_DATE_G>
        <N60_SKYRIUS></N60_SKYRIUS>
        <N60_KODAS_VS></N60_KODAS_VS>
        ...
    </N60>
</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>1266808491.105aa9d5.1604001035586</id>
    <durationMs>9</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <errors>
        <error>
            <data>&lt;N60>&lt;N60_KODAS_SMA>A003&lt;/N60_KODAS_SMA>&lt;N60_PAV>Testavičius&lt;/N60_PAV>&lt;N60_ASMUO>39XXXXXX1&lt;/N60_ASMUO>&lt;N60_VARDAS>Testas&lt;/N60_VARDAS>&lt;N60_PAREIGOS>IT darbuotojas&lt;/N60_PAREIGOS>&lt;/N60></data>
            <dataErrors>
                <dataError>
                    <tag>N60_KODAS_SM</tag>
                    <code>19013</code>
                    <message>Nenurodytas 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_N60</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N60>
            <N60_KODAS_SM>A003</N60_KODAS_SM>
            <N60_VARDAS>Asmens pavadinimas naujas</N60_VARDAS>
        </N60>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_N60</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N60>
            <N60_KODAS_SM>A003</N60_KODAS_SM>
        </N60> 
    </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

N60

Asmens kortelės lentelė

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
N60_KODAS_SM	C(12)	Kontaktinis asmuo	Privalomas (Primary key)
N60_ASMUO	C(12)	Asmens kodas
N60_PAV	C(60)	Pavardė
N60_VARDAS	C(30)	Vardas
N60_PAREIGOS	C(40)	Pareigos
N60_KODAS_GS	C(12)	Grupės kodas
N60_KODAS_KS	C(12)	Klientas
N60_PAV2	C(150)	Įmonės pavadinimas
N60_IGALIOJIMAS	N(1)	Įgaliojimas: 0-Nėra,1-Įgaliojimas
N60_DOK_NR	C(12)	Dokumento numeris
N60_DATE	T(8)	Dokumento data
N60_POZ_DATE_G	N(1)	Ar įgaliojimas terminuotas
N60_BEG_DATE_G	T(8)	Įgaliojimo pradžios data
N60_END_DATE_G	T(8)	Įgaliojimo pabaigos data
N60_SKYRIUS	C(40)	Skyrius
N60_KODAS_VS	C(12)	Vietovė
N60_ADR	C(150)	Adresas
N60_TEL	C(40)	Telefonai
N60_FAX_NUM	C(40)	Faksai
N60_MOB_TEL	C(40)	Mobilūs telefonai
N60_WWW	C(40)	WWW puslapio adresas
N60_E_MAIL	C(150)	E-mail adresas
N60_KODAS_VS_N	C(12)	Namų vietovė
N60_ADR_N	C(150)	Namų adresas
N60_TEL_N	C(40)	Namų telefonai
N60_KATEGORIJA	C(40)	Kategorija
N60_ADDUSR	C(12)	Kas sukūrė
N60_ADD_DATE	T(8)	Kada sukūrė
N60_USERIS	C(12)	Kas koregavo
N60_R_DATE	T(8)	Kada koregavo
N60_KALBA	C(40)	Kalba
N60_POZ_DATE	N(1)	Ar terminuota
N60_BEG_DATE	T(8)	Pradžios data
N60_END_DATE	T(8)	Pabaigos data
N60_KODAS_LS_1	C(12)	Logistikos kodas 1
N60_KODAS_LS_2	C(12)	Logistikos kodas 2
N60_KODAS_LS_3	C(12)	Logistikos kodas 3
N60_KODAS_LS_4	C(12)	Logistikos kodas 4
N60_PASTABOS	M(4)	Pastabos
N60_KODAS_MS	C(12)	Menedžeris
N60_KODAS_VS_P	C(12)	Pristatymo vietovė
N60_ADR1_P	C(70)	Pristatymo adresas 1
N60_ADR2_P	C(40)	Pristatymo adresas 2
N60_ADR3_P	C(40)	Pristatymo adresas 3