Home
MATRIXX Business API SDK
Appendixes
Deprecated Service APIs
The Service APIs listed here are deprecated.
PUT /service/subscriber/{SearchTerm:.+}/password
This service modifies a subscriber's password. You must pass in the old password value to check whether it is a match with existing password in the database, before setting the new password. The method will handle the compare and persistence using the defined password encoder.

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
MATRIXX Business API SDK
- About MATRIXX Business API SDK
  MATRIXX Business API SDK provides the APIs, libraries, and other files needed to create a customized version of the RS Gateway.
- Business API SDK Overview
  The Business API SDK is a flexible framework that includes a set of tools to manage, customize and extend Rest Services Gateway (RS Gateway) for customer-specific business needs. Using the SDK, you can extend existing projects or create entirely new projects to add, replace, or modify services that leverage existing functionality.
- Business API Gateway
  The Business API Gateway is a development framework that includes the Business API SDK, Rest Services Gateway (RS Gateway), Gateway Proxy, and application tier. It allows custom mobile applications, web clients, and other custom implementations to integrate with MATRIXX.
- Creating Extensions
  You create extensions using a Maven archetype and then add those extensions to the RS Gateway as JAR files.
- Creating Custom Filters
  You can create a custom filter by creating a named filter or a filter class. A named filter is useful for simple filters while a filter class should be used for complex filters (for example, when the returned results must be modified).
- Upgrading the Business API SDK
  When you upgrade the MATRIXX software, you must upgrade the Business API SDK as it is possible that files have changed or have been deprecated. Use the manage_integration_project.py script to remove the current release from your project directory structure and upgrade to the latest release. You should do this even if your files are not checked into Subversion.
- Appendixes
  - manage_integration_project.py
    The manage_integration_project.py script creates the initial directory tree, installs releases, and creates and upgrades projects.
  - Testing Purchase Schema Definition
    The following code shows the final purchase-schema.xml definition for the request and response MATRIXX Data Containers (MDCs), the MDC relationship definition, and the REST call.
  - Final Purchase Schema Definition
    The following code shows the complete purchase-schema.xml definition for the request and response MATRIXX Data Containers (MDCs), the MDC relationship definition, and the REST call. In this schema definition, the demo class is created to use a bean managed by the Spring object manager.
  - Final DemoServices Java Class File
    The following code shows the complete DemoServices.java file for the purchase extension sample.
  - Final Tax Schema Definition
    The following code shows the complete thinAirTax-schema.xml definition for the request and response MATRIXX Data Containers (MDCs), the MDC relationship definition, and the REST call. In this schema definition, the thinAirTax class is created to use a bean managed by the Spring object manager.
  - Deprecated Service APIs
    The Service APIs listed here are deprecated.
    - GET /service/group/{SearchTerm:.+}/administrators
      This service returns the administrators of a group. querySize=xx: An optional request parameter querySize (default is 10) can be specified that determines the number of records returned per call. queryCursor=yy: If the query results do not fit in a single response, a QueryCursor is included in the response. If the cursor is NULL or 0 you are at the end. You can retrieve the subsequent pages of a response by calling this URL again but specifying a queryCursor parameter on the url.
    - GET /service/subscriber/{SearchTerm:.+}
      This extended subscriber query service returns complete details about the subscriber including their wallet and detailed information about the subscriber.
    - GET /service/subscriber/{SearchTerm:.+}/administers
      This service implements the retrieval of the groups for which this subscriber is the administrator. querySize=xx: An optional request parameter querySize (default is 0=system default) can be specified that determines the number of records returned per call. queryCursor=yy: If the query results do not fit in a single response, a QueryCursor is included in the response. If the cursor is NULL or 0 you are at the end. You can retrieve the subsequent pages of a response by calling this URL again but specifying a queryCursor parameter on the url.
    - POST /service/subscriber
      This service creates a device and a subscriber and associates them both together.
    - PUT /service/subscriber/{SearchTerm:.+}/authentication
      This service modifies subscriber authentication data. RS Gateway encodes the password before saving it in the database. Because the main purpose of this method is to encode the password, the password is required.
    - PUT /service/subscriber/{SearchTerm:.+}/authentication/verify
      This method is used to check if auth data matches with the one saved in the engine. This service will take in Password as required and LoginId as optional. If both are provided both have to match. If only Password is provided only password has to match. Return value will be the AuthData object (including Roles) of that subscriber. This service will work off the encoded password so the passed in value will be encoded before we compare it with the stored value.
    - PUT /service/subscriber/{SearchTerm:.+}/password
      This service modifies a subscriber's password. You must pass in the old password value to check whether it is a match with existing password in the database, before setting the new password. The method will handle the compare and persistence using the defined password encoder.
My MATRIXX Help
MATRIXX Backoffice Customer Tool Help
MATRIXX Third-Party Licenses
Glossary

PUT /service/subscriber/{SearchTerm:.+}/password

This service modifies a subscriber's password. You must pass in the old password value to check whether it is a match with existing password in the database, before setting the new password. The method will handle the compare and persistence using the defined password encoder.

Class

service

Name

change_password_check

Method

PUT

URL (Deprecated)

/json/service/subscriber/{SearchTerm:.+}/password

/v3/service/subscriber/{SearchTerm:.+}/password

/openapi/service/subscriber/{SearchTerm:.+}/password

See also:

/service/user/{SearchTerm:.+}/password

URL Parameters


Parameter	Data Type	Description
SearchTerm	RestQueryTerm	Default is the object id of the subscriber. Qualifiers of ObjectId, ExternalId, PhoneNumber, Imsi, AccessNumber, LoginId and AccessId can be specified.

Request Parameters


Parameter	Data Type	Description	Usage
TrafficRouteData	String	Optional routing data used by the TRA to route this subman call to the correct engine.	optional

Input

SubscriberChangePasswordRequest

<SubscriberChangePasswordRequest>
    <OldPassword>{String}</OldPassword>
    <NewPassword>{String}</NewPassword>
    <ExecuteMode>{Integer}</ExecuteMode>
    <ApiEventData>
        <MtxApiEventDataExtension />
    </ApiEventData>
    <RelatedMsgId>{String}</RelatedMsgId>
    <ApiEventSecurityInfo>
        <MtxApiEventSecurityInfo>
            <ClientIpAddress>{String}</ClientIpAddress>
            <ClientUserName>{String}</ClientUserName>
            <ClientSessionId>{String}</ClientSessionId>
        </MtxApiEventSecurityInfo>
    </ApiEventSecurityInfo>
</SubscriberChangePasswordRequest>

Output

MtxResponse

<MtxResponse>
    <Result>{Long}</Result>
    <ResultText>{String}</ResultText>
    <RelatedMsgId>{String}</RelatedMsgId>
    <TenantId>{String}</TenantId>
</MtxResponse>