Home
MATRIXX Subscriber Management API
Subscriber Management
The following information is an overview of the SubMan APIs and architecture.
Data Objects
An external application or system can use the SubMan APIs to perform operations on primary, secondary, and embedded objects. Primary objects can be called directly by the API and include subscribers, groups, devices, and users. Wallets are secondary objects because they belong to a primary object. Operations on wallets must reference a primary object. Embedded objects include product offers, balances, thresholds, and billing cycles.
Primary Objects
Primary objects have a system assigned object identifier (OID) that uniquely identifies the object and is the primary way to specify the object instance.

Welcome
MATRIXX Release Notes
MATRIXX Architecture
MATRIXX Installation and Upgrade
MATRIXX Configuration
MATRIXX Security
MATRIXX Integration
MATRIXX Diameter Integration
MATRIXX Call Control Framework Integration
MATRIXX TM Forum Integration
MATRIXX 5G Integration
MATRIXX 5G Event Streaming
MATRIXX Event Streaming
MATRIXX Administration
MATRIXX Web App Administration
MATRIXX Monitoring and Logging
MATRIXX Policy
MATRIXX Kafka CDR Consumer
MATRIXX Pricing and Rating
MATRIXX Pay Now
MATRIXX Subscriber Management
MATRIXX Subscriber Management API
- About Subscriber Management API
  MATRIXX Subscriber Management API provides information about the MATRIXX Engine APIs, including functions, syntax, and result codes, and the MATRIXX Engine REST and Java API implementations.
- Subscriber Management
  The following information is an overview of the SubMan APIs and architecture.
  - SubMan Overview
    The Subscriber Management (SubMan) API defines a set of programming interfaces to the MATRIXX in-memory databases.
  - Architecture and Deployment
    The SubMan API is the externally visible element of the Subscriber Management interface. The interface uses a standard client-server model, where a MATRIXX gateway is the server and any external application that needs to access and manipulate data related to subscribers and groups is the client. The SubMan AP has two language bindings: Java and REST.
  - Message Workflow
    The diagrams in this section show the API message workflow for primary and secondary resources.
  - Data Objects
    An external application or system can use the SubMan APIs to perform operations on primary, secondary, and embedded objects. Primary objects can be called directly by the API and include subscribers, groups, devices, and users. Wallets are secondary objects because they belong to a primary object. Operations on wallets must reference a primary object. Embedded objects include product offers, balances, thresholds, and billing cycles.
    - Primary Objects
      Primary objects have a system assigned object identifier (OID) that uniquely identifies the object and is the primary way to specify the object instance.
    - Secondary Objects
      Secondary objects belong to primary objects.
    - Extending Data Objects
      All primary objects (subscriber, group, device, and user) and product offers, bundles, purchased offers, and purchased bundles can be extended with a private object type using the Attr parameter in REST calls.
  - Subscriber Data
    MATRIXX Engine maintains transactional subscriber data that enables you to address in real time subscriber needs and service usage. The MATRIXX subscriber model is flexible and supports any type of subscriber base, such as retail, wholesale, and Mobile Virtual Network Operator (MVNO).
  - Functions
    The SubMan API functions provide a standardized way to define, send, and receive MATRIXX data. They support generic arguments so applications can use the same programming primitives to communicate with MATRIXX Engine.
  - Syntax
    The generic syntax of each API request and response operation includes a description, the base MDC container used by the operation, and the data elements used by the operation.
  - SubMan API Result Codes
    Each response includes a basic result code indicating success or failure and textual information about any failure. A result code of 0 (zero) is a success and a result code of nonzero is a failure.
  - Domain Routing
    The SubMan API calls include domain routing information.
  - Execute Mode
    The SubMan API execute mode determines if data changes are saved to the internal database when a SubMan API call is made and if credit limits are ignored.
  - MDC Serialization
    The data container package for MATRIXX Java components provides three different formats for serialization: XML, JSON, and OpenAPI JSON. These serialization formats depend on MATRIXX MDC definition files. MDC serialization describes data containers, structs, simple types, arrays and lists, and special fields.
- Object Management
  The following sections introduce how the various in-memory objects are managed.
- SubMan API Reference
  The SubMan API reference includes SubMan API and MDC descriptions.
- REST API Management
  RS Gateway supports the REST API bindings for accessing subscriber data in MATRIXX Engine. RS Gateway consists of an rsgateway application and a set of REST APIs.
- REST API Reference
  This part describes how to use the REST API bindings to interface with MATRIXX Engine.
- Java API
  This part provides an overview of how to use the Java™ API binding for the SubMan v3 API as an interface to the MATRIXX Engine.
MATRIXX Business API SDK
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
MATRIXX Third-Party Licenses
Glossary

Primary Objects

Primary objects have a system assigned object identifier (OID) that uniquely identifies the object and is the primary way to specify the object instance.

Primary objects can also have an optional ExternalId value provided by the caller. When primary objects are referenced in a request, the request uses a SearchData structure, for example, SubscriberSearchData, that encapsulates the supported methods for identifying the object.

The primary object for SubMan multi-requests is always the specified object, either implicitly by the object in the request (such as the subscriber in MtxRequestSubscriberAddDevice), or explicitly by the ObjectSearchData field (such as the group in GroupSearchData). A maximum of one object is identified in this way for each SubMan API operation.

Note: Some operations do not have a primary object (such as MtxRequestPricingQueryStatus). For these operations, a special NULL object identifier is defined by the operation. The NULL identifier is also generated during operations such as MtxRequestSubscriberDelete. Attempting to use a NULL identifier in a multi-request generates a runtime error.