Set Attributes
Attributes are a configurable list of values that can be associated with entities such as Price Plans and Packages to provide more information on the entity.
The Set Attributes 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/update an Attribute Group and Attribute Values against a pre-configured list of Attributes (for example, a specific 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. or Subscriber).
The service can also be used to set/update the Group and/or Values at any time by supplied valid Attribute data.
The number of Attributes that are valid for each Attribute Group can vary and is dependent on 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. configuration in CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers.. It is this configuration that is used to determine if the request is valid when a user A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. supplies an Attribute Group and Values.
Using the Set Attributes web service to update Attributes can be utilised by the client in two ways:
- Update Attribute Group and Attribute(s).
- Update Attribute(s).
Option 1 - New Group and New Attributes
- The client calling system must provide a new Attribute Group ID, Attributes IDs and Values. This allows the user to change the existing Group that is assigned to the account, and store Values against each of the new Attributes.
- The Group ID must be valid for the Account or 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 that has been supplied.
- If the Group ID is valid, the Attribute IDs are validated to ensure they all exist in the CMP configuration for the Attribute Group. If any Attribute ID is not valid then an error response is returned to the client and no updates are made.
The supplied attribute Group level and Customer level must be configured in CMP, otherwise the request fails validation.
Option 2 - Existing Group and Update Attribute(s)
- The client calling system must supply the existing Group ID, along with new values for the Attribute IDs provided.
- The Attribute IDs are validated to ensure they all exist in the CMP configuration for the Attribute Group. If any Attribute ID is not valid then an error response is returned to the client and no updates are made.
- Any Attribute IDs not provided for the customer remain with their current values.
Any valid updates made using either Option 1 or 2 create a new effective record for the Attributes, as it does when a user updates the Attributes using the diseMP UI. This means the new and previous Attributes, along with their effective dates, are visible to a user in the diseMP UI.
SetAttributes Request
The SetAttributes tag instructs the Billing Service to set the Attribute Group and/or Values. This request contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String |
The client may use this identifier to correlate the request and the response. |
Optional |
|
TargetIdentifier |
Container |
Choice of:
|
Mandatory |
|
AttributeGroup |
Container |
See AttributeGroup Request Container for details. |
Mandatory |
|
AuditRecord |
Container |
See AuditRecord Request Container for details. |
Optional |
AttributeGroup Request Container
The Set AttributeGroup request container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
AttributeGroupId |
String6 |
This identifies a new Attribute Group to change to as described in Option 1; or the existing Attribute Group to update as described in Option 2. |
Mandatory |
|
Attribute |
Container |
Zero or more repetitions. See Attribute Request Container for details. |
Mandatory |
Attribute Request Container
The Attribute request container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
AttributeId |
Integer2 |
A unique ID for the Attribute. For example, 01. This is chosen from a list of Attributes configured against the chosen Attribute Group in CMP Back Office Configuration. |
Optional |
|
AttributeValue |
String |
A full description of the Attribute. For example, Dedicated Lease Line Connection. |
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 |
SetAttributes Response
The SetAttributes response is the response to the SetAttributes 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. |
Optional |