SOAP Web Services Interface Semantics

This section provides supplemental information relating to the CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. 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. schema that cannot be captured in the schema definitions (WSDLs).

For information about the structure of the web services, refer to the schema definitions.

Each web service is described in the form of an overview followed by a list of the elements that appear in the request and response.

Request and Response

Tables are used to document each request and response. The following describes the columns used on the request and response tables:

Column	Description
Name	The element name - for example UpdateRecurringPaymentDetails. Elements where the content type is Container/Container Choice are shown in a separate section.
Description	A description of the element.
Content Type	Specifies the data type and maximum length of the value associated with the element. For example, String10. Elements that are a holder for other elements have a content type of Container. Elements that are a holder for a choice of other elements will have a content type of Container Choice. Elements where the value to be supplied is to be one of a predefined set, will have a content type of Choice.
Required?	Possible values are: Mandatory, Optional and Conditional.

The CMP database does not store null values; it replaces null with spaces.

Consequently, if you set three fields on a Create request and then perform the corresponding Query, you may get nine fields returned - and six of those could be empty strings.

The tables below define - by examples - the expected behaviour for different data types.

If you have a Create request setting the values as defined in the second column, a subsequent related query returns the value in the third column:

Type	Create Request	Query Response	Information
String	'abc'	'abc'
String	' xyz '	'xyz'	Spaces are trimmed.
String	' '	''	Spaces are trimmed.
String	''	''
String	Not provided	''	The null becomes empty string.
Number	123	123
Number	0	0
Number	Not provided	0
Boolean	true	true
Boolean	false	false
Boolean	Not Provided	false	Default for Booleans is false.
Date	2018-05-14	2018-05-14	Format is YYYY-MM-DDZ
Date	Not Provided	Not Provided	Dates will not have a default. They do in the database but this should be replaced by null.
dateTime	2018-05-14 10:01:02	2018-05-14 10:01:02	Format is YYYY-MM-DDThh:mm:ssZ
dateTime	Not Provided	Not Provided	Datetimes do have a default. They do in the database but this should be replaced by null.

This does not take account In the Cloud Monetisation Platform, a billing entity that can be used to manage payments on one or more subscriptions or payments for services. An account can hold details such as payments or invoices. of derived default data.

If you have an update request setting the values as defined in the second column, a subsequent related query will return the value in the third column:

Type	Update Request	Query Response	Information
String	'abc'	'abc'
String	''	'
String	Not provided	unchanged	The value is not changed in the database.
Number	123	123
Number	0	0
Number	Not provided	unchanged	The value is not changed in the database.
Boolean	true	true
Boolean	false	false
Boolean	Not provided	unchanged	The value is not changed in the database.
Date	2018-05-14	2018-05-14
Date	CLEAR_FIELD	Not Provided	Dates can be set to null
Date	Not provided	unchanged	The value is not changed in the database.
dateTime	2018-05-14 10:01:02	2018-05-14 10:01:02
dateTime	CLEAR_FIELD	Not Provided	Datetimes can be set to null.
dateTime	Not provided	unchanged	The value is not changed in the database

 

This does not take account of derived default data.
This document is updated to 8.22 of CMP. If you are not currently on this release of CMP, please contact your MDS Account Manager to check that you have the correct version of the document.