EDIT_N09

Aprašymas

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

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_N09</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N09>
            <N09_KODAS_VS>VILNIUS222</N09_KODAS_VS>
            <N09_PAV>Vilniaus miestas</N09_PAV>
            <N09_LYGIS>1</N09_LYGIS>
            <N09_TIPAS>2</N09_TIPAS>
            <N09_TEVAS></N09_TEVAS>
        </N09>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N09",
    "params": {
        "oper": "I"
    },
    "data": {
        "N09": {
            "N09_KODAS_VS": "VILNIUS22",
            "N09_PAV": "Vilniaus miestas",
            "N09_LYGIS": 1,
            "N09_TIPAS": 2,
            "N09_TEVAS": ""
        }
    }
}

Response (status 200 OK)

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

pvz:

<?xml version='1.0'?>
<RET_DOK>
    <N09>
        <N09_KODAS_VS>VILNIUS222  </N09_KODAS_VS>
        <N09_PAV>Vilniaus miestas                        </N09_PAV>
        <N09_LYGIS>1</N09_LYGIS>
        <N09_TIPAS>2</N09_TIPAS>
        <N09_TEVAS>           </N09_TEVAS>
        <N09_UZS_LAIKAS>0</N09_UZS_LAIKAS>
        <N09_VEZ_LAIKAS>0</N09_VEZ_LAIKAS>
        <N09_PAP_LAIKAS>0</N09_PAP_LAIKAS>
        <N09_POZ_DATE>0</N09_POZ_DATE>
        <N09_BEG_DATE>2023-06-15T00:00:00</N09_BEG_DATE>
        <N09_END_DATE>2023-06-15T00:00:00</N09_END_DATE>
        <N09_ADDUSR>XXAW2VW     </N09_ADDUSR>
        <N09_USERIS>XXAW2VW     </N09_USERIS>
        <N09_R_DATE>2023-06-15T16:55:44</N09_R_DATE>
        <N09_KODAS_VL>EUR         </N09_KODAS_VL>
        <N09_SUMA_KOM>0.00</N09_SUMA_KOM>
        <N09_KITAS>                                       </N09_KITAS>
        <N09_KODAS_LS_K>           </N09_KODAS_LS_K>
    </N09>
</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>615386280.da56aaa1.1686837411399</id>
    <durationMs>16</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data>&lt;N09>&lt;N09_PAV>Vilniaus miestas&lt;/N09_PAV>&lt;N09_LYGIS>1&lt;/N09_LYGIS>&lt;N09_TIPAS>2&lt;/N09_TIPAS>&lt;N09_TEVAS/>&lt;/N09></data>
        <dataErrors>
            <dataError>
                <tag>N09_KODAS_VS</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_N09</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N09>
            <N09_KODAS_VS>VILNIUS222  </N09_KODAS_VS>
            <N09_PAV>Vilniaus miestas ir rajonas</N09_PAV>
        </N09>
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_N09</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N09>
            <N09_KODAS_VS>KAUNAS2</N09_KODAS_VS>
        </N09> 
    </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

N09

Nuoroda į Vietovės kortelės lentelės aprašymą: (N09)