Stammdaten [ccb by dsb®

salesoffers / Angebote (Nutzung nur bei entspr. Backendintegration in der ccb Suite)

Mit diesem Service können Angebotsdaten auf Basis übergebener Druckerzeugnisse abgerufen werden. Hierbei werden maßgeblich die zugehörigen BQ / BQ-Set / Prämiendaten im Response geliefert.
Path mapping(intern): /net/dsb/avs3/SalesOffers/getSalesOffers-1.0.0

URL

GET: /rest/{client}/salesoffers?so={so}&sp={sp}&publications={publication},{publication},…

Parameter	Typ/Länge	Beschreibung
client	C/3	Mandant
sp	C/3	service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann)
so	C/4	sales organization. (mandatory, wenn der Account unterschiedliche VkOrgs nutzen kann)
publications	C/8	Druckerzeugnisse 1 … 10

Response

Der Response ist eine JSON Struktur

Element	Beschreibung
client	Mandant
promotionSource	Bestellquelle (BQ)
promotionSourceVariant	Bestellquellen Variante (BQVAR)
salesPromotion	Werbeaktion (SETID)
shortDescription	Bezeichnung kurz (BEZEICHNUNG)
longDescription	Bezeichnung lang (BEZEICH_LANG)
validFrom	Bestellquelle gültig ab (GUELTIGVON) YYYY-MMDD
validTo	Bestellquelle gültig bis (GUELTIGBIS) YYYY-MMDD
salesOrganization	Verkaufsorganisation (VKORG)
publication	Druckerzeugnis (DRERZ)
salesSource	Werbeart (WERBEART)
premium 0… n
premiumId	ID Premium Set (PRMSET)
isActive	Kennzeichen Premium Set Aktiv (AKTIV)
validFrom	Gültig von Datum (GUELTIGVON) YYYY-MM-DD
validTo	Gültig bis Datum (GUELTIGBIS) YYYY-MM-DD
description	Bezeichnung (BEZEICHNUNG)
materialNumber	IS-M: Materialnummer Sachprämie (MATNR)
publication	Druckerzeugnis (DRERZ)
requiredNumberOfSubscriptions	Notwendige Anzahl von Abonnements in Stück (BISLIFMENG)
deliveryQuantityUnit	Liefermengen-Einheit (BISLIFMENG_UNIT)
defaultPremium	IS-M/SD: Kennzeichen Defaultsachprämie der Werbebasis (XDEFAULT)
addOnPremium	Kennzeichen Sachprämie ist Zugabe (sofortige Freigabe)
addPayment	Zuzahlungsbetrag / Auszahlungsbetrag
addPaymentCurrency	Währung des Zuzahlbetrages

Der Response wird als JSON Dokument zurückgegeben.

Beispiel (zur besseren Darstellung formatiert):

{
  "offers": [
    {
    "promotionSource" : "",
    "promotionSourceVariant" : "",
    "salesPromotion" : "",
    "shortDescription" : "",
    "longDescription" : "",
    "validFrom" : "",
    "validTo" : "",
    "salesOrganization" : "",
    "publication" : "",
    "salesSource" : "",
      "offerPremium" : [
        {
        "premiumId" : "",
        "isActive" : "",
        "validFrom" : "",
        "validTo" : "",
        "description" : "",
        "materialNumber" : "",
        "publication" : "",
        "requiredNumberOfSubscriptions" : "",
        "deliveryQuantityUnit" : "",
        "defaultPremium" : "",
        "addOnPremium" : "",
        "addPayment" : "",
        "addPaymentCurrency" : "",
        },
    …
    ]
    },
    {
    "promotionSource" : "",
    "promotionSourceVariant" : "",
    "salesPromotion" : "",
    "shortDescription" : "",
    "longDescription" : "",
    "validFrom" : "",
    "validTo" : "",
    "salesOrganization" : "",
    "publication" : "",
    "salesSource" : "",
    "offerPremium" : [
      {
      "premiumId" : "",
      "isActive" : "",
      "validFrom" : "",
      "validTo" : "",
      "description" : "",
      "materialNumber" : "",
      "publication" : "",
      "requiredNumberOfSubscriptions" : "",
      "deliveryQuantityUnit" : "",
      "defaultPremium" : "",
      "addOnPremium" : "",
      "addPayment" : "",
      "addPaymentCurrency" : "",
      },
      …
      ]
      },
      …
  ]
}

Cancellation Reasons / Kündigungsgründe

Path mapping(intern): /net/dsb/avs3/MasterData/getCancelReasons-1.0.0
SAP REST: /CANCEL_REASONS

URL

