ExternalOrders - Komunikačný protokol - JSON

Z Hotelové systémy - Wiki
Skočit na navigaci Skočit na vyhledávání

Špecifikácia webových služieb Asseco BLUEGASTROWS

História dokumentácie

Dátum vydania Verzia dokumentu Popis zmien Autor
20.07.2015 1.0 Založenie dokumentácie. Juraj Pacolt
28.01.2016 1.1 Modul Exareg, doplnená kontrola duplicity emailu pri volaní metódy sendGuestInfo. Juraj Pacolt
29.01.2016 1.2 Modul ExternalOrders, doplnená nová metóda modifyCredit. Juraj Pacolt

Popis

Rozšírenie Asseco BLUEGASTROWS je sada webových služieb vystavených zo systemu Asseco BLUEGASTRO. Tieto služby maju za úlohu zastrešiť potrebnú funkcionalitu pre externé systémy.

Komunikačný interface využíva na prenos správ protokol HTTP, prípadne HTTPS. Jednotlivé dotazy sú typu REST, tzn. štandardné URI linky s prípadnými parametrami. Pričom niektoré požiadavky prípadne návratové správy, resp. odpovede sú typu JSON. Ako content type sa očakáva application/json.

V každej metóde komunikácie je potrebné uviesť systemId. Toto ID systému je číslo zaregistrovaného externého systému v systéme Asseco BLUEGASTRO. Pokiaľ sa dané číslo nenájde v zozname zaregistrovaných externých systémov, prípadne pokiaľ má externý systém zablokovanú komunikáciu, resp. nie je povolený, systém Asseco BLUEGASTRO nedovolí vykonať požiadavku.

Modul "Externé objednávky" (ExternalOrders)

Metóda "test"

Metóda test slúži iba na preverenie komunikácie a validáciu základnej funkčnosti modulu ExternalOrders.

http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/test/{input}

Vstupné parametre

  • input - Testovacia správa.


Požiadavka 

<code>
GET http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/test/Testovaci retazec ...
</code>


JSON návratovej správy 

<code>
... cezater icavotseT
</code>



Metóda "getVersion"

Metóda getVersion slúži na získanie verzie webových služieb modulu ExternalOrders.

http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getVersion/{systemId}

Vstupné parametre

  • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.


Požiadavka 

<code>
GET http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getVersion/1234567890
</code>


JSON návratovej správy 

<code>
2
</code>



Metóda "getPluList"

Získanie zoznamu PLU, vracia všetky okrem zmazaných.

http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getPluList/{systemId}

Vstupné parametre

  • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.


Požiadavka 

<code>
GET http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getPluList/1234567890
</code>


JSON návratovej správy 

<code>
[
    {
        "id": 23,
        "code": 9004,
        "name": "Slivovica  R. Jelinek 0,04l ",
        "vatRate": 20,
        "note": null,
        "unitPrice": 2.5,
        "credit": 0,
        "doty": 0
    },
    {
        "id": 24,
        "code": 9011,
        "name": "Gin Beefeater 40% 0,04l",
        "vatRate": 20,
        "note": null,
        "unitPrice": 3,
        "credit": 0,
        "doty": 0
    },
    {
        "id": 25,
        "code": 9014,
        "name": "Hruskovica R. Jelinek 0,04l",
        "vatRate": 20,
        "note": null,
        "unitPrice": 2.5,
        "credit": 0,
        "doty": 0
    },
    {
        "id": 29,
        "code": 13008,
        "name": "Fernet stock 0,04l",
        "vatRate": 20,
        "note": null,
        "unitPrice": 2.2,
        "credit": 0,
        "doty": 0
    }
]
</code>
  • id - Jedinečné identifikačné číslo.
  • code - Kód PLU.
  • name - Názov PLU.
  • vatRate - Sadzba DPH.
  • note - Poznámka.
  • unitPrice - Jednotková cena.
  • credit - Hodnota kreditov za dané PLU.
  • doty - Hodnota dotov za dané PLU.



Metóda "getDiscountList"

Získanie zoznamu zliav. POZOR - oproti SOAP vracia len absolutne zľavy!

http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getDiscountList/{systemId}

Vstupné parametre 

    <code>
GET http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getDiscountList/1234567890
<li><code class="magenta">systemId</code> - Číslo pod ktorým je zaregistrovaný externý systém v systéme <i>Asseco BLUEGASTRO</i>.</li>
</ul>                                                                                                                  
<br />
<i>Požiadavka</i>
</code>


    JSON návratovej správy 

    <code>
