EDIT_I06_DOCS

Aprašymas

Prie pirkimų/pardavimų operacijos dokumentų/nuorodų prisegimas, koregavimas, trynimas.

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_I06_DOCS
params :
- oper :
  - I - dokumento prisegimas (numatytasis)
  - U - dokumento koregavimas
  - D - dokumento ištrynimas
data: perduodami duomenys:
- kodas_po - pardavimo/pirkimo operacijos numeris (raktas pagal kurį žinome operaciją)
- kodas_op_dok - operacijos numeris dokumentų lentoje (raktas pagal kurį žinome dokumento operaciją)
- tipas - 1-failas; 2-nuorodą į faila; 3-nuorodą į katalogą; 4-internetinė nuoroda
- aprasymas - dokumento aprašymas
- doc - dokumentas užkoduotas base64
- ext - failo plėtinys
- nuoroda - nuorodą į failą, ar katalogą
- show_doc - ar grąžiname rezultate grąžinti DOC tagą. Pagal nutylėjimą 1 - rodyti. Galimos reikšmės 1 - taip, 0- ne

Pirmi 7 ApiKey simboliai (pvz USERABC.JQKPG1d7Pkjxj37ObsgdfEkvfEfvF1oL7h7UMOLo -> USERABC) yra vartotojo vardas Rivile GAMA programoje, kuriuo bus kuriami ar koreguojami įrašai.

Koreguoti galima tik to paties API vartotojo sukurtas operacijas. Teisės valdomos parametru RGI_ALL_EDIT

Vienu metu veiksmai atliekami tik su vienu įrašu.

Norint ištrinti arba koreguoti prisegtą failą/nuorodą reikia nurodyti du raktinius tagus KODAS_PO ir KODAS_OP_DOK.

XML request

<body>
    <method>EDIT_I06_DOCS</method>
    <params>
        <oper>I</oper>
        <kodas_po>010R00000170</kodas_po>
        <doc>        JVBERi0xLjQNCiXi48/TDQolZ2VuZXJhdGVkIGJ5IFhGUlgsIChjKSAyMDA1IHd3dy5lcWV1cy5jb20NCjEwIDAgb2JqDQo8PCAvVHlwZSAvWE9iamVjdCAvU3VidHlwZSAvSW1hZ2UgL1dpZHRoIDI2NwogL0hlaWdodCA3MwogL0NvbG9yQ29tcG9uZW50cyAzCiAvQ29sb3JTcGFjZSAvRGV2aWNlUkdCIC9CaXRzUGVyQ29tcG9uZW50I...
        </doc>
        <tipas>1</tipas>
        <aprasymas>Dokumentas PDF</aprasymas>
        <ext>.pdf</ext>
        <nuoroda></nuoroda>
        <show_doc>1</show_doc>
        <overwrite>1</overwrite>    
    </params>
</body>

JSON request

{
    "method": "EDIT_I06_DOCS",
    "params": {
        "oper": "I",
        "kodas_po": "010R00000170",
        "tipas": 1,
        "aprasymas": "Dokumentas PDF",
        "doc": "JVBERi0xLjQNCiXi48/TDQolZ2VuZXJhdGVkIGJ5IFhGUlgsIChjKSAyMDA1IHd3dy5lcWV1cy5jb20NCjEwIDAgb2JqDQo8PCAvVHlwZSAvWE9iamVjdCAvU3VidHlwZSAvSW1hZ2UgL1dpZHRoIDI2NwogL0hlaWdodCA3MwogL0NvbG9yQ29tcG9uZW50cyAzCiAvQ29sb3JTcGFjZSAvRGV2aWNlUkdCIC9CaXRzUGVyQ29tcG9uZW50I...",
        "ext": ".pdf"
    }
}

Response (status 200 OK)

XML response

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <I06>
        <KODAS_PO>010R00000170</KODAS_PO>
        <KODAS_OP_DOK>010R00000001</KODAS_OP_DOK>
        <TIPAS>1</TIPAS>
        <APRASYMAS>Dokumentas PDF</APRASYMAS>
        <NUORODA></NUORODA>
        <DOC>
JVBERi0xLjQNCiXi48/TDQolZ2VuZXJhdGVkIGJ5IFhGUlgsIChjKSAyMDA1IHd3dy5lcWV1cy5jb20NCjEwIDAgb2JqDQo8PCAvVHlwZSAvWE9iamVjdCAvU3VidHlwZSAvSW1hZ2UgL1dpZHRoIDI2NwogL0hlaWdodCA3MwogL0NvbG9yQ29tcG9uZW50cyAzCiAvQ29sb3JTcGFjZSAvRGV2aWNlUkdCIC9CaXRzUGVyQ29tcG9uZW50I...
        <EXT>.PDF</EXT>
    </I06>
</RET_DOK>

Response (status 400)

Klaida paduodant duomenis / SQL sintaksės klaidos / kitos duomenų klaidos

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id>1266808491.066d8aff.1617393996483</id>
    <durationMs>0</durationMs>
    <errorMessage>For input string: ""</errorMessage>
</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>

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, '{
    "method": "EDIT_I06_DOC",
    "params": {
        "oper": "I",
        "kodas_po": "010R00000170",
        "tipas": 1,
        "aprasymas": "Dokumentas PDF",
        "doc": "JVBERi0xLjQNCiXi48/TDQolZ2VuZXJhdGVkIGJ5IFhGUlgsIChjKSAyMDA1IHd3dy5lcWV1cy5jb20NCjEwIDAgb2JqDQo8PCAvVHlwZSAvWE9iamVjdCAvU3VidHlwZSAvSW1hZ2UgL1dpZHRoIDI2NwogL0hlaWdodCA3MwogL0NvbG9yQ29tcG9uZW50cyAzCiAvQ29sb3JTcGFjZSAvRGV2aWNlUkdCIC9CaXRzUGVyQ29tcG9uZW50I...",
        "ext": ".pdf"
    }
}');
$response = curl_exec($ch);
curl_close($ch);