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

catalog

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

chargePlanClassFind

Service Operation

Message Types

The following message types are specified for the chargePlanClassFind operation:

chargePlanClassFindRequest

message type

Structure

The chargePlanClassFindRequest message type is structured as follows:

  • chargePlanClassSearchFilter (ChargePlanClassSearchFilter)
    • id (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • description (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • status (Status, optional, {open|released|obsolete})
    • 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)

chargePlanClassFindResponse

message type

Structure

The chargePlanClassFindResponse message type is structured as follows:

  • chargePlanClass (ChargePlanClass, optional, multiple)
    • parameter (Parameter, optional, multiple)
      • name (String256)
      • description (String2000, optional)
        • string (String2000, nillable)
        • date (Date, nillable)
        • number (Decimal28_6, nillable)
      • additionalInfo (AdditionalInfo, optional, multiple)
        • name (String256)
        • description (String2000, optional)
          • string (String2000)
          • date (Date)
          • number (Decimal28_6)
    • counter (Counter, optional, multiple)
      • name (String256)
      • description (String2000, optional)
    • accountAssignment (TypedAccountAssignment, optional, multiple)
      • type (AccountType, {postpaid|prepaid})
      • name (String256)
      • description (String2000, optional)
    • userTechnicalIdentifier (ChargePlanClassUserTechnicalIdentifier, optional, multiple)
      • serviceTechnicalIdentifier (ServiceTechnicalIdentifier, multiple)
        • name (String256)
      • name (String256)
      • description (String2000, optional)
    • id (String256)
    • owner (String256)
    • status (Status, optional, {open|released|obsolete})
    • description (String2000, optional)
    • additionalInfo (AdditionalInfo, optional, multiple)
      • name (String256)
      • description (String2000, optional)
        • string (String2000)
        • date (Date)
        • number (Decimal28_6)
  • 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)

chargePlanClassDescriptionFind

Service Operation

Message Types

The following message types are specified for the chargePlanClassDescriptionFind operation:

chargePlanClassDescriptionFindRequest

message type

Structure

The chargePlanClassDescriptionFindRequest message type is structured as follows:

  • chargePlanClassSearchFilter (ChargePlanClassSearchFilter)
    • id (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • description (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • status (Status, optional, {open|released|obsolete})
    • 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)

chargePlanClassDescriptionFindResponse

message type

Structure

The chargePlanClassDescriptionFindResponse message type is structured as follows:

  • chargePlanClassDescription (Description, optional, multiple)
    • id (String256)
    • owner (String256)
    • status (Status, optional, {open|released|obsolete})
    • description (String2000, optional)
    • additionalInfo (AdditionalInfo, optional, multiple)
      • name (String256)
      • description (String2000, optional)
        • string (String2000)
        • date (Date)
        • number (Decimal28_6)
  • 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)

refillPlanClassFind

Service Operation

Message Types

The following message types are specified for the refillPlanClassFind operation:

refillPlanClassFindRequest

message type

Structure

The refillPlanClassFindRequest message type is structured as follows:

  • refillPlanClassSearchFilter (RefillPlanClassSearchFilter)
    • id (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • description (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • status (Status, optional, {open|released|obsolete})
    • 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)

refillPlanClassFindResponse

message type

Structure

The refillPlanClassFindResponse message type is structured as follows:

  • refillPlanClass (RefillPlanClass, optional, multiple)
    • parameter (Parameter, optional, multiple)
      • name (String256)
      • description (String2000, optional)
        • string (String2000, nillable)
        • date (Date, nillable)
        • number (Decimal28_6, nillable)
      • additionalInfo (AdditionalInfo, optional, multiple)
        • name (String256)
        • description (String2000, optional)
          • string (String2000)
          • date (Date)
          • number (Decimal28_6)
    • counter (Counter, optional, multiple)
      • name (String256)
      • description (String2000, optional)
    • accountAssignment (AccountAssignment)
      • name (String256)
      • description (String2000, optional)
    • userTechnicalIdentifier (UserTechnicalIdentifier, optional, multiple)
      • name (String256)
      • description (String2000, optional)
    • id (String256)
    • owner (String256)
    • status (Status, optional, {open|released|obsolete})
    • description (String2000, optional)
    • additionalInfo (AdditionalInfo, optional, multiple)
      • name (String256)
      • description (String2000, optional)
        • string (String2000)
        • date (Date)
        • number (Decimal28_6)
  • 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)

refillPlanClassDescriptionFind

Service Operation

Message Types

The following message types are specified for the refillPlanClassDescriptionFind operation:

refillPlanClassDescriptionFindRequest

message type

Structure