GET: /rest/{client}/cancelReasons?sp=xx

Parameter	Description
client	Mandant
sp	Service provider. (Mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann)
cancelReasons	Liefert nur die angegebenen Kündigungsgrunde zurück (wenn leer werden alle Gründe zurückgegeben)
checkHasRecomms	True: Es werden nur die Kündigungsgründe zurückgegeben, die in der Recom-Engine verwendet werden Only the cancellation reasons are returned which are used in the Recom-Engine False: Alle oder die angegebenen Kündigungsgründe werden zurückgegeben
orderNumber	Es werden nur die Kündigungsgründe zurückgegeben die einen passenden Eintrag in der Recom-Engine haben (Auftragsnummer)
language	Wenn nicht mitgegeben wird die Systemsprache für den response genutzt (optional)
channel	Es werden nur die Kündigungsgründe zurückgegeben die einen passenden Eintrag in der Recom-Engine haben (Kanal)

Response

Der Response ist eine JSON Struktur der einen Array mit den Kündigungsgründen mit Beschreibung beinhaltet

Element	Description
cancelReasons	Array mit den Feldern: cancelReason, shortDescription, longDescription, contactClass and contactActivity

{
    "cancelReasons": [
        {
            "cancelReason": "001",
            "shortDescription": "refused",
            "longDescription": "refused"
            "contactClass": "CANC",
            "contactActivity": "CANC001"
        },
        {
            "cancelReason": "004",
            "shortDescription": "address unknown",
            "longDescription": "address unknown"
            "contactClass": "CANC",
            "contactActivity": "CANC004"
        }
    ]
}

Reklamationsgründe

Path mapping(intern): /net/dsb/avs3/MasterData/getReclamationReasons-1.0.0
SAP REST: /RECLAMATIONS

URL

GET: /rest/{client}/reclamationReasons?sp=xx

Parameter	Description
client	Mandant
sp	Service provider. (Mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann)
reclamationReasons	Liefert nur die angegebenen Reklamationsgründe zurück (wenn leer werden alle Gründe zurückgegeben)
checkHasRecomms	True: Es werden nur die Reklamationsgründe zurückgegeben, die in der Recom-Engine verwendet werden False: Alle oder die angegebenen Reklamationsgründe werden zurückgegeben
orderNumber	Es werden nur die Reklamationsgründe zurückgegeben die einen passenden Eintrag in der Recom-Engine haben (Auftragsnummer)
channel	Es werden nur die Reklamationsgründe zurückgegeben die einen passenden Eintrag in der Recom-Engine haben (Kanal)

Response

Der Response ist eine JSON Struktur der einen Array mit den Reklamationsgründe mit Beschreibung beinhaltet

[
  {
    "reclamationReason": "AGA",
    "shortDescription": "AGA-Betrag",
    "longDescription": "AGA-Betrag"
  },
  {
    "reclamationReason": "ALT",
    "shortDescription": "Änd.Vorsystem",
    "longDescription": "Änderung im Vorsystem fakturierten Zeitraum"
  }
]

masterdata / Tabelle mit Stammdaten Mapping

BETA Mit diesem Service können über ein mapping definierte Inhalte der Stammdaten Tabelle abgerufen werden. Die möglichen Werte für data müssen explizit bekanntgegeben werden.
Wenn der Service mit data=MEDIUM aufgerufen wird gilt hier:
Wenn aus den im Vorfeld aufgerufenen SubscriptionOrder.getBy… Services kein productType zurückkommt, dann ist es ein Print-Medium.

Denn:
SubscriptionOrder.getBy…. RS Element productType ⇐ ⇒ MasterData.getMasterData RS Element shortValue

Path mapping(intern): /net/dsb/avs3/Masterdata/getMasterData-1.0.0
Fuba: /DSB/_ISM_E_GET_DOMVALUES

URL

GET: /rest/{client}/masterdata?sp={sp}&data={data}

Parameter	Typ/Länge	Beschreibung
client	C/3	Mandant
sp	C/3	service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann)
data	C/30	Mapping Wert für die angeforderte Stammdaten Tabelle (Werte: MEDIUM)

Response

Der Response wird als JSON Dokument zurückgegeben.

Beispiel (zur besseren Darstellung formatiert):

