Getting third-party product entitlements | NAGRAVISION Documentation Portal

Overview

If the CRM system need to find out which third-party product entitlements an account has (for example, so that it can display them to a customer service representative who handles customer calls), it calls the regular CRM Gateway GET entitlements endpoint and filters the response by entitlement type.

Request

To get third-party product entitlements, the CRM system should make the following GET request:

Bash

https://<host>:<port>/crm-gateway/v1/rmg/v1/entitlements?filter={"productType": "THIRDPARTY"}

Headers

x-correlation-id – identifier for logging, to correlate messages across a call flow
Authorization – Keycloak access token (see Accessing operator APIs using Keycloak)
Content-Type: application/json

Mandatory arguments

For this use case, you must add a filter query to filter the results to only include entitlements with a productType of THIRDPARTY.

Other arguments

The following arguments are all part of the query:

limit – the number of records to return
page – the page number to return (cannot be used without limit)
For example:
- ?limit=10 returns the first 10 recordings.
- ?limit=10&page=2 returns the second 10 recordings.
sort – the sort order of the returned entitlement. It takes the following format (MongoDB sort syntax): {<field_name>, <order>}, where order is either 1 (ascending) or -1 (descending).
fields – the fields to include in the response

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

A forbidden request (invalid token) returns an HTTP 403 status.

If the specified tenant or entitlement does not exist, the request returns an HTTP 404 status.

See the (25.12_Q1) CRM Gateway API documentation for the specific error codes and their meanings.