QueryAgreementStructure

The QueryAgreementStructure 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 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.'s CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. structure associated with the 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. submitted within the web service request, 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 Agreement Number in order to retrieve the customer structure details associated with that Agreement. Identifiers are returned, but not the full details.

The maximum number of Subscriptions that are associated to the specified Agreement Number should not exceed a limit of 20 to avoid performance problems when dealing with larger structures.

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

QueryAgreementStructure Request

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

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

CustomerAgreementQueryData Request Container

The CustomerAgreementQueryData 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
AgreementNumber	Integer8	The unique system generated reference number for the Agreement.	Mandatory

QueryAgreementStructure Response

The QueryAgreementStructure response is the response to the QueryAgreementStructure 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
QueryLimitExceeded	Integer8	CMP query web services can impose a configurable limit on the amount of data that can be returned by a query. If this limit is exceeded, 'True' is returned, otherwise 'False'.	Mandatory
CustomerLevel	String	The level in the customer structure the Agreement is logged. Valid values are: Group Corporate Account Subscription	Mandatory
CustomerNode	Container	Choice of: Group Corporate Account See CustomerNode Response Container.	Mandatory

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