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

contractProvisioning

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 (contractProvisioning) 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.

chargingContractMaintain

Service Operation

Message Types

The following message types are specified for the chargingContractMaintain operation:

chargingContractMaintainRequest

message type

Structure

The chargingContractMaintainRequest message type is structured as follows:

  • date (Date)
  • chargingContractRevision (ChargingContractRevision)
    • id (String256)
    • subscriberAccountId (String256)
    • additionalInfo (AdditionalInfo, optional, multiple)
      • name (String256)
      • description (String2000, optional)
        • string (String2000)
        • date (Date)
        • number (Decimal28_6)
    • chargingContractItemRevision (ChargingContractItemRevision, optional, multiple)
        • chargePlanClassId (String256)
        • refillPlanClassId (String256)
      • id (String256)
      • externalId (String256, optional)
      • end (Date, optional)
      • sharedCounter (ChargingContractItemSharedCounter, optional, multiple)
        • name (String256)
        • namespace (String256, optional)
      • parameter (ChargingContractItemParameter, optional, multiple)
        • name (String256)
          • string (String2000)
          • date (Date)
          • number (Decimal28_6)
      • userTechnicalIdentifier (ChargingContractItemUserTechnicalIdentifier, optional, multiple)
        • name (String256)
        • userServiceId (String256)
      • accountAssignment (ChargingContractItemRevisionAccountAssignment, optional, multiple)
        • name (String256)
        • accountId (String256)

chargingContractMaintainResponse

message type

Structure

The chargingContractMaintainResponse message type is structured as follows:

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

chargingContractCancel

Service Operation

Message Types

The following message types are specified for the chargingContractCancel operation:

chargingContractCancelRequest

message type

Structure

The chargingContractCancelRequest message type is structured as follows:

  • id (String256)

chargingContractCancelResponse

message type

Structure

The chargingContractCancelResponse message type is structured as follows:

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

chargingContractFind

Service Operation

Message Types

The following message types are specified for the chargingContractFind operation:

chargingContractFindRequest

message type

Structure

The chargingContractFindRequest message type is structured as follows:

  • chargingContractSearchFilter (ChargingContractSearchFilter)
    • 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)

chargingContractFindResponse

message type

Structure

The chargingContractFindResponse message type is structured as follows:

  • chargingContract (ChargingContract, optional, multiple)
    • id (String256)
    • subscriberAccountId (String256)
    • additionalInfo (AdditionalInfo, optional, multiple)
      • name (String256)
      • description (String2000, optional)
        • string (String2000)
        • date (Date)
        • number (Decimal28_6)
    • chargingContractItem (ChargingContractItem, optional, multiple)
        • chargePlanClassId (String256)
        • refillPlanClassId (String256)
      • id (String256)
      • externalId (String256, optional)
      • period (ChargingContractItemPeriod, multiple)
        • start (Date)
        • end (Date, optional)
        • parameter (ChargingContractItemParameter, optional, multiple)
          • name (String256)
            • string (String2000)
            • date (Date)
            • number (Decimal28_6)
        • sharedCounter (ChargingContractItemSharedCounter, optional, multiple)
          • name (String256)
          • namespace (String256, optional)
        • userTechnicalIdentifier (ChargingContractItemUserTechnicalIdentifier, optional, multiple)
          • name (String256)
          • userServiceId (String256)
        • accountAssignment (ChargingContractItemAccountAssignment, optional, multiple)
          • type (String256, {postpaid|prepaid})
          • name (String256)
          • accountId (String256)
  • totalCount (int, optional)
  • lastUniqueId (String256, 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)

chargingContractMaintainBundle

Service Operation

Message Types

The following message types are specified for the chargingContractMaintainBundle operation:

chargingContractMaintainBundleRequest

message type

Structure

The chargingContractMaintainBundleRequest message type is structured as follows:

  • chargingContractMaintainRequest (chargingContractMaintainRequest, multiple (max: 1000))

chargingContractMaintainBundleResponse

message type

Structure

The chargingContractMaintainBundleResponse message type is structured as follows:

  • chargingContractMaintainResponse (chargingContractMaintainResponse, optional, multiple (max: 1000))
  • 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)

chargingContractMaintainMass

Service Operation

Message Types

The following message types are specified for the chargingContractMaintainMass operation:

chargingContractMaintainMassRequest

message type

Structure

The chargingContractMaintainMassRequest message type is structured as follows:

  • chargingContractMaintainRequest (chargingContractMaintainRequest, multiple (max: 1000))

chargingContractMaintainMassResponse

message type

Structure

The chargingContractMaintainMassResponse message type is structured as follows:

  • chargingContractMaintainResponse (chargingContractMaintainResponse, optional, multiple (max: 1000))
  • failures (Integer, 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)
Copyright© 2011 SAP AG