The refillPlanClassDescriptionFindRequest message type is structured as follows:

  • refillPlanClassSearchFilter (RefillPlanClassSearchFilter)
    • id (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • description (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • status (Status, optional, {open|released|obsolete})
    • 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)

refillPlanClassDescriptionFindResponse

message type

Structure

The refillPlanClassDescriptionFindResponse message type is structured as follows:

  • refillPlanClassDescription (Description, optional, multiple)
    • id (String256)
    • owner (String256)
    • status (Status, optional, {open|released|obsolete})
    • description (String2000, optional)
    • additionalInfo (AdditionalInfo, optional, multiple)
      • name (String256)
      • description (String2000, optional)
        • string (String2000)
        • date (Date)
        • number (Decimal28_6)
  • 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)

mappingTableClassFind

Service Operation

Message Types

The following message types are specified for the mappingTableClassFind operation:

mappingTableClassFindRequest

message type

Structure

The mappingTableClassFindRequest message type is structured as follows:

  • mappingTableClassSearchFilter (MappingTableClassSearchFilter)
    • id (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • description (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • searchWindow (SearchFilterWindow, optional)
      • windowSize (int, optional)
      • fromUniqueId (String256, optional)
    • totalCountRequired (boolean, optional)

mappingTableClassFindResponse

message type

Structure

The mappingTableClassFindResponse message type is structured as follows:

  • mappingTableClass (MappingTableClass, optional, multiple)
    • id (String256)
    • owner (String256)
    • description (String2000, optional)
    • inputColumn (MappingTableClassInputColumn, multiple (max: 4))
        • string (String256, nillable)
        • currency (String256, nillable)
      • name (String256)
      • description (String2000, optional)
    • outputColumn (MappingTableClassOutputColumn, optional, multiple (max: 15))
        • string (String256, nillable)
        • number (Decimal28_6, nillable)
      • name (String256)
      • description (String2000, optional)
  • 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)

mappingTableCreate

Service Operation

Message Types

The following message types are specified for the mappingTableCreate operation:

mappingTableCreateRequest

message type

Structure

The mappingTableCreateRequest message type is structured as follows:

  • id (String256)
  • mappingTableClassId (String256)

mappingTableCreateResponse

message type

Structure

The mappingTableCreateResponse 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)

mappingTableCancel

Service Operation

Message Types

The following message types are specified for the mappingTableCancel operation:

mappingTableCancelRequest

message type

Structure

The mappingTableCancelRequest message type is structured as follows:

  • id (String256)

mappingTableCancelResponse

message type

Structure

The mappingTableCancelResponse 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)

mappingTableFind

Service Operation

Message Types

The following message types are specified for the mappingTableFind operation:

mappingTableFindRequest

message type

Structure

The mappingTableFindRequest message type is structured as follows:

  • mappingTableSearchFilter (MappingTableSearchFilter)
    • id (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • mappingTableClassId (StringAttributeDescription, optional)
        • enumeration (StringEnumeration)
          • value (String2000, multiple)
        • pattern (String256)
    • searchWindow (SearchFilterWindow, optional)
      • windowSize (int, optional)
      • fromUniqueId (String256, optional)
    • totalCountRequired (boolean, optional)

mappingTableFindResponse

message type

Structure

The mappingTableFindResponse message type is structured as follows:

  • mappingTable (MappingTable, optional, multiple)
    • id (String256)
    • mappingTableClassId (String256)
    • owner (String256)
    • row (MappingTableRow, optional, multiple)
      • id (String256)
      • start (Date)
      • end (Date)
      • column (MappingTableColumn, multiple)
        • name (String256)
          • string (String2000)
          • currency (String2000)
          • number (Decimal28_6)
  • 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)

mappingTableRowMaintain

Service Operation

Message Types

The following message types are specified for the mappingTableRowMaintain operation:

mappingTableRowMaintainRequest

message type

Structure

The mappingTableRowMaintainRequest message type is structured as follows:

  • mappingTableId (String256)
  • row (MappingTableRow, multiple)
    • id (String256)
    • start (Date)
    • end (Date)
    • column (MappingTableColumn, multiple)
      • name (String256)
        • string (String2000)
        • currency (String2000)
        • number (Decimal28_6)

mappingTableRowMaintainResponse

message type

Structure

The mappingTableRowMaintainResponse message type is structured as follows:

  • mappingTableId (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)

mappingTableRowCancel

Service Operation

Message Types

The following message types are specified for the mappingTableRowCancel operation:

mappingTableRowCancelRequest

message type

Structure

The mappingTableRowCancelRequest message type is structured as follows:

  • mappingTableId (String256)
  • id (String256, multiple)

mappingTableRowCancelResponse

message type

Structure

The mappingTableRowCancelResponse message type is structured as follows:

  • mappingTableId (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)
Copyright© 2011 SAP AG