QueryEmails
The QueryEmails 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 query email addresses at any level of the CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. hierarchy. The service accepts a 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. Level and Reference - for example 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 Number, 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. Number etc. All email addresses associated with the CMP hierarchy level are returned.
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 an identifier in order for the associated email addresses to be retrieved.
QueryEmails Request
The QueryEmails tag instructs the Address Service to query any level of the CMP hierarchy for an email address. 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 |
|
TargetIdentifier |
Container - Choice |
Choice of:
|
Mandatory |
QueryEmails Response
The QueryEmails response is the response to the QueryEmails Address Request. It returns an array of email addresses. The response contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
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 |
|
QueryLimitExceeded |
Boolean |
Set to True if the maximum number of records that may be returned as defined in the configuration, was exceeded. |
Mandatory |
|
TargetIdentifier |
Container - Choice |
Choice of:
|
Mandatory |
|
Emails |
Container |
See EmailData Response Container for details. |
Mandatory |
Emails Response Container
The Emails response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Element Name |
Content Type |
Description |
Required? |
|
|
Container |
See Email response container for details. |
Optional |
Email Response Container
The Email response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
EmailAddress |
String70 |
This details the email address in standard format (e.g. name@network.com, or name@network.co.uk). |
Mandatory |
|
PrimaryEmailAddress |
Boolean |
Setting this to true makes the email address the primary contact address for correspondence. |
Mandatory |
|
EmailAddressType |
String6 |
Address types include Home, Work, ISP. |
Mandatory |
|
Active? |
Boolean |
Setting to True makes the email address active. |
Mandatory |
|
LastAmendedDate |
dateTime |
YYYY-MM-DDThh:mm:ssZ |
Mandatory |