API - Endpunkte Customerbonus

getCustomerBonus

Abfragen von KundenBonus-Informationen, wobei der aktuellste (letzte) Eintrag der Tabelle Tbl.kundenbonus zurückgeliefert wird.

Aufruf:

• GET - /api/bonus/<Referenz>/<Referenz-Typ>
• http://trademan/api_dev.php/api/customerbonus/10001/1?v=2

Die Referenz kann dabei z.B. eine (1)Kunden-Nr. oder eine (2)Karten-Nr. sein. Der ReferenzTyp gibt dabei an um was für eine Art von Referenz es sich handelt

Antwort:

• 200 - OK
• 404 - Kunde oder Kundenkarte nicht gefunden
• 500 - Unerwarteter Fehler
• 503 - Modul nicht konfiguriert, Parameter KUNDENBONUSSYSTEM

Beim erfolgreichen Aufruf kommen Bonus Infos zurück

JSON-Antwort Quelle erweitern

loadCustomerBonus

Aufladen/Erhöhen des Betrags eines Bonuses eines Kunden oder einer Kunden-Karte. Der Betrag muss dabei immer positiv sein, sonst wird ein Fehler geworfen.

Hier können folgende Parameter übergeben werden:

• Ref und RefTyp
• nur eine CustomerID, dann wird auf RefTyp=1 geschlossen; CustomerCardID muss dann ein LeerString sein
• nur eine CustomerCardID, dann wird auf RefTyp=2 geschlossen; CustomerID muss dann ein LeerString sein

Aufruf:

• POST - api/loadcustomerbonus
• http://trademan/api_dev.php/api/loadcustomerbonus

 Quelle erweitern

Antwort:

Beim erfolgreichen Aufruf wird eine entsprechende Antwort zurückgegeben und die neuen Kundenbonus-Daten (Saldo etc.):

• 200 - OK
• 400 - Fehlerhafte Werte der übergebenen Parameter
• 404 - Kunde oder Kundenkarte nicht gefunden
• 500 - Unerwarteter Fehler
• 503 - Modul nicht konfiguriert, Parameter KUNDENBONUSSYSTEM

JSON-Antwort Quelle erweitern

unloadCustomerBonus

Einlösen/Verringern des Bonusbetrags eines Kunden oder einer Kundenkarte. Der Betrag muss dabei immer positiv sein, sonst wird ein Fehler geworfen. Im poe-internen Bonus-System findet auch eine Prüfung statt, die das Guthaben überprüft.

Hier können folgende Parameter übergeben werden:

• Ref und RefTyp
• nur eine CustomerID, dann wird auf RefTyp=1 geschlossen; CustomerCardID muss dann ein LeerString sein
• nur eine CustomerCardID, dann wird auf RefTyp=2 geschlossen; CustomerID muss dann ein LeerString sein

Aufruf:

• POST - api/unloadcustomerbonus
• http://trademan/api_dev.php/api/unloadcustomerbonus

 Quelle erweitern

Antwort:

Beim erfolgreichen Aufruf wird eine entsprechende Antwort zurückgegeben und die neuen Kundenbonus-Daten (Saldo etc.)

• 200 - OK
• 400 - Fehlerhafte Werte der übergebenen Parameter
• 404 - Kunde oder Kundenkarte nicht gefunden
• 409 - Nicht genügend Guthaben
• 500 - Unerwarteter Fehler
• 503 - Modul nicht konfiguriert, Parameter BONUSPUNKTESYSTEM

JSON-Antwort Quelle erweitern