EDIT_N06

Aprašymas

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

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_N06</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N06>
            <N06_KODAS_OS>OBJ001</N06_KODAS_OS>
            <N06_PAV>Objekto pavadinimas 001</N06_PAV>
            <N06_TIPAS>2</N06_TIPAS>
        </N06>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N06",
    "params": {
        "oper": "I"
    },
    "data": {
        "N06": {
            "N06_KODAS_OS": "OBJ001",
            "N06_PAV": "Objekto pavadinimas 001",
            "N06_TIPAS": 2
        }
    }
}

Response (status 200 OK)

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

pvz:

<?xml version='1.0'?>
<RET_DOK>
    <N06>
         <N06_KODAS_OS>OBJ001 </N06_KODAS_OS>
         <N06_PAV>Objekto pavadinimas 001 </N06_PAV>
         <N06_LYGIS>1</N06_LYGIS>
         <N06_TEVAS> </N06_TEVAS>
         <N06_TIPAS>2</N06_TIPAS>
         <N06_APRAS> </N06_APRAS>
         <N06_POZ_DATE>0</N06_POZ_DATE>
         <N06_BEG_DATE>1900-01-01 00:00:00.000</N06_BEG_DATE>
         <N06_END_DATE>1900-01-01 00:00:00.000</N06_END_DATE>
         <N06_STATUS>0</N06_STATUS>
         <N06_KODAS_PS> </N06_KODAS_PS>
         <N06_SERIJA> </N06_SERIJA>
         <N06_GALIOJA>0</N06_GALIOJA>
         <N06_KODAS_KS> </N06_KODAS_KS>
         <N06_ADDUSR>3 </N06_ADDUSR>
         <N06_USERIS>3 </N06_USERIS>
         <N06_R_DATE>2019-11-04 10:28:57.000</N06_R_DATE>
     </N06>
 </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;N06>&lt;/N06></data>
            <dataErrors>
                <dataError>
                    <tag>N06_KODAS_OS</tag>
                    <code>87001</code>
                    <message>Nenurodytas objekto 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_N06</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N06>
            <N06_KODAS_OS>OBJ001</N06_KODAS_OS>
            <N06_PAV>Objekto pavadinimas naujas</N06_PAV>
        </N06>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_N06</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N06>
            <N06_KODAS_OS>OBJ001</N06_KODAS_OS>
        </N06> 
    </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

N06

Objekto kortelės lentelė

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
N06_KODAS_OS	C(12)	Objekto kodas	Privalomas
N06_PAV	C(40)	Objekto pavadinimas
N06_LYGIS	N(3)	Objekto lygis medyje
N06_TEVAS	C(12)	Aukštesnio lygio objekto kodas
N06_TIPAS	N(1)	Objekto tipas:1-suminis,2-detalus	Privalomas, kai oper=I
N06_APRAS	C(40)	Objekto aprašymas
N06_POZ_DATE	N(1)	Terminuotas:0-Ne,1-Taip
N06_BEG_DATE	T(8)	Pradžios data
N06_END_DATE	T(8)	Pabaigos data
N06_STATUS	N(1)	Objekto tipas:1-aktyvus,2-užbaigtas
N06_KODAS_PS	C(12)	Prekės kodas
N06_SERIJA	C(12)	Prekės serija
N06_GALIOJA	N(4)	Galiojimo terminas mėnesiais
N06_KODAS_KS	C(12)	Kliento kodas
N06_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai (oper=`I`), ApiKey - pirmi 7 simboliai
N06_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N06_R_DATE	T(8)	Koregavimo laikas	Neperduodamas. Pildomas automatiškai, Current Datetime
N06_APRASYMAS1	C(150)	Aprašymas 1
N06_APRASYMAS2	C(150)	Aprasymas 2
N06_APRASYMAS3	C(150)	Aprasymas 3