QueryCustomerStructure

The QueryCustomerStructure 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 retrieve a view of the Network In the context of CMP, the infrastructure on which usage of registered customers will be measured – this could be a mobile phone network, broadband network or other non-telecommunications network. Provider's CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. structure, including the Group, Corporate(s), 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.(s) and 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(s).

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 entity code (for example: Group Code, Corporate Code, Account Number or Subscription Number) in order to retrieve the associated network provider's structure details, as held in 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. structure screen within AgentView The graphical user interface of the CMP that is typically used by Customer Service Agents to access CMP customer and billing data. In versions prior to CMP 8.0, this was called the CMP GUI.. Identifiers are returned but not the full details.

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

This query returns a subset of the details for the customer structure according to the customer level ID (Group Code, Corporate Code, Account Number or Subscription Number) and the type of filter specified in the request. It is possible to filter the data as follows:

Immediate Children

Immediate children only return the children nodes of the selected node.

• Group - returns associated Corporates.
• Corporate -returns associated Accounts.
• Account - returns associated Subscriptions.
• Subscription - returns nothing since there are no children.

All Dependents

All dependents return all nodes that are dependent on the selected node.

• Group - returns associated Corporates, child Accounts for the returned Corporates, and child Subscriptions for the returned Accounts.
• Corporate - returns associated Accounts, and child Subscriptions for the returned Accounts if it exists.
• Account - returns child Subscriptions if it exists.
• Subscription - returns nothing since there are no children.

Ancestor

Ancestor is the return path to the highest node in the tree.

• Group - returns nothing.
• Corporate - returns associated parent Group if it exists.
• Account - returns parent Corporate if it exists, and parent Group for the Corporate if it exists.
• Subscription - returns parent Account, the parent Corporate for the Account if it exists, and the parent Group for the Corporate if it exists.

A configurable limit is applied to limit the maximum number of nodes returned. If this limit is exceeded, no records are returned and the element QueryLimitExceeded is set to 'True' to notify the user that the query limit has been reached.

QueryCustomerStructure Request

The QueryCustomerStructure tag instructs the Structure Service to query the customer structure. This request contains the following elements:

Element Name	Content Type	Description	Required?
CustomerStructureQueryData	Container	See CustomerStructureQueryData request container for details.	Mandatory

CustomerStructureQueryData Request Container

The CustomerStructureQueryData request container has the following elements:

Element Name	Content Type	Description	Required?
External Reference	String69	The client may use this identifier to correlate the request and the response.	Optional
CustomerLevel	String	Valid values: Group Corporate Account Subscription	Mandatory
CustomerLevelId	String8	The identifier for the CustomerLevel specified i.e. Group Code, Corporate Code, Account Number or Subscription Number.	Mandatory
TreeFilter	String	Valid values: ImmediateChildren AllDependents Ancestors If this element is not populated in the request, ImmediateChildren is used as default.	Optional
SubscriptionStatusFilter	String	Valid values: ALL ACTIVE	Optional

QueryCustomerStructure Response

QueryCustomerStructure response is the response to the QueryCustomerStructure request. This contains the following result 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
QueryLimitExceeded	Boolean	CMP query web services can impose a configurable limit on the amount of data that can be returned by a query.	Mandatory
CustomerLevel	String	Valid values: Group Corporate Account Subscription	Mandatory
CustomerNode	Container	Choice of: Group Corporate Account See CustomerNode response container for details.	Optional

CustomerNode Response Container

The CustomerNode response container has the following elements:

Element Name	Content Type	Description	Required?
Group	Container	See Group response container for details.	Mandatory
Corporate	Container	See Corporate response container for details.	Mandatory
Account	Container	See Account response container for details.	Mandatory

Group Response Container

The Group response container has the following elements:

Element Name	Content Type	Description	Required?
GroupCode	String6	The Group to which the Corporate will be added. If not specified, the account will not be associated with any corporate.	Mandatory
GroupDescription	String60	This contains a full description of the Group.	Optional
Corporates	Container	Contains zero or more of Corporate response containers	Optional

Corporates Response Container

The Corporates response container has the following elements:

Element Name	Content Type	Description	Required?
Corporate	Container	See Corporate response container for details.	Mandatory

Corporate Response Container

The Corporate response container has the following elements:

Element Name	Content Type	Description	Required?
CorporateCode	String6	The Corporate to which the account will be added. If not specified, the Account will not be associated with any Corporate.	Mandatory
CorporateDescription	String30	This contains a full description of the Corporate.	Optional
PostingAccountNumber	Integer	This is returned to the user if the request is successful. The Posting Account can be changed from that created at Corporate creation.	Optional
Accounts	Container	Contains zero or more of the Account response container.	Optional

Accounts Response Container

The Accounts response container has the following elements:

Element Name	Content Type	Description	Required?
Account	Container	See Account response container for details.	Mandatory

Account Response Container

The Account response container has the following elements:

Element Name	Content Type	Description	Required?
AccountNumber	Integer8	The unique system generated reference number for the Account.	Mandatory
AccountName	String60	The name of the Account on which the order was raised.	Optional
Subscriptions	Container	Contains zero or more of Subscription. See Subscription response container for details.	Optional

Subscriptions Response Container

The Subscriptions response container has the following elements:

Element Name	Content Type	Description	Required?
Subscription	Container	See Subscription response container for details.	Mandatory

Subscription Response Container

The Subscription response container has the following elements:

Element Name	Content Type	Description	Required?
SubscriptionNumber	Integer8	The unique system generated reference number for the Subscription.	Mandatory
SubscriptionUserName	String30	This displays a history of all user name changes for the associated Subscription.	Optional
ConnectedDate	Date	This displays a date on which the Subscription is connected. YYYY-MM-DDZ	Optional
DisconnectedDate	Date	This displays a date on which the Subscription is disconnected. YYYY-MM-DDZ	Optional
PrimarySerialNumber	String25	This contains the customer's primary serial number defaulted in from the Subscription record.	Optional
TariffCode	String6	Unique identifier code for the tariff. The Tariff is what determines the network that the Subscription will be added to. The network that a Subscription is going to go onto is what determines the following that are presented to the user in AgentView or are valid to populate via a Web Service.	Optional
CustomerCostCentre	String20	This is optional but if supplied it must be a valid one. The list of valid cost centres is defined against the agreement that was selected. This list can be viewed via AgentView in the "Cost Centres" tab.	Optional
NetworkCode	String6	Populated from the Network file. If a network is selected, only consider Subscriptions where the network code value on the Subscription file equals the value entered.	Optional
Terminated	Boolean	Indicates if the Termination Invoice has been produced.	Mandatory
LinkTargetReference	Container	Not currently used. Choice container to allow for future expansion.	Optional