Technical Details

chargingContractStateManagement

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 (chargingContractStateManagement) 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: chargingContractStateChange

The following message types are specified for the chargingContractStateChange operation:

Message Type: chargingContractStateChangeRequest

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

Structure

The chargingContractStateChangeRequest message type is structured as follows:

  • date (Date)
  • chargingContractState (ChargingContractState)
    • chargingContractId (NotEmptyString256)
    • counter ... (SharedCounterType, optional, multiple)
    • chargingContractItemState ... (ChargingContractItemState, optional, multiple)
      • chargingContractItemId (NotEmptyString256)
      • counter ... (CounterType, optional, multiple)
      • chargeActivationState ... (ChargeActivationState, optional, multiple)
        • chargeActivationId (NotEmptyString256)

          • neverActivated (ChargeActivationStatus)
          • active (ChargeActivationStatusWithLastActivationDate)
            • lastActivationDate (Date)
          • suspended (ChargeActivationStatusWithLastActivationDate)
            • lastActivationDate (Date)
        • counter ... (CounterType, optional, multiple)

Message Type: chargingContractStateChangeResponse

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

Structure

The chargingContractStateChangeResponse 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 (String256, optional)
  • reference (String256, optional)

Operation: chargingContractStateChangeBundle

The following message types are specified for the chargingContractStateChangeBundle operation:

Message Type: chargingContractStateChangeBundleRequest

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

Structure

The chargingContractStateChangeBundleRequest message type is structured as follows:

  • chargingContractStateChangeRequest ... (chargingContractStateChangeRequest, multiple (max: 1000))

Message Type: chargingContractStateChangeBundleResponse

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

Structure

The chargingContractStateChangeBundleResponse 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)
  • chargingContractStateChangeResponse ... (chargingContractStateChangeResponse, optional, multiple (max: 1000))

Operation: chargingContractStateChangeMass

The following message types are specified for the chargingContractStateChangeMass operation:

Message Type: chargingContractStateChangeMassRequest

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

Structure

The chargingContractStateChangeMassRequest message type is structured as follows:

  • chargingContractStateChangeRequest ... (chargingContractStateChangeRequest, multiple (max: 1000))

Message Type: chargingContractStateChangeMassResponse

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

Structure

The chargingContractStateChangeMassResponse 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)
  • failures (Integer, optional)
    The number of erroneous single operations due to a business error. Check the error stack (category, message, cause).
  • chargingContractStateChangeResponse ... (chargingContractStateChangeResponse, optional, multiple (max: 1000))

Operation: chargingContractStateRead

The following message types are specified for the chargingContractStateRead operation:

Message Type: chargingContractStateReadRequest

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

Structure

The chargingContractStateReadRequest message type is structured as follows:

Message Type: chargingContractStateReadResponse

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

Structure

The chargingContractStateReadResponse 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)
  • chargingContractState (ChargingContractState, optional)
    • chargingContractId (NotEmptyString256)
    • counter ... (SharedCounterType, optional, multiple)
    • chargingContractItemState ... (ChargingContractItemState, optional, multiple)
      • chargingContractItemId (NotEmptyString256)
      • counter ... (CounterType, optional, multiple)
      • chargeActivationState ... (ChargeActivationState, optional, multiple)
        • chargeActivationId (NotEmptyString256)

          • neverActivated (ChargeActivationStatus)
          • active (ChargeActivationStatusWithLastActivationDate)
            • lastActivationDate (Date)
          • suspended (ChargeActivationStatusWithLastActivationDate)
            • lastActivationDate (Date)
        • counter ... (CounterType, optional, multiple)

Simple Types

The message types use the following simple types:

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
Copyright© 2016 SAP SE or an SAP affiliate company. All rights reserved.