Composite Service

The information in this section corresponds to the CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Toolbox web services as specified in the compositeservice.wsdl.

The following web services are included:

Manage Subscription Services

ManageSubscriptionServices

The ManageSubscriptionServices toolbox web service XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external client system to upgrade a Service in one operation.

Upgrading a Service allows an existing subscribed Service to be replaced by another Service . This means that two actions are occurring at once:

Expiring the existing Service by setting the expiry date
Adding a new Service to be effective the day after the existing one expires, and updating the 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 Service History file.

The following three distinct types of Service can be passed in:

Upgrade Services
Create Services
Update Services

It is possible to upgrade several different Service at the same time as the web service will accept a number of these in one request. In order to facilitate this, some specific validation must be performed:

The same Service Code cannot be referenced in more than one UpgradeFromService element as it is not possible to upgrade the Service twice at the same time.
The same Service Code cannot be referenced in more than one UpgradeToService element as it is not possible to upgrade two separate Service to the same Service code. In this scenario the user A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. should be expiring one of the Services outside the Upgrade Service call.
None of the Service Codes in the UpgradeToService element must conflict with any existing Service that are on the Subscription or with any of the other Service that are being added/updated in this service call.

All other validation is the same as performed in CMP when updating/adding a Service.

ManageSubscription Request

The ManageSubscription tag instructs the Manage Subscription Service to upgrade, create or update Services. This request contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	The client may use this identifier to correlate the request and the response.	Optional
SubscriptionNumber	Integer8	The unique system generated reference number for the Subscription	Mandatory
ManageSubscriptionServices	Container	One or more repetitions of the following containers: UpgradeServices CreateServices UpdateServices See individual request containers for details.	Optional
AuditRecord	Container	See the AuditRecord Request Container page for further information.	Optional

UpgradeServices Request Container

The UpgradeServices request container includes the following elements:

Element Name	Content Type	Description	Required?
UpgradeService	Container	See UpgradeService request container for more information.	Optional

UpgradeService Request Container

The UpgradeService request container includes the following elements:

Element Name	Content Type	Description	Required?
UpgradeOn	Container	Choice of: UpgradeDate Upgrade At Next Expected Invoice Date	Mandatory
UpgradeFromService	Container	Contains: Service Code Effective Date	Mandatory
UpgradeToService	Container	See UpgradeToService request container for details.	Mandatory

Element Name

Content Type

Description

Required?

UpgradeOn

Container

Choice of:

UpgradeDate
Upgrade At Next Expected Invoice Date

Mandatory

UpgradeFromService

Container

Contains:

Service Code
Effective Date

Mandatory

UpgradeToService

Container

See UpgradeToService request container for details.

Mandatory

UpgradeToService Request Container

The UpgradeToService request container includes the following elements:

Element Name	Content Type	Description	Required?
ServiceCode	String6	The Code attributed to the Service as it appears on the invoice. This is the Service to which the subscriber is upgrading.	Mandatory
ServicePrice	Currency (Decimal)	Min Inclusive - 0.00 Max Inclusive - 999999999.99	Optional
ExpiryDate	Date	The date on which the previous Service is due to expire. YYYY-MM-DDZ	Optional
Description	String30	The short descriptive text (30-characters) attributed to the new Service attributed as it appears on the invoice (for example, Line rental charge).	Optional
LongDescription	String120	This details a longer descriptive text attributed to the new Service (120-characters).	Optional
SuppressRemainingCharge	Boolean	This is a Y/N flag which is used by Invoice Production to determine whether or not to apply the contract expiry charge to the subscriber as part of generating the invoice.	Optional
ContractReference	String12	This is a Reference ID that can be assigned to the individual service contract.	Optional
SalesPersonId	Integer8	The sales person or sales channel (Dealer, Internet, Call Centre, etc.) via which the upgrade was ordered.	Optional
SalesAccountReference	Integer8	A unique Reference Number for the sales person or sales channel (Dealer, Internet, Call Centre, etc.) via which the upgrade was ordered.	Optional

CreateServices Request Container

The CreateServices request container includes the following elements:

Element Name	Content Type	Description	Required?
Service	Container	See Service request container for more information.	Optional

Service Request Container

The Service request container includes the following elements:

Element Name	Content Type	Description	Required?
ServiceCode	String6	This details the Code attributed to the Service as it appears on the invoice.	Mandatory
ServicePrice	Currency (Decimal)	Min Inclusive - 0.00 Max Inclusive - 999999999.99	Optional
ExpiryDate	Date	The date on which the Service is due to expire. YYYY-MM-DDZ	Optional
Description	String30	This details the short descriptive text (30-characters) attributed to the Service as it appears on the invoice (for example, Line rental charge).	Optional
LongDescription	String120	This details a longer descriptive text attributed to the Service (120-characters).	Optional
SuppressRemainingCharge	Boolean	This is a Y/N flag which is used by Invoice Production to determine whether or not to apply the contract expiry charge to the subscriber as part of generating the invoice.	Optional
ContractReference	String12	This is a Reference ID that can be assigned to the individual service contract.	Optional
EffectiveDate	Date	The date on which the Service becomes effective. YYYY-MM-DDZ	Mandatory
SalesPersonId	Integer8	The sales person or sales channel (Dealer, Internet, Call Centre, etc.) via which the upgrade was ordered.	Optional
SalesAccountReference	Integer8	A unique reference number for the sales person or sales channel (Dealer, Internet, Call Centre, etc.) via which the upgrade was ordered.	Optional
AccountServiceAgreement	String8	This is used to enter the number of an active account's services agreement. A single agreement from within the same structure as the account is required to control the billing pattern of all of an account's services.	Optional

UpdateServices Request Container

The UpdateServices request container includes the following elements:

Element Name	Content Type	Description	Required?
UpdateService	Container	See UpdateService request container for more information.	Optional

UpdateService Request Container

The UpdateService request container includes the following elements:

Element Name	Content Type	Description	Required?
ServiceCode	String6	This details the code attributed to the Service as it appears on the invoice.	Mandatory
ServicePrice	Currency (Decimal)	Min Inclusive - 0.00 Max Inclusive - 999999999.99	Optional
ExpiryDate	Date	Sets the expiry date of the Service. Where the expiryDate is already set, this can be cleared if this is in the future by passing through the zero date 1899-01-01. YYYY-MM-DDZ	Optional
Description	String30	This details the short descriptive text (30-characters) attributed to the Service as it appears on the invoice (for example, Line rental charge).	Optional
LongDescription	String	This details a longer descriptive text attributed to the Service (120-characters).	Optional
SuppressRemainingCharge	Boolean	This is a Y/N flag which is used by Invoice Production to determine whether or not to apply the contract expiry charge to the subscriber as part of generating the invoice.	Optional
ContractReference	String12	This is a Reference ID that can be assigned to the individual service contract.	Optional
EffectiveDate	Date	The date from which the Service becomes effective. YYYY-MM-DDZ	Mandatory

AuditRecord Request Container

The AuditRecord request container has the following elements:

Element Name	Content Type	Description	Required?
UserID	String10	User ID associated with the profile. This is the ID which the calling program adds to the records that are created.	Mandatory
Program	String10	The Program Name should be hard coded in the calling application to uniquely identify that application.	Mandatory

ManageSubscriptionServices Response

The ManageSubscriptionServices response is the response to the ManageSubscriptionServices Request. This contains the following result element:

Element Name	Content Type	Description	Required?
ExternalReference	String69	Returned unmodified in the response. The client may use this identifier to correlate the request and the response.	Optional