Home
MATRIXX Subscriber Management API
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 URL and Method Format
MATRIXX uses the standard REST URL and method formats.
REST Operation Search Terms
In many of the REST API methods, you must specify a search term that identifies an instance of a specific object — either as a parameter in the URL or in the message body.

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.
- 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 Overview
    RS Gateway uses web standards, such as HTTP, OpenAPI, XML, and JSON, to exchange information. This makes it easy to integrate MATRIXX Engine with a SOA-based enterprise architecture.
  - RS Gateway Basic Authentication
    When RS Gateway is configured not to accept anonymous requests, clients must send a login request with a username and password.
  - REST Error Handling
    Each response to a request to RS Gateway produces an HTTP result code. This result code indicates the success or failure of the request being received for processing. Additionally, each successfully processed request generates a response and all responses contain a Result (numeric code) field and ResultText (string) field that describe whether the engine was able to perform the request.
  - REST URL and Method Format
    MATRIXX uses the standard REST URL and method formats.
    - REST Syntax
      When using the REST APIS, you should follow the MATRIXX REST syntax rules.
    - REST Operation Search Terms
      In many of the REST API methods, you must specify a search term that identifies an instance of a specific object — either as a parameter in the URL or in the message body.
  - REST Operations and HTTP Mappings
    All operations across all resources (primary and secondary) are on single instances of a resource, for example, a single device. To perform multiple operations in one transaction, use the MtxRequestMulti function.
  - REST Helper URLs
    The REST interface provides several REST meta-services that can be used to query the RS Gateway and find out information about other services and documents.
  - REST Filters
    XML and JSON REST calls include default filters which you can disable. You can include filters which customize the information returned in the response.
  - RS Gateway Support for Multi-Tenancy
    MATRIXX Engine authorizes REST API operations for allowed tenant IDs. each RS Gateway client performs REST API operations on subscriber data belonging to the authorized tenant ID only.
  - RS Gateway-Initiated Rating
    RS Gateway-initiated rating allows clients that do not support the Diameter protocol to use the MATRIXX charging, rating, and pricing functionality.
  - Connecting RS Gateway to the Event Repository
    The Event Repository REST APIs return events and notifications in the Event Repository and in the Activity database (in-progress aggregated events) and Event database for subscribers and groups. The RS Gateway must be configured to connect to the Event Repository.
- 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

REST Operation Search Terms

In many of the REST API methods, you must specify a search term that identifies an instance of a specific object — either as a parameter in the URL or in the message body.

The search term must follow the object type. For calls that include a {SearchTerm}, the default search term is the ObjectId. To specify a different search term, such as an access number, include the term and its value separated by a + sign. For example, to modify a user's role on a subscription using the user's AccessNumber as the search term for the user and the UserId on the subscription, issue the call using the following format. This example does not include the message body.

PUT http://host:port/rsgateway/data/json/user/AccessNumber+5555555555/subscription/UserId+1234

Object Search Terms describes the supported search terms for each object.

Table 1. Object Search Terms
Object	Supported Search Terms
device	ObjectId ExternalId Imsi AccessNumber LoginId AccessId MultiRequestIndex An `AccessNumber` corresponds to a MSISDN. MobileDevice is an IMSI (a phone number datatype); whereas LoginDevice is a STRING. For 5G, MATRIXX supports device identification by SUPI. If the SUPI is of the form imsi-NNNN there is a MobileDevice lookup using Imsi NNNN. If it is in the form nai-XXXX then there is a LoginDevice lookup using LoginID XXXX.
group	ObjectId ExternalId MultiRequestIndex
subscriber	ObjectId ExternalId Imsi AccessNumber LoginId AccessId MultiRequestIndex
subscription	ObjectId ExternalId Imsi AccessNumber LoginId AccessId MultiRequestIndex
user	ObjectId UserId ExternalId MultiRequestIndex AccessNumber Imsi LoginId AccessId Subscription ObjectId — If present, find the user based on the subscription for which it is the primary user. Subscription ExternalId — If present, find the user based on the subscription for which it is the primary user. Group ObjectId — Find the user based on the group for which it is the owner user. Group ExternalId — Find the user based on the group for which it is the owner user.

Note that the service APIs for users described in MATRIXX Business API SDK may include additional search term parameters. For example, SubscriptionTerm for subscriptions as in the following URL:

DELETE /service/user/{SearchTerm:.+}/subscription/{SubscriptionTerm:.+}