Technical Details

rating

Message Types and Data Types

Service Operations (Technical Names)

This process component provides the following service operations:

You use this information when preparing the implementation phase of your project. During the developments, use the WSDL provided by a running SAP CC Core Server system at the appropriate endpoint over HTTP. Use the technical name of this process component (rating) to determine the relevant endpoint URL.

Note

Consult the functional specification of each service operation for more information about the business context and use, the error handling, and the prerequisites.

Legend
  • The XML elements are ordered and required by default. Each element is described on a line by its:
    • Name
    • Type (or base type)
    • Use: Optional (*), required (default), prohibited
    • Default value
    • Occurrence: Unique (default), multiple
    • Nillable attribute
    • Restricted enumeration
  • The attributes are prefixed using the @ character. Each attribute is described on a line by its:
    • Name
    • Type (or base type)
    • Use: Optional (*) (default), required, prohibited
    • Default value
    • Restricted enumeration

Important Note (*)

This SAP product documentation is based on the XML Schema handled by SAP CC. It does not show the conditional elements or attributes at business level. However conditional constraints may exist on certain elements or attributes that are tagged as optional. Refer to the annotations or comments that precise the final business use.

Message Types

This section details all the message types defined by this process component (Web service). Consult the specifications of both the request and response that correspond to your service operation.

Operation: chargingContractBulkActivate

The following message types are specified for the chargingContractBulkActivate operation:

Message Type: chargingContractBulkActivateRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The chargingContractBulkActivateRequest message type is structured as follows:

  • toDate (Date)
  • maxThroughput (Integer)
  • filter (ChargingContractSearchFilter, optional)
    • searchWindow (SearchFilterWindow, optional)
      The settings to enable reference-based pagination of search results in response. Several operation requests are necessary to retrieve the complete results.
      • windowSize (int, optional)
        The maximum number of results expected in the operation response. The SAP CC system returns a subset of the matching result set.
      • fromUniqueId (String256, optional)
        The reference to start pagination from. When omitted in the first search operation request, the beginning of the result set is returned by the SAP CC system. When set in an operation request, it must be equal to the lastUniqueId element in the previous operation response.
    • totalCountRequired (boolean, optional, default: "false")
    • id (StringAttributeDescription, optional)

    • subscriberAccountId (StringAttributeDescription, optional)

    • additionalInfo ... (AdditionalAttributeDescription, optional, multiple)
      • name (String256)

        • pattern (String256)
        • stringEnumeration (StringEnumeration)
        • numberEnumeration (NumberEnumeration)
        • dateEnumeration (DateEnumeration)
          • value ... (Date, multiple)
        • numberRange (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
        • dateRange (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")
    • subscriberAccountAdditionalInfo ... (AdditionalAttributeDescription, optional, multiple)
      • name (String256)

        • pattern (String256)
        • stringEnumeration (StringEnumeration)
        • numberEnumeration (NumberEnumeration)
        • dateEnumeration (DateEnumeration)
          • value ... (Date, multiple)
        • numberRange (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
        • dateRange (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")
    • rootChargingContractId (StringAttributeDescription, optional)

    • operationalStatus (OperationalStatus, optional, {active | locked | closed})

Message Type: chargingContractBulkActivateResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The chargingContractBulkActivateResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • id (Long, optional)

Operation: subscriptionBulkActivate

The following message types are specified for the subscriptionBulkActivate operation:

Message Type: subscriptionBulkActivateRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The subscriptionBulkActivateRequest message type is structured as follows:

  • toDate (Date)
  • maxThroughput (Integer)
  • filter (SubscriptionSearchFilter, optional)
    • searchWindow (SearchFilterWindow, optional)
      The settings to enable reference-based pagination of search results in response. Several operation requests are necessary to retrieve the complete results.
      • windowSize (int, optional)
        The maximum number of results expected in the operation response. The SAP CC system returns a subset of the matching result set.
      • fromUniqueId (String256, optional)
        The reference to start pagination from. When omitted in the first search operation request, the beginning of the result set is returned by the SAP CC system. When set in an operation request, it must be equal to the lastUniqueId element in the previous operation response.
    • totalCountRequired (boolean, optional, default: "false")
    • code (StringAttributeDescription, optional)

    • offerCode (StringAttributeDescription, optional)

    • offerConditionCode (StringAttributeDescription, optional)

    • type (NumberAttributeDescription, optional)

        • enumeration (NumberEnumeration)
        • range (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
    • effective_date (DateAttributeDescription, optional)

        • enumeration (DateEnumeration)
          • value ... (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")
    • expiration_date (DateAttributeDescription, optional)

        • enumeration (DateEnumeration)
          • value ... (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")
    • priceFreeze_effective_date (DateAttributeDescription, optional)

        • enumeration (DateEnumeration)
          • value ... (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")
    • priceFreeze_expiration_date (DateAttributeDescription, optional)

        • enumeration (DateEnumeration)
          • value ... (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")
    • commitment_expiration_date (DateAttributeDescription, optional)

        • enumeration (DateEnumeration)
          • value ... (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")
    • suspension_date (DateAttributeDescription, optional)

        • enumeration (DateEnumeration)
          • value ... (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")
    • resumption_date (DateAttributeDescription, optional)

        • enumeration (DateEnumeration)
          • value ... (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")
    • cancellation_date (DateAttributeDescription, optional)

        • enumeration (DateEnumeration)
          • value ... (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")
    • batchRatingGroupId (NumberAttributeDescription, optional)

        • enumeration (NumberEnumeration)
        • range (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
    • rerating_lock_code (StringAttributeDescription, optional)

    • rerating_last_status (NumberAttributeDescription, optional)

        • enumeration (NumberEnumeration)
        • range (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
    • rerating_last_code (StringAttributeDescription, optional)

    • rerating_suggested_date (DateAttributeDescription, optional)

        • enumeration (DateEnumeration)
          • value ... (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")
    • partitionID (NumberAttributeDescription, optional)

        • enumeration (NumberEnumeration)
        • range (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
    • status (NumberAttributeDescription, optional)

        • enumeration (NumberEnumeration)
        • range (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
    • additionalInfo ... (AdditionalAttributeDescription, optional, multiple)
      • name (String256)

        • pattern (String256)
        • stringEnumeration (StringEnumeration)
        • numberEnumeration (NumberEnumeration)
        • dateEnumeration (DateEnumeration)
          • value ... (Date, multiple)
        • numberRange (NumberRange)
          • min (NumberBoundary)
            • @included (boolean, default: "true")
          • max (NumberBoundary)
            • @included (boolean, default: "true")
        • dateRange (DateRange)
          • min (DateBoundary)
            • @included (boolean, default: "true")
          • max (DateBoundary)
            • @included (boolean, default: "true")
    • subscriptionSpecificFormula ... (SubscriptionSpecificFormula, optional, multiple, {mustBeRoot | isOffline | isHybrid | isOnline | isLocked | isNotLocked})

Message Type: subscriptionBulkActivateResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The subscriptionBulkActivateResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • id (Long, optional)

Operation: chargedItemLoad

The following message types are specified for the chargedItemLoad operation:

Message Type: chargedItemLoadRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The chargedItemLoadRequest message type is structured as follows:

  • customerManagementAreaName (String256, optional)

Message Type: chargedItemLoadResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The chargedItemLoadResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • id (Long, optional)

Operation: ratingSessionStart

The following message types are specified for the ratingSessionStart operation:

Message Type: ratingSessionStartRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The ratingSessionStartRequest message type is structured as follows:

  • maxConsumptionDate (Date)
  • batchRatingGroup (String256)
  • ratingMode (RatingSessionMode, {subscription-firstFail | subscription-most | subscription-try | day-most | day-subscription-firstFail})
  • description (String256, optional)

Message Type: ratingSessionStartResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The ratingSessionStartResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • id (Long, optional)

Operation: jobStatusRead

The following message types are specified for the jobStatusRead operation:

Message Type: jobStatusReadRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The jobStatusReadRequest message type is structured as follows:

Message Type: jobStatusReadResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The jobStatusReadResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
  • ratingJobStatus (RatingJobStatus, optional, {init | running | success | inError})

Operation: synchronizeAllCatalogsForCharging

The following message types are specified for the synchronizeAllCatalogsForCharging operation:

Message Type: synchronizeAllCatalogsForChargingRequest

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The synchronizeAllCatalogsForChargingRequest message type has no content.

Message Type: synchronizeAllCatalogsForChargingResponse

Consider the following SOAP API specifications interpreted and extracted from the WSDL that is provided by the SAP CC system.

Structure

The synchronizeAllCatalogsForChargingResponse message type is structured as follows:

  • status (ResponseStatus, {return | error | inProgress})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists | doesNotExist | invalid | prerequisiteMissing | incompatibleConfiguration | illegalState | temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      Consult the SAP CC Error Code Reference documentation for more information. Consider also the causedBy element.
      • module (string)
      • code (int)
      • message (string)
    • causedBy ... (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

Simple Types

The message types use the following simple types:

SubscriptionSpecificFormula

Syntax

This is a restriction of the String256 type.

The possible values are:

  • mustBeRoot
  • isOffline
  • isHybrid
  • isOnline
  • isLocked
  • isNotLocked
RatingJobStatus

Syntax

This is a restriction of the String256 type.

The possible values are:

  • init
  • running
  • success
  • inError
RatingSessionMode

Syntax

This is a restriction of the String256 type.

The possible values are:

  • subscription-firstFail
  • subscription-most
  • subscription-try
  • day-most
  • day-subscription-firstFail
ResponseStatus

Syntax

This is a restriction of the String256 type.

The possible values are:

  • return
  • error
  • inProgress
FailureCategory

Syntax

This is a restriction of the String256 type.

The possible values are:

  • alreadyExists
  • doesNotExist
  • invalid
  • prerequisiteMissing
  • incompatibleConfiguration
  • illegalState
  • temporaryIllegalState
SearchOrderType

Syntax

This is a restriction of the String256 type.

The possible values are:

  • asc
  • desc
  • noOrder
SearchFilterType

Syntax

This is a restriction of the string type.

The possible values are:

  • boolean
  • number
  • string
  • date
Decimal28_6

Syntax

This is a restriction of the decimal type.

  • maxInclusive: 9999999999999999999999.999999
  • minInclusive: -9999999999999999999999.999999
  • totalDigits: 28
  • fractionDigits: 6
Long

Syntax

This is a restriction of the long type.

  • maxInclusive: 9223372036854775807
  • minInclusive: 0
Integer

Syntax

This is a restriction of the int type.

  • maxInclusive: 2147483647
  • minInclusive: 0
Integer22

Syntax

This is a restriction of the decimal type.

  • totalDigits: 22
  • fractionDigits: 0
PositiveDecimal28_6

Syntax

This is a restriction of the Decimal28_6 type.

  • minInclusive: 0
CurrencyCode

Syntax

This is a restriction of the string type.

  • maxLength: 5
String256

Syntax

This is a restriction of the string type.

  • maxLength: 256
NotEmptyString256

Syntax

This is a restriction of the string type.

  • minLength: 1
  • maxLength: 256
String2000

Syntax

This is a restriction of the string type.

  • maxLength: 2000
Date

Syntax

This is a restriction of the dateTime type.

  • pattern: [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}
CountryCode

Syntax

This is a restriction of the string type.

  • length: 2
Empty

Syntax

This is a restriction of the string type.

  • length: 0
TableScope

Syntax

This is a restriction of the string type.

The possible values are:

  • agreement
  • both
  • catalog
PrepaidAccountStateSchedule

Syntax

This is a restriction of the String256 type.

The possible values are:

  • blocked
  • locked
  • closed
PrepaidAccountState

Syntax

This is a restriction of the String256 type.

The possible values are:

  • active
  • blocked
  • locked
  • closed
AccountTaxationMode

Syntax

This is a restriction of the String256 type.

The possible values are:

  • vendorSubjectToPay
  • buyerSubjectToPay
  • buyerExempted
  • noTax
VATBusinessCategory

Syntax

This is a restriction of the String256 type.

The possible values are:

  • B2B
  • B2C
EZTaxString

Syntax

This is a restriction of the string type.

  • maxLength: 10
EZTaxCustomerType

Syntax

This is a restriction of the String256 type.

The possible values are:

  • business
  • industrial
  • residentialCustomer
  • seniorCitizen
EZTaxIncorporatedCode

Syntax

This is a restriction of the String256 type.

The possible values are:

  • inside
  • outside
EZTaxClientResale

Syntax

This is a restriction of the String256 type.

The possible values are:

  • resale
  • sale
OperationalStatus

Syntax

This is a restriction of the String256 type.

The possible values are:

  • active
  • locked
  • closed
Copyright© 2020 SAP SE or an SAP affiliate company. All rights reserved.