{
  "masterData": [
    {
      "domain": "/DSB/JD_MEDIUM",
      "language": "D",
      "shortValue": "",
      "longValue": "Print-Medium"
    },
    {
      "domain": "/DSB/JD_MEDIUM",
      "language": "D",
      "shortValue": "ON",
      "longValue": "Online-Medium"
    },
    {
      "domain": "/DSB/JD_MEDIUM",
      "language": "D",
      "shortValue": "NE",
      "longValue": "Nahrungsergänzungsmittel"
    },
    {
      "domain": "/DSB/JD_MEDIUM",
      "language": "D",
      "shortValue": "DE",
      "longValue": "Digital Edition"
    },
    {
      "domain": "/DSB/JD_MEDIUM",
      "language": "D",
      "shortValue": "LB",
      "longValue": "Loseblatt-Sammlungen"
    },
    {
      "domain": "/DSB/JD_MEDIUM",
      "language": "D",
      "shortValue": "DO",
      "longValue": "Donation (Spende)"
    },
    {
      "domain": "/DSB/JD_MEDIUM",
      "language": "D",
      "shortValue": "TB",
      "longValue": "TimeBased"
    },
    {
      "domain": "/DSB/JD_MEDIUM",
      "language": "D",
      "shortValue": "KO",
      "longValue": "Kombiabo"
    }
  ],
  "client": "286"
}

Element	Beschreibung
client	Mandant
masterData 1 … n
domain	Stammdaten Typ
language	die Sprachausprägung
shortValue	Das Wertekürzel
longValue	Wert in Langausprägung

HTTP Response Status	description
200	Success
401	Authorization required
500	Internal error

sourcecodes / Infos zu BQs

Mit diesem Service können BQ Metadaten abgerufen werden.

Path mapping(intern): /net/dsb/avs3/Masterdata/getSourceCodes-1.0.0
Fuba: /DSB/_ISM_E_GET_JWT_BQ

URL

GET: /rest/{client}/sourcecodes?sp={sp}&publication={publication}
GET: /rest/{client}/sourcecodes/{sourceCode}?sp={sp}&publication={publication}
Bsp:
GET …/rest/286/sourcecodes?sp=DSB ==⇒ bringt Alle
GET …/rest/286/sourcecodes/00100595?sp=DSB ==⇒ bringt 1 Ergebnis
GET …/rest/286/sourcecodes?sp=DSB&publication=00000800 ==⇒ bringt BQ Daten anhand Druckerzeugnis
GET …/rest/286/sourcecodes/90100595 ==⇒ HTTP 404 not found (weil BQ nicht vorhanden)

Parameter	Typ/Länge	Beschreibung
client	C/3	Mandant
sp	C/3	service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann)
sourceCode	C/10	Bestellquelle (in AVS/3) (optional)
publication	C/8	Druckerzeugnis (optional)

Response

Der Response wird als JSON Dokument zurückgegeben.

Beispiel (zur besseren Darstellung formatiert):

{
    "client": "286",
    "sourceCodes": [
        {
            "longDescription": "",
            "sourceCode": "",
			"sourceCodeVariant": "",
            "subscriptionType": "",
            "description": ""
        },
 
  ...
 ]
}

Element	Beschreibung
client	Mandant
sourcecodes 0 … n
longDescription	Stammdaten Typ
sourceCode	die Sprachausprägung
sourceCodeVariant	Bestellquellen Variante
subscriptionType	Das Wertekürzel
description	Wert in Langausprägung

HTTP Response Status	description
200	Success
401	Authorization required
500	Internal error

Domänewerte abfragen

Mit diesem Service können AVS Domänenwerte abgerufen werden.

Path mapping(intern): /net/dsb/avs3/Masterdata/getFieldInfo-1.0.0

URL

GET: /rest/{client}/fieldinfo?sp={sp}

Parameter	Typ/Länge	Beschreibung
client	C/3	Mandant
sp	C/3	service provider. (mandatory, wenn der Account unterschiedliche Diensleister Kürzel nutzen kann)
topic	C	Topic (mandatory)
fieldName	C	Felödname (mandatory)
language	D/8	Sprache (optional)

Response

Der Response wird als JSON Dokument zurückgegeben.

Beispiel (zur besseren Darstellung formatiert):

Request: /rest/670/fieldinfo?sp=DSB&topic=PS_ARTICLE_DATA&fieldName=DELIVERYCODE&languages=EN

Response:

{
  "field_name": "DELIVERYCODE",
  "description": "PS: Delivery identical",
  "value_list": [
    {
      "value": "F1",
      "description": "Article available / not in stock"
    },
    {
      "value": "F2",
      "description": "same as F1. available in approx. 4 weeks when no stock"
    },
    {
      "value": "F3",
      "description": "not in stock,will be delivered at a later date"
    },
    {
      "value": "A1",
      "description": "Article available / not in stock"
    },
    {
      "value": "B1",
      "description": "not any longer available"
    }
  ]
}