INIT_TRIGGER

Aprašymas

Metodas skirtas sukurti reikiamą infrastrutūrą pokyčių registravimui norint dirbti tik su koreguotos informacijos nuskaitymu.

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 : INIT_TRIGGER

Metodas paleidžiamas tik vieną kartą prieš pradedant dirbti su pokyčių metodais (pakartotinis paleidimas sistemai įtakos nedaro)

Metodas duomenų bazėje sukuria papildomas lenteles sisteminių lentelių pokyčiams registruoti:

RGI_I33_TRIGGER_TABLE - lentelės I33_PKAI pokyčiams registruoti;
RGI_L11_TRIGGER_TABLE - lentelės L11_PAP1 pokyčiams registruoti;
RGI_l12_TRIGGER_TABLE - lentelės L12_PAP2 pokyčiams registruoti;
RGI_l13_TRIGGER_TABLE - lentelės L13_PAP3 pokyčiams registruoti;
RGI_I17_TRIGGER_TABLE - lentelės I17_VPRO pokyčiams registruoti;
RGI_N13_TRIGGER_TABLE - lentelės N13_AKC pokyčiams registruoti;
RGI_PS_TRIGGER_TABLE - lentelės N17_PROD pokyčiams registruoti;
RGI_N17_TRIGGER_TABLE - lentelės N17_PROD pokyčiams registruoti;
RGI_N26_TRIGGER_TABLE - lentelės N26_KOMP pokyčiams registruoti;
RGI_N32_TRIGGER_TABLE - lentelės N32_PABC pokyčiams registruoti;
RGI_BARCODE_TRIGGER_TABLE - lentelės N37_PMAT pokyčiams registruoti;
RGI_N37_TRIGGER_TABLE- lentelės N37_PMAT pokyčiams registruoti;
RGI_N40_TRIGGER_TABLE - lentelės N40_ABAR pokyčiams registruoti.

Pokyčių lentelės talpina sisteminės lentelės raktinius stulpelius ir stulpelį nurodantį paskutinio pokyčio datą.

Pokyčių lenteles galima panaudoti rašant filtravimo sąlygas standartiniams metodams (žr. pavyzdį žemiau)

pvz application/xml:

<body>
    <method>INIT_TRIGGER</method>
</body>

pvz application/json:

{
    "method": "INIT_TRIGGER"
}

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>
    <id>11395037911.a1526bff.1643288873804</id>
    <durationMs>95</durationMs>
    <columnNames>
        <columnName>kodas_ps</columnName>
        <columnName>r_date</columnName>
    </columnNames>
    <columnTypes>
        <columnType>CHAR</columnType>
        <columnType>TIMESTAMP</columnType>
    </columnTypes>
    <columnValues/>
</RET_DOK>

Prekių sąrašo nuskaitymas naudojant standartinį metodą - GET_N17_LIST

Nurodomas papildomas filtravimas pagal koregavimo laiką:

<body>
    <method>GET_N17_LIST</method>
    <params>
        <listType>A</listType>
        <fil>n17_kodas_ps in (select kodas_ps from dbo.RGI_PS_Trigger_table where r_date>='2022-01-04T16:30:00.000')</fil>
    </params>
</body>

Response (status 400)

Klaida paduodant duomenis / SQL sintaksės klaidos / kitos DB klaidos

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id>0</id>
    <durationMs>0</durationMs>
    <errorMessage>Method INIT_TRIGGERG does not exist</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": "INIT_TRIGGER"
}');
$response = curl_exec($ch);
curl_close($ch);