get Loyalty / Treue **BETA** [ccb by dsb®

get Loyalty / Treue BETA

Der Service ermittelt die längste Abolaufzeit eines Kunden und in welcher entsprechenden Treue-Ebene er eingeordnet ist (z.B. Bronze, Silber, Gold und Platin).
Zudem werden die Verfügbaren Treue-Ebenen mit ausgegeben, die es für den entsprechenden Mandanten gibt.

URL

GET: /rest/{client}/loyalty/{model}?sp=xxx&email=xxx

Parameter	Typ/Länge	Beschreibung
client	AN / 3	Mandantennummer
model	AN / 10	Loyaltymodell
sp	AN / 3	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
so	AN / 4	VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)
email	AN	Email Adresse des gewünschten Kunden

Response

{
  "valueReached": "532",
  "tier": {
    "tierCode": "GOLD",
    "validFrom": 365,
    "display": "Tage",
    "inactiveURL": "",
    "activeURL": "",
    "shortText": "",
    "longText": ""
  },
  "tiers": [
    {
      "tierCode": "BRONZE",
      "validFrom": 1,
      "display": "Tage",
      "inactiveURL": "",
      "activeURL": "",
      "shortText": "",
      "longText": ""
    },
  ...
  ],
  "rewards":[
  {
      "position": 1,
      "rewardId": "",
      "rewardType": "",
      "model": "",
      "tierCode": "",
      "imageGridURL": "",
      "imageBannerURL": "",
      "shortText": "",
      "longText": "",
      "targetURL": "",
      "claimable": true,
      "favorite": true,
      "couponCode": ""
    },
    ...
    ]
  }  
}

Parameter	Typ/Länge	Beschreibung
valueReached	C	Laufzeit in Tagen der aktuellen Treue-Ebene
tier Treue Ebene
tierCode	AN	Loyalty Tier-Code
validFrom	AN	gültig von
display	AN	Einheit
inactiveURL	AN	Verweis auf Web-Adresse oder Dateipfad
activeURL	AN	Verweis auf Web-Adresse oder Dateipfad
language	AN	Sprache
shortText	AN	Beschreibung kurz
longText	AN	Beschreibung lang
tiers 0 … n
tierCode	AN	Loyalty Tier-Code
validFrom	AN	gültig von
display	AN	Einheit
inactiveURL	AN	Verweis auf Web-Adresse oder Dateipfad
activeURL	AN	Verweis auf Web-Adresse oder Dateipfad
language	AN	Sprache
shortText	AN	Beschreibung kurz
longText	AN	Beschreibung lang
rewards 0 … n
position	N	Positionsnummer
rewardId	AN	Loyalty: RewardID
rewardType	AN	Loyalty: Reward-Typ
model	AN	Loyaltymodell
tierCode	AN	Loyalty Tier-Code
imageGridURL	AN	Verweis auf Web-Adresse oder Dateipfad
imageBannerURL	AN	Verweis auf Web-Adresse oder Dateipfad
shortText	AN	Beschreibung kurz
longText	AN	Beschreibung lang
targetURL	AN	Verweis auf Web-Adresse oder Dateipfad
claimable	B	Kunde darf den Reward einlösen/abrufen
favorite	B	Favorit true oder false wenn nicht angegeben
couponCode	AN	ein code

get Fulfilment / Treue BETA

URL

GET: /rest/{client}/loyalty/fulfilment?sp={sp}&mail={email}&model={model}

Parameter	Typ/Länge	Beschreibung
client	AN / 3	Mandantennummer
sp	AN / 3	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
so	AN / 4	VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)
model	AN	Loyalty Model
email	AN	Email Adresse des gewünschten Kunden

Response

{
  {
    "mail": "",
    "model": "",
    "tierCode": "",
    "rewardId": "",
    "rewardType": "",
    "couponCode": "",
    "targetURL": "",
    "isCouponCodeConsumed": "false", 
    "timestamp": "2025-07-24T08:52:33+02:00"
  }
  ...

Parameter	Typ/Länge	Beschreibung
mail	AN	Kunden Email
model	AN	Loyalty Model
tierCode	AN	Loyalty Tier-Code
rewardId	AN	Loyalty: RewardID
rewardType	AN	Loyalty: RewardType
couponCode	AN	ein code
targetURL	AN	Verweis auf Web-Adresse oder Dateipfad
isCouponCodeConsumed	B
timestamp	AN

get Loyalty Option / Treue BETA

URL

GET: /rest/{client}/loyalty/loyaltyoption?sp={sp}&mail={email}

Parameter	Typ/Länge	Beschreibung
client	AN / 3	Mandantennummer
sp	AN / 3	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
so	AN / 4	VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)
email	AN	Email Adresse des gewünschten Kunden

Response

{
  "loyaltyOption": true/false
}

Parameter	Typ/Länge	Beschreibung
loyaltyOption	B	true/false

set Fulfilment / Treue BETA

URL

POST: /rest/{client}/loyalty/fulfilment?sp={sp}

Parameter	Typ/Länge	Beschreibung
client	AN / 3	Mandantennummer
sp	AN / 3	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
so	AN / 4	VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)

Request

{
  "mail": "",
  "model": "",
  "rewardId": "",
  "tierCode": "",
  "couponCode": "test25"
}

Parameter	Typ/Länge	Beschreibung
mail	AN	Kunden Email
model	AN / 10	Loyalty Model
tierCode	AN	Loyalty Tier-Code
rewardId	AN	Loyalty: RewardID
couponCode	AN	ein code

Response

set RewardFavorite / Treue BETA

URL

POST: /rest/{client}/loyalty/rewardfavorite?sp={sp}

Parameter	Typ/Länge	Beschreibung
client	AN / 3	Mandantennummer
sp	AN / 3	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
so	AN / 4	VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)

Request

{
  "mail": "",
  "model": "",
  "rewardId": "",
  "favorite": true/false
}

Parameter	Typ/Länge	Beschreibung
mail	AN	Kunden Email
model	AN / 10	Loyalty Model
rewardId	AN	Loyalty: RewardID
favorite	B	true/false=default

Response

set LoyaltyOption / Treue BETA

URL

POST: /rest/{client}/loyalty/loyaltyoption?sp={sp}

Parameter	Typ/Länge	Beschreibung
client	AN / 3	Mandantennummer
sp	AN / 3	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
so	AN / 4	VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)

Request

{
  "mail": "",
  "loyaltyOption": true/false
}

Parameter	Typ/Länge	Beschreibung
mail	AN	Kunden Email
loyaltyOption	B	true/false=default

Response