SearchByAttributeValue

The SearchByAttributeValue 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 search Accounts and Subscriptions for an Attribute held in CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. as the search identifier.

The search retrieves all Accounts or Subscriptions matching the Attribute supplied in the request.

The three optional parameters Attribute Group, Attribute ID, and Attribute Status can be used to either narrow or widen the scope of the search. The default action for optional parameters that are not supplied is to ignore that parameter in the search, there by potentially returning a wider result set than if a parameter was supplied.

SearchByAttributeValue Request

The SearchByAttributeValue tag instructs the Search Service to search for Attributes in Accounts and Subscriptions. 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
CustomerLevel	String	Possible values: ACCOUNT SUBSCRIPTION	Mandatory
AttributeValue	String120	The Attribute value to search for.	Mandatory
AttributeGroupCode	String	Identifier for the Attribute Group being searched for.	Optional
AttributeID	String2	Unique reference for the Attribute within the Attribute Group that is being searched.	Optional
AttributeStatus	String	If supplied will search for the status specified. If not supplied then all statuses will be searched. Possible values: ALL CURRENT.	Optional

SearchByAttributeValue Response

The SearchByAttributeValue response is the response to the SearchByAttributeValue 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
SearchResults	Container	The Search Results container contains an Attributes container. The Attributes Response container contains zero or more Account Response containers and zero or more Subscription Response containers.	Optional
QueryLimitExceeded	Boolean	Set to True if the maximum number of records that may be returned as defined in the configuration, was exceeded.	Optional

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

SearchResults

Container

The Search Results container contains an Attributes container.

The Attributes Response container contains zero or more Account Response containers and zero or more Subscription Response containers.

Optional

QueryLimitExceeded

Boolean

Set to True if the maximum number of records that may be returned as defined in the configuration, was exceeded.

Optional

Attributes Response Container

The Attributes response container has the following elements:

Element Name	Content Type	Description	Required?
Attribute	Container	See Attribute response container for details.	Optional

Attribute Response Container

The Attribute response container has the following elements:

Element Name	Content Type	Description	Required?
Account	Container	See Account Response Container for details.	Optional
Subscription	Container	See Subscription Response Container for details.	Optional

Account Response Container

The 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. response container has the following elements:

Element Name	Content Type	Description	Required?
AccountNumber	Integer8	Unique ID for the Account	Mandatory
AccountType	String6	Indicates the sort of Account Type the Subscription belongs to, i.e. Nursery Account.	Optional
AttributeValue	Container	See AttributeValue response container for details.	Optional
AddressNumber	Integer8	The CMP Address Number for the Subscriber.	Optional
AccountUsage	String1	Possible values: Subscription Sales SubscriptionAndSales	Optional
CorporateCode	String6	The ID allocated to the Corporate Account by the system, if appropriate.	Optional
GroupCode	String6	The ID allocated to the Group Account by the system, if appropriate.	Optional

AttributeValue Response Container

The AttributeValue response container has the following elements:

Element Name	Content Type	Description	Required?
AttributeGroupCode	String6	Identifier for the Attribute Group being searched for.	Optional
AttributeId	Decimal2	Unique reference for the Attribute within the Attribute Group that is being searched by.	Optional
AttributeValue	String120	The search text.	Optional
AttributeStatus	String	If supplied will search for the status specified. If not supplied then all statuses will be searched. Possible values: ALL CURRENT.	Optional

Subscription Response Container

The 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 response container has the following elements:

Element Name	Content Type	Description	Required?
SubscriptionNumber	Integer8	The unique system generated reference number for the Subscription.	Mandatory
AgreementNumber	Integer8	The CMP Agreement Number of the Subscription.	Mandatory
AccountNumber	Integer8	Unique ID for the Account.	Optional
AttributeValue	Container	See AttributeValue Response Container for details.	Optional
CorporateCode	String6	The ID allocated to the Corporate Account by the system, if appropriate.	Optional
GroupCode	String6	The ID allocated to the Group Account by the system, if appropriate.	Optional
CompanyNumber	String3	The Company Number to be assigned to the account. Value must already be setup in CMP.	Mandatory
TariffCode	String	Unique identifier code for the Tariff. The Tariff is what determines the network that the Subscription will be added to.	Mandatory
NetworkCode	String6	The Network Code of the Network that the Subscription is on. If a Network is selected, only Subscriptions where the Network Code value on the Subscription file equals this value are returned.	Optional
DisconnectedDate	Date	This displays the date of Subscription disconnection. YYYY-MM-DDZ	Optional
ConnectedDate	Date	This displays the date of Subscription connection. YYYY-MM-DDZ	Optional
TerminateOn	Date	Derived from the Subscription. Date of Subscription termination. YYYY-MM-DDZ	Optional
ConnectionReason	String4	Reason Code supplied at time of subscriber creation.	Optional
AddressNumber	Integer8	The CMP address number for the subscriber.	Optional
EmailAddress	String70	The subscriber's email address.	Optional

AttributeValue Response Container

The AttributeValue response container has the following elements:

Element Name	Content Type	Description	Required?
AttributeGroupCode	String6	Identifier for the Attribute Group being searched for.	Optional
AttributeId	Decimal2	Unique reference for the Attribute within the Attribute Group that is being searched by.	Optional
AttributeValue	String120	The search text.	Optional
AttributeStatus	String	If supplied will search for the status specified. If not supplied then all statuses will be searched. Possible values: ALL CURRENT.	Optional