CreateService

The CreateService 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 create a CMP Cloud Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Service against a 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 or Agreement In the Cloud Monetisation Platform, the entity that holds the instructions for generating the bills for one or more subscriptions. including the addresses and how often the bill is generated. within CMP.

All non-usage The consumption of services, for example a subscriber using call minutes. items applied to a Subscription, whether chargeable or non-chargeable, are referred to as Services. Services can be applied as a one-off (for example: Connection Fee, Administration Fee, Change of Ownership Fee) or can be recurring (for example, Line Rental, Insurance, Itemised Billing).

The user A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. must pass in a valid CMP Service Code, Subscription (or Agreement Number) and an Effective Date for the Service.

A Long Description for the Service is to be specified at the point of creating 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. and Subscription level services.

Submitting invalid data in the request will result in an error message.

CreateService Request

The CreateService tag instructs the Services Service to create a Service. This tag contains the following elements:

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
ServiceData	Container	See Create Service Data Request Container for details.	Mandatory
AuditRecord	Container	See AuditRecord Request Container for details.	Optional

ServiceData Request Container

The ServiceData request container has the following elements:

Element Name	Content Type	Description	Required?
CustomerLevel	String	One of: Subscription Account	Mandatory
CustomerLevelReference	String8	Pass in Subscription Number or Agreement Number depending on Customer Level value.	Mandatory
EffectiveDate	date	YYYY-MM-DDZ	Mandatory
ExpiryDate	date	YYYY-MM-DDZ	Optional
ServiceCode	String6	This details the Code attributed to the Service as it appears on the invoice (for example, LINECH).	Mandatory
SalesPersonId	Integer8	The sales person or sales channel (Dealer, Internet, Call Centre, etc.) via which the connection has been processed.	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
ServicePrice	Currency - Decimal	The Price to be applied to the Service. If this value is not supplied, the price is set to the default from CMP configuration (as per the current logic). Where the value is supplied, it is validated against the min/max values from the Tariff Service File or Service Configuration (as per the current logic when updating the Price via the Update Service web service).	Optional
Description	String30	The Description to be applied to the Subscription Service Record for the Subscriber. If this value is not supplied, the description is set to that from the Tariff Service File or Service Configuration (as per the current logic). Where a description is supplied, the calling system can pass any value of less than 30 characters. The Description value should not be populated for Agreement Services. If supplied, the value will not be applied.	Optional
LongDescription	String	This details a longer descriptive text attributed to the Service (120-characters).	Optional
AccountServiceAgreement	String8	May be supplied when the customer level is Account.	Optional
SuppressRemainingCharge	Boolean	This is a Yes/No option 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
PriceConsolidationService	String6	This indicates the name of the Discount Consolidated Service applied to the Subscription Service in CMP back office.	Optional

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

Sample CreateService Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:def="http://mdsuk.com/ws/dise3g/services/definition">

<soapenv:Header/>

<soapenv:Body>

<def:CreateService>

<def:ServiceData>

<CustomerLevel>SUBSCRIPTION</CustomerLevel>

<serviceCode>SPREMC</serviceCode>

</ServiceData>

<UserID>JOHNRY</UserID>

<Program>TESTS</Program>

</AuditRecord>

</def:ServiceData>

</def:CreateService>

</soapenv:Body>

</soapenv:Envelope>

CreateService Response

CreateService response is the response to the CreateService Request. This contains the following elements:

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.	Mandatory

Sample CreateService Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

<ns2:CreateServiceResponse xmlns:ns2="http://mdsuk.com/ws/dise3g/services/definition" xmlns:ns3="http://mdsuk.com/ws/dise3g/workflow/definition" xmlns:ns4="http://mdsuk.com/ws/dise3g/fault/exception">

<ns2:Result>

</ns2:Result>

</ns2:CreateServiceResponse>

</soapenv:Body>

</soapenv:Envelope>