EDIT_BUS

Aprašymas

Būsenų 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_BUS
  • params :
    • module : modulis.
    • kodas_op : operacijos kodas.
    • busena : nauja būsena.
    • old_busena: sena būsena.
Galimi moduliai
  • PO : Pirkimų operacijos
  • RO : Pardavimų operacijos
  • VD : Vidinės operacijos
  • IN : Atsargų operacijos
  • KA : Gamybos operacijos
  • KS : Klientų sąrašas
  • OI : Mokėjimų operacijos
  • HO : CRM operacijos
  • RI : Rinkinių sąrašas
  • OD : DVS operacijos
  • PS : Prekių sąrašas

Būsenos numeris netikrinamas, t.y. galima priskirti neegzistuojančias arba netinkamo tipo būsenas.

Kaip ir Rivile GAMA, būsenos keitimas nekoreguoja XX_USERIS ir XX_R_DATE laukų.

Jei perduodamas parametras „old_busena“, tikrinama ar sutampa dabartinė operacijos būsena, priešingu atveju išvedama klaida ir būsenos keitimas neatliekamas.

pvz application/xml:

<body>
    <method>EDIT_BUS</method>
    <params>
        <module>VD</module>
        <kodas_op>000000000024</kodas_op>
        <busena>4</busena>
        <old_busena>5</old_busena>
    </params>
</body>

pvz application/json:

{
    "method": "EDIT_BUS",
    "params": {
        "module": "VD",
        "kodas_op": "000000000024",
        "busena": 5,
        "old_busena": 4
    }
}
Response (status 200 OK)

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

pvz:

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <bus>
        <kodas_op>000000000024</kodas_op>
        <busena>4</busena>
    </bus>
</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.ea04deae.1665497139154</id>
    <durationMs>31</durationMs>
    <errorMessage>For input string: "4x"</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>/v1</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_BUS",
    "params": {
        "module": "VD",
        "kodas_op": "000000000024",
        "busena": 5,
        "old_busena": 4
    }
}');
$response = curl_exec($ch);
curl_close($ch);