[
    {
        "id": 2,
        "name": "Zlava na celý úcet",
        "type": "DISCOUNT",
        "enabled": true
    },
    {
        "id": 25,
        "name": "Zľava poukaz",
        "type": "DISCOUNT",
        "enabled": true
    }
]
</code>
    • id - Jedinečné identifikačné číslo.
    • name - Názov zľavy.
    • type - Typ zľavy.
    • enabled - Príznak, či je zľava aktívna.



    Metóda "getPaymentTypeList"

    Získanie zoznamu typov (spôsobov) platieb.

    http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getPaymentTypeList/{systemId}

    Vstupné parametre

    • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.


    Požiadavka 

    <code>
GET http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getPaymentTypeList/1234567890
</code>


    JSON návratovej správy 

    <code>
[
    {
        "id": 1,
        "name": "Platba celkom",
        "enabled": true
    },
    {
        "id": 2,
        "name": "Hotovosť",
        "enabled": true
    },
    {
        "id": 3,
        "name": "Zaokrúhlenie hotovosť",
        "enabled": true
    },
    {
        "id": 4,
        "name": "Stravné lístky",
        "enabled": true
    },
    {
        "id": 5,
        "name": "Hotelový účet",
        "enabled": true
    }
]
</code>
    • id - Jedinečné identifikačné číslo.
    • name - Názov spôsoby platby.
    • enabled - Príznak, či je platba aktívna.



    Metóda "getOrderTypeList"

    Získanie zoznamu typov objednávok.

    http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getOrderTypeList/{systemId}

    Vstupné parametre

    • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.


    Požiadavka 

    <code>
GET http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getOrderTypeList/1234567890
</code>


    JSON návratovej správy 

    <code>
[
    {
        "id": 5,
        "name": "Test 1"
    },
    {
        "id": 6,
        "name": "Test 2"
    }
]
</code>
    • id - Jedinečné identifikačné číslo.
    • name - Názov typu objednávky.



    Metóda "getOrderStatusList"

    Získanie zoznamu stavov objednávok.

    http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getOrderStatusList/{systemId}

    Vstupné parametre

    • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.


    Požiadavka 

    <code>
GET http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getOrderStatusList/1234567890
</code>


    JSON návratovej správy 

    <code>
[
    {
        "id": 1,
        "name": "Nová",
        "enabled": true
    },
    {
        "id": 2,
        "name": "Prijatá",
        "enabled": true
    },
    {
        "id": 3,
        "name": "Neprijatá",
        "enabled": true
    },
    {
        "id": 4,
        "name": "Hotová",
        "enabled": true
    },
    {
        "id": 5,
        "name": "Stornovaná",
        "enabled": true
    }
]
</code>
    • id - Jedinečné identifikačné číslo.
    • name - Názov stavu objednávky.
    • enabled - Príznak, či je stav objednávky aktívny.



    Metóda "isExistPLU"

    Overuje existenciu PLU v systéme Asseco BLUEGASTRO.

    http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/isExistPLU/{systemId}/{pluId}

    Vstupné parametre

    • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.
    • pluId - Jedinečný identifikátor PLU v systéme Asseco BLUEGASTRO.


    Požiadavka 

    <code>
GET http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/isExistPLU/1234567890/229
</code>


    JSON návratovej správy 

    <code>
true
</code>



    Metóda "newOrder"

    Volanie metódy zabezpečí vytvorenie novej externej objednávky v systéme Asseco BLUEGASTRO.

    http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/newOrdeer/{systemId}

    Vstupné parametre

    • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.


    Požiadavka 

    <code>
