Subscription-User Association

You can associate a subscription with a user in a many-many relationship using the user APIs.

During subscriber database configuration, you can define the following information that impact user objects:
  • How many users would you like to support?
  • What is the average size of a user object in bytes?
  • What is the initial size of a user object in bytes?
  • How many userSubscriptionJoin objects do you want to support?
  • What is the average size of a userSubscriptionJoin object in bytes?
  • What is the initial size of a userSubscriptionJoin object in bytes?
  • How many userGroupJoin objects do you want to support?
  • What is the average size of a userGroupJoin object in bytes?
  • What is the initial size of a userGroupJoin object in bytes?

For more information about subscriber database configuration, see Installation and Configuration.

In general, a subscription should be associated with a user. For information about the subscription APIs, see the discussions about subscription APIs. For information about the user APIs, see the discussions about the user APIs.

Use the MtxRequestUserAddSubscription API to associate a user with a subscription. You can use any of the fields described in Table 1 to identify the subscription.
Table 1. Subscription Search Terms
Name Data Type Flags Description
ObjectId object id Optional If present, find subscription by ObjectID.
ExternalId string Optional If present, find subscription by ExternalID.
Imsi phone number Optional If present, find subscription by associated device IMSI.
AccessNumber phone number Optional If present, find subscription by associated device access number.
LoginId string Optional If present, find subscription by LoginId.
AccessId string Optional If present, find subscription by associated login device AccessId.
MultiRequestIndex unsigned int16 Optional If present, find subscription by the index value in a MtxRequestMulti operation.
For more information about the MtxEvent EDR, see MATRIXX Engine Integration.