|
Field Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
Returned un-modified in the response. The client may use this identifier to correlate the request and the response. |
Optional |
|
SubscriptionNumber |
Number8 |
The id that uniquely identifies the CMP Subscription. |
Optional |
|
PlanCode |
String6 |
This indicates the Price Plan for which the compatible packages are to be determined in a circumstance where the plan is not the one that the subscriber is currently on. This is intended only to be used in the scenario where the Customer is in the process of requesting a plan change and is selecting the bolt-on packages to apply at the same time. |
Optional |
|
EligibilityRules |
Container |
See EligibilityRules Request Container for further details. A parameter name of Category will be supplied and with a value of Bolt-on Packages. |
Optional
|
EligibilityRules Request Container
The QueryCompatiblePlans 'EligibilityRules' Request Container has the following elements:
This Eligibility Rules definition is to be used for both Query Compatible Plans and Query Compatible Packages.
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Sales Channel |
String30 |
The Sales Channel from where this request originates. Different Rules may be invoked based on the Sales Channel. |
Mandatory
|
|
AsOfDate |
Container |
CMP allows three different patterns to supply when querying the dates for which the eligibility and compatibility rules should be returned. If no date information is supplied then a date of today is assumed. A Date parameter or On Bill Cycle may be supplied. See AsOfDate Request Container for further details. |
Optional |
|
Date |
Date |
The date that the compatibility rules should be applied to. |
Conditional |
|
OnBillCycle |
Boolean |
When this is selected then the next bill cycle date is used to determine the list of plans/packages effective and compatible for that date. |
Conditional |
|
Parameters |
Container |
A facility to provide a list of name value pair specific to each implementation. See Parameters Request Container for further details. |
Optional |
AsOfDate Request Container
The 'AsOfDate' Request Container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Date |
Date |
The date that the compatibility rules should be applied to. |
Conditional |
|
OnBillCycle |
Boolean |
When this is selected then the next bill cycle date is used to determine the list of plans/packages effective and compatible for that date. |
Conditional |
Parameters Request Container
The 'Parameters' Request Container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Name |
String30 |
The valid values for this will be determined by CMP configuration. Possible examples may include Handset Band, Plan Type etc. |
Mandatory |
|
Value |
String120 |
The valid values here will be determined by CMP configuration. |
Mandatory |
Sample QueryCompatiblePackages Request
Request Headers
Accept = application/xml if supplying the request as XML
Exstensible Markup Language. A markup language used to describe data that allows users to define their information formats, especially in order to display documents on the Internet. or application/json to supply the request in JSON JavaScript Object Notation. JSON is a lightweight format for storing and transporting data, often used when data is sent from a server to a web page. format.
Content-Type = application/xml to return the data as XML or application/json to return the data in JSON format.
Request XML
<queryCompatiblePackages>
<externalReference>MYACC-04405500-88888</externalReference>
<subscriptionNumber>60272</subscriptionNumber>
<eligibilityRules>
<salesChannel>MYACCOUNT</salesChannel>
</eligibilityRules>
</queryCompatiblePackages>
QueryCompatiblePackages Response
The 'QueryCompatiblePackages' Response is the response to the 'QueryCompatiblePackages' Request. This contains the following fields:
|
Field Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
External Reference |
String69 |
Returned unmodified in the response. The client may use this identifier to correlate the request and the response. |
Optional |
|
PackageGroup |
Container |
See PackageGroup Response Container for further details. |
Optional |
PackageGroup Response Container
The 'PackageGroup' Response Container has the following elements:
|
Field Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Code |
String10 |
Unique identifier for the Package group. |
Mandatory |
|
Description |
String60 |
Description of the Package group. |
Mandatory |
|
Cardinality |
Container |
Allows specification of the minimum and maximum number of items that may be selected from this group. This will be used for example to provide for t he selection of mutually exclusive Data Bolt-on Packages. See Cardinality Response Container for further details. |
Mandatory |
|
Packages |
Container |
Container for one or more Package definitions. See Package Response Container for further details. |
Optional |
Cardinality Response Container
The 'Cardinality' Response Container has the following elements:
|
Field Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Min |
Integer |
A value that represents the minimum number of packages from this group that can be active on a Subscription at any one time. |
Mandatory |
|
Max |
Integer |
A value that represents the maximum number of packages from this group that can be active on a Subscription at any one time. |
Conditional – either Max or NoMax must be returned |
|
NoMax |
boolean |
A value that represents there is no maximum number of packages from this group that can be active on a Subscription at any one time. |
Conditional – either Max or NoMax must be returned |
Packages Response Container
The 'Packages' Response Container has the following container:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Package |
Container |
See Package Response Container for details. |
Optional |
Package Response Container
A package is composed of zero or more Services and zero or more discounts. CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. has two types of package: a base package and a bolt-on An addition to a subscriber's main plan or product; also sometimes called an add-on. package. A particular subscription A billing entity that incurs a charge. Examples include a network attached device whose usage you want to measure and charge for, or a monthly software subscription can have 0 or 1 base package and 0 or many bolt-on packages. For the customer In the context of the Cloud Monetisation Platform, an individual or organisation who has signed an agreement to take goods and services from a service provider. A customer receives a bill associated with one or more subscriptions, and can be a single end user or a large company with many subscriptions assigned to one agreement., each subscription will always have a base package.
A plan specify a base package which contains the inclusive bundles and the MRC as well as any inclusive discounts if required.
Bolt-on packages are used by the customer to apply boosts, discounts and promotions.
The 'Package' Response Container has the following elements:
|
Field Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Code |
String6 |
The package code that uniquely identifies the package in CMP. |
Mandatory |
|
PackageClassification |
Enumeration |
Possible Values:
|
Mandatory |
|
Description |
String30 |
The short description of the package |
Mandatory |
|
LongDescription |
String120 |
The long Description of the package |
Optional |
|
ToolTipText |
String300 |
An extended description that may be used as a tool tip text. |
Optional |
|
DurationInMonths |
Integer2 |
The default number of months that the package will be valid for from the date it is applied to a subscription. In CMP setup, a default is configured against the package which may be overridden when the package is associated with a tariff. This allows the same Service or Discount to be specified in many different packages with different DurationInMonths value. Furthermore, at the point where there package is associated with the tariff, the default DurationInMonths value for individual services and discounts that comprise the package may be overridden. |
Optional |
|
EffectiveDate |
Date |
The date from which this package can be added to a subscription. |
Mandatory |
|
ExpiryDate |
Date |
The date from which this package can no longer be added to a subscription. Note: packages already added to subscriptions will not be affected by the expiry date. |
Optional |
|
Price |
Decimal |
The price of the package. This is derived by summing up the price of the services on the package. It does not apply any Discount. |
Optional |
|
DiscountedPriceAtStart |
Decimal |
The discounted price of the package upon application. If there are no discounts to be applied upon application of package, this field will not be included on the response. Discounts may have a delayed start before they are applied (see MonthsToStart field in the Discount Scheme Container Definition). Those discounts will not be included in the DiscountedPriceAtStart value. Also, the DiscountPriceAtStart can only be applied if the services to which it applies exist within the same Package. E.g. if the Base Package has a Service, MEDMRC, which represents an MRC for 20.00, and the Subscription gets a Discount Promotion (that is, a separate bolt-on Package) for 50% off MEDMRC. Then the DiscountPriceAtStart for this will not appear in any context. The DiscountPriceAtStart will occur in scenarios where the user has a Plan or Bolt-on Package which has a discounted price for the first X months. |
Optional |
|
PrimaryPackageGroupCode |
String10 |
CMP will group packages as part of the compatibility management. |
Optional |
|
Attributes |
Container |
Attributes are a configurable list of values that are used to describe the package See the Attribute Response Container page for details. |
Optional |
|
SubscriptionPackageStatus |
Container |
This is never returned in a Query Compatible Plans Response. It only applies to a Query Compatible Packages response. This is returned for bolt-on packages when the request is in the context of a specific subscription. See the SubscriptionPlanStatus Response Container f further details. |
Optional |
|
Services |
Container |
Contains one or more Service containers. See Service Response Container for further details. |
Optional |
|
DiscountSchemes |
Container |
Contains one or more DiscountScheme containers. See DiscountScheme Response Container for further details. |
Optional |
Attribute Response Container
The 'Attribute' Response Container has the following elements:
|
Field Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Group |
String6 |
The group allows attributes to be grouped together. For instance, to distinguish between descriptive and rules attributes. Descriptive attributes are just for information purposes and rule attributes are what CMP will base its logic on. |
Mandatory |
|
Name |
String30 |
The attribute names are a configurable list of attributes that can be configured to meet a particular business or technical requirement. An example attribute name would be "Band Type". |
Mandatory |
|
Value |
String120 |
This is the value of the attribute. An example of this (for the Attribute name example given above) would be "SIMO" or "2b". |
Mandatory |
SubscriptionPlanStatus Response Container
The 'SubscriptionPlanStatus' Response Container has the following elements:
|
Field Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Status |
Enumeration |
This represents the current status of the plan in relation to the subscription: Possibles statuses are:
'Active' is the current plan that the subscription is on. 'Available 'indicates a plan that is available for the subscriber to move to. |
Mandatory |
DefaultPackages Response Container
The 'DefaultPackages' Response Container has the following elements:
|
Field Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
PackageCode |
String6 |
The identifier for the package. |
Mandatory |
RetainedPackages Response Container
The 'RetainedPackages' Response Container has the following elements:
|
Field Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
PackageCode |
String6 |
The identifier for the package. |
Mandatory |