POST http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/newOrder/1234567890
</code>


    JSON požiadavky 

    <code>
{
    "idExternalSystem": 1234567890, 
    "date": "2016-11-11T18:15:00.000+0200 Z",
    "orderTypeId": 5,
    "payed": false,
    "paymentTypeId": 2,
    "customerInfo": "Test ...",
    "note": "Poznamka test ...",
    "guestId": 99975,
    "credit": 0,
    "items": [
        {
            "idPlu": 229,
            "amount": 1,
            "price": 3.54,
            "note": "Skuska ..."
        }
    ],
    "discountItems": [
        {
            "idDiscount": 2,
            "price": 0.46
        }
    ]
}
</code>
    • idExternalSystem - ID externého systému zaregistrovaného v systéme Asseco BLUEGASTRO.
    • date - Dátum a čas objednávky (<a target="_blank" href="https://sk.wikipedia.org/wiki/ISO_8601">ISO 8601</a>).
    • orderTypeId - Typ objednávky.
    • payed - Príznak, či už bola objednávka vopred uhradená.
    • paymentTypeId - ID spôsobu platby.
    • customerInfo - Informácia od zákazníka.
    • note - Poznámka.
    • guestId - ID stáleho hosťa.
    • credit - Kredit, ktorý sa použije za danú objednávku.
    • items - Položky objednávky.
      • idPlu - ID PLU.
      • amount - Množstvo - počet kusov.
      • price - Cena.
      • note - Poznámka ku položke.
    • discountItems - Položky zliav.
      • idDiscount - ID zľavy.
      • price - Cena zľavy.


    JSON návratovej správy 

    <code>
{
    "orderId": 142,
    "returnMessage": {
        "code": 1,
        "message": "Successful.",
        "stackTrace": null
    }
}
</code>
    • orderId - Jednoznačný identifikátor (ID) nového záznamu objednávky zo systému Asseco BLUEGASTRO.
    • returnMessage - Návratová správa.
      • code - Kód správy / hlásenia.
      • message - Text správy.
      • stackTrace - V prípade chyby, celý - systematický výpis (nie je vhodné zobrazovať pre používateľa).



    Metóda "cancelOrder"

    Stornuje existujúcu objednávku.

    http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/cancelOrder/{systemId}/{orderId}

    Vstupné parametre

    • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.
    • orderId - Jedinečný identifikátor existujúcej objednávky v systéme Asseco BLUEGASTRO.


    Požiadavka 

    <code>
GET http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/cancelOrder/1234567890/142
</code>


    JSON návratovej správy 

    <code>
true
</code>



    Metóda "getStatusOfOrder"

    Volanie metódy zabezpečí získanie informácií o stave objednávky v systéme Asseco BLUEGASTRO.

    http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getStatusOfOrder/{systemId}/{orderId}

    Vstupné parametre

    • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.
    • orderId - Jedinečný identifikátor objednávky v systéme Asseco BLUEGASTRO.


    Požiadavka 

    <code>
GET http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/newOrder/1234567890
</code>


    JSON návratovej správy 

    <code>
{
    "idOrderExternalSystem": 1234567890,
    "idOrder": 142,
    "lastChange": "2015-07-15T00:00:00Z",
    "orderStatusId": 5,
    "note": null
}
</code>
    • idOrderExternalSystem - ID zaregistrovaného externého systému v systeméme Asseco BLUEGASTRO.
    • idOrder - Jedinečný identifikátor (ID) objednávky.
    • lastChange - Posledná vykonaná zmena.
    • orderStatusId - Jedinečný identifikátor (ID) stavu objednávky z číselníka, ktorý je možné získať cez volanie <a href="#metoda-externalorders-getorderstatuslist">getOrderStatusList</a>.
    • note - Poznámka k objednávke.



    Metóda "getGuestIdByEmail"

    Volanie metódy zabezpečí získanie jedinečného identifikátora (ID) hosťa zo systému Asseco BLUEGASTRO.

    http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getGuestIdByEmail/{systemId}/{email}

    Vstupné parametre

    • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.
    • email - Emailová adresa, podľa ktorej sa bude vyhľadávať hosť.


    Požiadavka 

    <code>
GET http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getGuestIdByEmail/1234567890/asol@assecosol.eu
</code>


    JSON návratovej správy 

    <code>
99975
</code>

    Návratová hodnota predstavuje ID hosťa. Hodnota je typu long.



    Metóda "getAccountStatus"

    Volanie metódy zabezpečí získanie stavu konta hosťa zo systému Asseco BLUEGASTRO.

    http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getAccountStatus/{systemId}/{guestId}

    Vstupné parametre

    • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.
    • guestId - Jedinečný identifikátor (ID) hosťa.


    Požiadavka 

    <code>
GET http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getAccountStatus/1234567890/99975
</code>


    JSON návratovej správy 

    <code>
{
    "guestId": 99975,
    "accountCreditValue": 0,
    "validUntil": null,
    "validFrom": null,
    "valid": false
}
</code>
    • guestId - ID zaregistrovaného externého systému v systeméme Asseco BLUEGASTRO.
    • accountCreditValue - Hodnota kreditu.
    • validUntil - Povolené do.
    • validFrom - Povolené od.
    • valid - Je kontro validné - povolené.
    • accountCreditEnabled - Povolené kreditné konto.
    • accountCreditDailyLimit - Denný limit kreditu.



    Metóda "getStatusesOfAllOrdersByTime"

    Získanie zoznamu stavov existujúcich objednávok v čase podľa parametrov.

    http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getStatusesOfAllOrdersByTime/{systemId}

    Vstupné parametre

    • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.


    Požiadavka 

    <code>
