SAP DOCUMENTATION
SAP CC 3.0 Web Services | Data Models | Service Endpoints | Safe Operations | Security | System Configuration

rating

Message Types and Data Types

Service Operations (Technical Names)

This process component provides the following service operations:

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.

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
    • 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
    • Restricted enumeration

Important Note (*)

This 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.

chargingContractBulkActivate

Service Operation

Message Types

The following message types are specified for the chargingContractBulkActivate operation:

chargingContractBulkActivateRequest

message type

Structure

The chargingContractBulkActivateRequest message type is structured as follows:

  • filter (ChargingContractSearchFilter, optional)
    • id (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • subscriberAccountId (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • additionalInfo (AdditionalAttributeDescription, optional, multiple)
      • name (String256)
        • pattern (String256)
        • stringEnumeration (StringEnumeration)
          • value (String2000, multiple)
        • numberEnumeration (NumberEnumeration)
          • value (Decimal28_6, multiple)
        • dateEnumeration (DateEnumeration)
          • value (Date, multiple)
        • numberRange (NumberRange)
          • min (NumberBoundary)
            • @included (boolean)
          • max (NumberBoundary)
            • @included (boolean)
        • dateRange (DateRange)
          • min (DateBoundary)
            • @included (boolean)
          • max (DateBoundary)
            • @included (boolean)
    • searchWindow (SearchFilterWindow, optional)
      • windowSize (int, optional)
      • fromUniqueId (String256, optional)
    • totalCountRequired (boolean, optional)
  • toDate (Date)
  • maxThroughput (Integer)

chargingContractBulkActivateResponse

message type

Structure

The chargingContractBulkActivateResponse message type is structured as follows:

  • id (Long, optional)
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

subscriptionBulkActivate

Service Operation

Message Types

The following message types are specified for the subscriptionBulkActivate operation:

subscriptionBulkActivateRequest

message type

Structure

The subscriptionBulkActivateRequest message type is structured as follows:

  • filter (SubscriptionSearchFilter, optional)
    • code (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • offerCode (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • offerConditionCode (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • type (NumberAttributeDescription, optional)
        • enumeration (NumberEnumeration)
          • value (Decimal28_6, multiple)
        • range (NumberRange)
          • min (NumberBoundary)
            • @included (boolean)
          • max (NumberBoundary)
            • @included (boolean)
    • effective_date (DateAttributeDescription, optional)
        • enumeration (DateEnumeration)
          • value (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean)
          • max (DateBoundary)
            • @included (boolean)
    • expiration_date (DateAttributeDescription, optional)
        • enumeration (DateEnumeration)
          • value (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean)
          • max (DateBoundary)
            • @included (boolean)
    • priceFreeze_effective_date (DateAttributeDescription, optional)
        • enumeration (DateEnumeration)
          • value (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean)
          • max (DateBoundary)
            • @included (boolean)
    • priceFreeze_expiration_date (DateAttributeDescription, optional)
        • enumeration (DateEnumeration)
          • value (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean)
          • max (DateBoundary)
            • @included (boolean)
    • commitment_expiration_date (DateAttributeDescription, optional)
        • enumeration (DateEnumeration)
          • value (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean)
          • max (DateBoundary)
            • @included (boolean)
    • suspension_date (DateAttributeDescription, optional)
        • enumeration (DateEnumeration)
          • value (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean)
          • max (DateBoundary)
            • @included (boolean)
    • resumption_date (DateAttributeDescription, optional)
        • enumeration (DateEnumeration)
          • value (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean)
          • max (DateBoundary)
            • @included (boolean)
    • cancellation_date (DateAttributeDescription, optional)
        • enumeration (DateEnumeration)
          • value (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean)
          • max (DateBoundary)
            • @included (boolean)
    • batchRatingGroupId (NumberAttributeDescription, optional)
        • enumeration (NumberEnumeration)
          • value (Decimal28_6, multiple)
        • range (NumberRange)
          • min (NumberBoundary)
            • @included (boolean)
          • max (NumberBoundary)
            • @included (boolean)
    • rerating_lock_code (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • rerating_last_status (NumberAttributeDescription, optional)
        • enumeration (NumberEnumeration)
          • value (Decimal28_6, multiple)
        • range (NumberRange)
          • min (NumberBoundary)
            • @included (boolean)
          • max (NumberBoundary)
            • @included (boolean)
    • rerating_last_code (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • rerating_suggested_date (DateAttributeDescription, optional)
        • enumeration (DateEnumeration)
          • value (Date, multiple)
        • range (DateRange)
          • min (DateBoundary)
            • @included (boolean)
          • max (DateBoundary)
            • @included (boolean)
    • partitionID (NumberAttributeDescription, optional)
        • enumeration (NumberEnumeration)
          • value (Decimal28_6, multiple)
        • range (NumberRange)
          • min (NumberBoundary)
            • @included (boolean)
          • max (NumberBoundary)
            • @included (boolean)
    • status (NumberAttributeDescription, optional)
        • enumeration (NumberEnumeration)
          • value (Decimal28_6, multiple)
        • range (NumberRange)
          • min (NumberBoundary)
            • @included (boolean)
          • max (NumberBoundary)
            • @included (boolean)
    • additionalInfo (AdditionalAttributeDescription, optional, multiple)
      • name (String256)
        • pattern (String256)
        • stringEnumeration (StringEnumeration)
          • value (String2000, multiple)
        • numberEnumeration (NumberEnumeration)
          • value (Decimal28_6, multiple)
        • dateEnumeration (DateEnumeration)
          • value (Date, multiple)
        • numberRange (NumberRange)
          • min (NumberBoundary)
            • @included (boolean)
          • max (NumberBoundary)
            • @included (boolean)
        • dateRange (DateRange)
          • min (DateBoundary)
            • @included (boolean)
          • max (DateBoundary)
            • @included (boolean)
    • subscriptionSpecificFormula (SubscriptionSpecificFormula, optional, multiple, {mustBeRoot|isOffline|isHybrid|isOnline|isLocked|isNotLocked})
    • searchWindow (SearchFilterWindow, optional)
      • windowSize (int, optional)
      • fromUniqueId (String256, optional)
    • totalCountRequired (boolean, optional)
  • toDate (Date)
  • maxThroughput (Integer)

subscriptionBulkActivateResponse

message type

Structure

The subscriptionBulkActivateResponse message type is structured as follows:

  • id (Long, optional)
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

chargedItemLoad

Service Operation

Message Types

The following message types are specified for the chargedItemLoad operation:

chargedItemLoadRequest

message type

Structure

The chargedItemLoadRequest message type has no contents.

chargedItemLoadResponse

message type

Structure

The chargedItemLoadResponse message type is structured as follows:

  • id (Long, optional)
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

ratingSessionStart

Service Operation

Message Types

The following message types are specified for the ratingSessionStart operation:

ratingSessionStartRequest

message type

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)

ratingSessionStartResponse

message type

Structure

The ratingSessionStartResponse message type is structured as follows:

  • id (Long, optional)
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)

jobStatusRead

Service Operation

Message Types

The following message types are specified for the jobStatusRead operation:

jobStatusReadRequest

message type

Structure

The jobStatusReadRequest message type is structured as follows:

  • id (Long)

jobStatusReadResponse

message type

Structure

The jobStatusReadResponse message type is structured as follows:

  • ratingJobStatus (RatingJobStatus, optional, {init|running|success|inError})
  • status (ResponseStatus, {return|error})
  • message (string, optional)
  • error (Failure, optional)
    • category (FailureCategory, optional, {alreadyExists|doesNotExist|invalid|prerequisiteMissing|incompatibleConfiguration|illegalState|temporaryIllegalState})
    • message (string, optional)
    • cause (FailureCause, optional)
      • module (string)
      • code (int)
      • message (string)
    • causedBy (FailureCause, optional, multiple)
      • module (string)
      • code (int)
      • message (string)
Copyright© 2011 SAP AG