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 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.
Log in to RS Gateway Administrative UI
The RS Gateway administrative UI provides documentation for all MATRIXX web app classes and methods, XML messages, JSON templates, and filter definitions.

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.
    - JSON Strictness Check
      RS Gateway does a strictness check of JSON when converting JSON into an MDC.
    - Update the MDC Definitions for RS Gateway
      After extending an MDC definition with custom fields or upgrading the MATRIXX Engine schema, follow this procedure to update the MDC definitions for RS Gateway. This enables applications that communicate with the engine to operate on the new fields and revert to previous service provider versions, if necessary.
    - Log in to RS Gateway Administrative UI
      The RS Gateway administrative UI provides documentation for all MATRIXX web app classes and methods, XML messages, JSON templates, and filter definitions.
      - REST Call Swagger
        REST Call Swagger describes each of the API REST calls.
    - RS Gateway OpenAPI Swagger Documentation
      You can request the complete RS Gateway JSON Swagger OpenAPI (data structure version 3.0.0) documentation.
    - converter.jar
      The converter.jar utility converts REST call output files from compact MDC (CMDC) to compact XML files, compact XML to compact MATRIXX Data Container (MDC) files, or compact XML or MDC files to JSON files.
  - 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 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

Log in to RS Gateway Administrative UI

The RS Gateway administrative UI provides documentation for all MATRIXX web app classes and methods, XML messages, JSON templates, and filter definitions.

Procedure

Log in to the RS Gateway host server.
For example, to login with a username and password:
```
http://ipaddress:port/rsgateway/login.html
```
Or, if anonymous login is enabled:
```
http://ipaddress:port/rsgateway/index.html
```
Where:
- ipaddress is the IP address of the RS Gateway host server. To retrieve the IP address, enter the following command at the system prompt on the host server:
  /sbin/ifconfig
- By default, the port is 8080.
  Note: You can change the port by configuring the following system property:
```
-Dserver.port=port
```
  For example:
```
-Dserver.port=8888
```
Note: Return to this page at anytime and click logout to logout of the RS Gateway.
If anonymous login is disabled, enter a username and password and click Login.
If anonymous user is enabled, anonymousUser displays next to Login. After logging in, your username displays next to Login.
After logging in, click here to open the administrative UI.

You can view the RS Gateway documentation here.
In the administrative UI, click one of the following:
- Documentation — View documentation for all classes and methods.
- XML Messages — View all XML messages and their descriptions.
- JSON/XML Templates — View all JSON and XML templates and their contents.
- Filters — View all known filters.
- REST Call Swagger — View the OpenAPI version of the RS Gateway. Includes a list of all REST calls with their URL parameters and REST parameters.
- Web App Status — View system properties, application properties, and JVM arguments.
  Note: You must have the role RSG_DEBUG to access Web App Status.