POST http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getStatusesOfAllOrdersByTime/1234567890
</code>


    JSON požiadavky 

    <code>
{
    "dateTimeFrom": "2015-05-01T00:00:00.000Z",
    "dateTimeTo": "2015-07-31T00:00:00.000Z"
}
</code>
    • dateTimeFrom - Dátum a čas od.
    • dateTimeTo - Dátum a čas do.


    JSON návratovej správy 

    <code>
[
    {
        "idOrderExternalSystem": 1234567890,
        "idOrder": 142,
        "lastChange": "2015-07-15T00:00:00Z",
        "orderStatusId": 5,
        "note": null
    }
]
</code>
    • idOrderExternalSystem - ID zaregistrovaného externého systému v systeméme Asseco BLUEGASTRO.
    • idOrder - Jedinečný identifikátor (ID) objednávky.
    • lastChange - Posledná vykonaná zmena.
    • orderStatusId - Jedinečný identifikátor (ID) stavu objednávky z číselníka, ktorý je možné získať cez volanie <a href="#metoda-externalorders-getorderstatuslist">getOrderStatusList</a>.
    • note - Poznámka k objednávke.



    Metóda "newMessage"

    Požiadavka a odoslanie novej správy.

    http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/newMessage/{systemId}

    Vstupné parametre

    • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.


    Požiadavka 

    <code>
POST http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/newMessage/1234567890
</code>


    JSON požiadavky 

    <code>
{
    "idExternalSystem": 1234567890,
    "date": "2015-07-17T18:32:34.465Z",
    "messageTypeId": 1,
    "customerInfo": "Skuska",
    "msg": "Toto je skusobna sprava pre vas ..."
}
</code>
    • idExternalSystem - ID externého systému zaregistrovaného v systéme Asseco BLUEGASTRO.
    • date - Dátum a čas správy.
    • messageTypeId - ID typu spravy so získaného zoznamu <a href="#metoda-externalorders-getmessagetypelist">getMessageTypeList</a>.
    • customerInfo - Základné info pre zakazníka.
    • msg - Text samotnej správy.


    JSON návratovej správy 

    <code>
21
</code>

    Návratová hodnota predstavuje ID novo-vytvorenej správy v systéme Asseco BLUEGASTRO. Hodnota je typu long.



    Metóda "cancelMessage"

    Požiadavka na stornovanie správy.

    http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/cancelMessage/{systemId}/{messageId}

    Vstupné parametre

    • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.
    • messageId - ID správy.


    Požiadavka 

    <code>
GET http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/cancelMessage/1234567890/21
</code>


    JSON návratovej správy 

    <code>
true
</code>



    Metóda "getMessageStatusList"

    Získanie zoznamu stavov správ.

    http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getMessageStatusList/{systemId}

    Vstupné parametre

    • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.


    Požiadavka 

    <code>
GET http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getMessageStatusList/1234567890
</code>


    JSON návratovej správy 

    <code>
[
    {
        "id": 1,
        "name": "Nová",
        "enabled": true
    },
    {
        "id": 2,
        "name": "Prečítaná",
        "enabled": true
    }
]
</code>
    • id - ID stavu správy.
    • name - Názov stavu správy.
    • enabled - Príznak, či je stav správy povolený.



    Metóda "getMessageTypeList"

    Získanie zoznamu typov správ.

    http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getMessageTypeList/{systemId}

    Vstupné parametre

    • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.


    Požiadavka 

    <code>
GET http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getMessageTypeList/1234567890
</code>


    JSON návratovej správy 

    <code>
[
    {
        "id": 1,
        "name": "Test 1"
    },
    {
        "id": 2,
        "name": "Test 2"
    },
    {
        "id": 3,
        "name": "Test 3"
    }
]
</code>
    • id - ID typu správy.
    • name - Názov typu správy.



    Metóda "getStatusOfAllMessagesByTime"

    Ziskanie stavov správ za zadané časové obdobie.

    http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getStatusOfAllMessagesByTime/{systemId}

    Vstupné parametre

    • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.


    Požiadavka 

    <code>
POST http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getStatusOfAllMessagesByTime/1234567890
</code>


    JSON požiadavky 

    <code>
{
  "dateTimeFrom": "2015-05-01T00:00:00.000Z",
  "dateTimeTo": "2015-07-31T00:00:00.000Z"
}
</code>
    • dateTimeFrom - Dátum a čas od.
    • dateTimeTo - Dátum a čas do.


    JSON návratovej správy 

    <code>
