Metadata [ccb by dsb®

Cancellation Reasons

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

URL

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

Parameter	Description
client	client number
sp	Service provider code (Mandatory field if the user account uses more than one service provider code)
cancelReasons	Only returns certain cancellation reasons (If empty, all cancellation reasons are returned)
checkHasRecomms	True: Only the cancellation reasons are returned which are used in the Recom-Engine False: All or the cancellation reasons given in cancelReasons are returned
orderNumber	Only the cancellation reasons are returned that have a matching entry in the Recom-Engine for the ordernumber
channel	Only the cancellation reasons are returned that habe a matching entry in the Recom-Engine for the channel

Response

The response is a JSON structure containing an array of cancellation Reasons with their description

Element	Description
cancelReasons	Array with the fields: 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"
        }
    ]
}

Reclamation Reasons

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

URL

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

Parameter	Description
client	client number
sp	Service provider (Mandatory, field if the user account uses more than one service provider code)
reclamationReasons	Only returns certain reclamation reasons (If empty, all reclamation reasons are returned)
checkHasRecomms	True: Only the reclamation reasons are returned which are used in the Recom-Engine False: All or the reclamation reasons given in reclamationReasons are returned
orderNumber	Only the reclamation reasons are returned that have a matching entry in the Recom-Engine for the ordernumber
channel	Only the reclamation reasons are returned that habe a matching entry in the Recom-Engine for the channel

Response

The response is a JSON structure containing an array of reclamation reasons with their description

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

masterdata / table for masterdata mapping

BETA This service returns a generic table structure which contains the mapping for the requested domaintype
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	Type/Length	Description
client	C/3	client ID
sp	C/3	service provider. (mandatory if the user account can use different service provider values)
data	C/30	Mapping table for the requested masterdata (Values: MEDIUM)

Response

The response is a JSON document containing an array of masterdata elements.

{
  "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 Definitions

Fieldname	Type	Description
client	C	client ID
masterData 1 … n
domain	C	domain/ masterdata typ
language	C	language
shortValue	C	short value
longValue	C	long value

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