[
    {
        "idMessageExternalSystem": 1234567890,
        "idMessage": 1,
        "lastChange": "2015-07-17T07:49:20Z",
        "messageStatusId": 2,
        "note": null
    },
    {
        "idMessageExternalSystem": 1234567890,
        "idMessage": 2,
        "lastChange": "2015-07-17T08:20:01Z",
        "messageStatusId": 2,
        "note": null
    },
    {
        "idMessageExternalSystem": 1234567890,
        "idMessage": 3,
        "lastChange": "2015-07-17T08:26:24Z",
        "messageStatusId": 2,
        "note": null
    }
]
</code>
    • idExternalSystem - ID externého systému zaregistrovaného v systéme Asseco BLUEGASTRO.
    • date - Dátum a čas správy.
    • messageTypeId - ID typu spravy so získaného zoznamu <a href="#metoda-externalorders-getmessagetypelist">getMessageTypeList</a>.
    • customerInfo - Základné info pre zakazníka.
    • msg - Text samotnej správy.



    Metóda "getStatusOfMessage"

    Ziskanie stavu správy.

    http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getStatusOfMessage/{systemId}/{messageId}

    Vstupné parametre

    • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.
    • messageId - ID správy.


    Požiadavka 

    <code>
GET http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/getStatusOfMessage/1234567890/2
</code>


    JSON návratovej správy 

    <code>
{
    "idMessageExternalSystem": 1234567890,
    "idMessage": 2,
    "lastChange": "2015-07-17T08:20:01Z",
    "messageStatusId": 2,
    "note": null
}
</code>
    • idExternalSystem - ID externého systému zaregistrovaného v systéme Asseco BLUEGASTRO.
    • date - Dátum a čas správy.
    • messageTypeId - ID typu spravy so získaného zoznamu <a href="#metoda-externalorders-getmessagetypelist">getMessageTypeList</a>.
    • customerInfo - Základné info pre zakazníka.
    • msg - Text samotnej správy.



    Metóda "modifyCredit"

    Úprava kreditu stáleho hosťa. Hosť musí byť v systéme Asseco BLUEGASTRO registrovaný ako kreditný hosť. Pri čerpaní, resp. ponižovaní kreditu hosťa sa zohľadňuje povolený minimálny stav konta, ale nezohľadňuje sa denný limit ani limit denného výberu.

    Táto metóda nie je podporovaná v SLAVE móde aplikačného servera systému Asseco BLUEGASTRO.

    http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/modifyCredit/{systemId}

    Vstupné parametre

    • systemId - Číslo pod ktorým je zaregistrovaný externý systém v systéme Asseco BLUEGASTRO.


    Požiadavka 

    <code>
POST http://server:port/Asseco BLUEGASTROWS/rest/ExternalOrders/modifyCredit/1234567890
</code>


    JSON požiadavky 

    <code>
{
  "guestId": 99940,
  "increment": true,
  "value": 10.00,
  "description": null,
  "dateAndTime": "2016-01-28T19:09:00Z"
}
</code>
    • guestId - Jedinečný identifikátor hosťa pochádzajúci zo systému Asseco BLUEGASTRO.
    • increment - true/false - ak je hodnota false, kontu sa prepíše hodnota kreditu, ak bude true tak sa pripočíta, prípadne odpočíta, bude záležať na znamienku pri čísle.
    • value - Hodnota kreditu. Je možné zadať +/- číslo na dve desatinné miesta.
    • description - Text popisujúci danú modifikáciu, napr. názov položky, ktorý bol kreditom uhredený.
    • dateAndTime - Dátum a čas kedy došlo k čerpaniu na externom systéme.


    JSON návratovej správy 

    <code>
{
  "code": 1,
  "message": "Successful",
  "stackTrace": null
}
</code>
    • code - Návratový kód spracovania dotazu.
    • message - Textová správa spracovania dotazu.
    • stackTrace - V prípade neznámej chyby podrobný výpis.



    Návratové kódy

    Jednotlivé metódy v časti returnMessage pri návratovej správe vracajú kód aj správu ako daná požiadavka dopadla. V nasledujúcej tabuľke je zoznam všetkých návratových kódov, ktoré môžu nastať.

    Kód Popis
    -1 Neznáma chyba. Bližšie nešpecifikovaná systémová chyba.
    1 Všetko je v poriadku. Požiadavka bola spracovaná.
    2 Neznáme PLU.
    3 Neznáma zľava.
    4 Neznámy hosť.
    5 Nepostačujúci kredit hosťa.
    6 Identifikátor hosťa je povinný, resp. nie je uvedený v požiadavke.
    7 Nejedná sa o kreditného hosťa.
    8 Konto hosťa je blokované.
    9 Server nemôže bežať v SLAVE móde.
Zdroj: „https://hotelovesystemy.sk/wiki/index.php?title=ExternalOrders_-_Komunikačný_protokol_-_JSON&oldid=18203“