Skip to main content

getRatingGroupHierarchy GQL Query Usage

Benji Bizzell
  • Updated

Overview

The getRatingGroupHierarchy GQL Query can be leveraged to gather details about the current Rating Group Hierarchy defined within a Provider tenant.

 

Usage

getRatingGroupHierarchy takes in a providerID as its argument and returns the Rating Group Hierarchy for the tenant. These Rating Groups represent the defined chargeable units, such as Data, Voice, or SMS. 

  • Requires Tenant Admin Role
  • Arguments
    • providerId - ID! - Service provider ID
  • Returns a RatingGroupResult

 

Example Query

query GetRatingGroupHierarchy {
  getRatingGroupHierarchy(providerId: "<providerId>") {
    ... on RatingGroup {
      id
      name
      isDefault
      perUnitRounding
      unitType
      quotaValidityTime
      minReservation
      maxReservation
      enableDynamicQuotaAllocation
      children {
        id
        isDefault
        name
        perUnitRounding
        unitType
        quotaValidityTime
        minReservation
        maxReservation
        enableDynamicQuotaAllocation
        children {
          id
          isDefault
          name
          perUnitRounding
          unitType
          quotaValidityTime
          minReservation
          maxReservation
          enableDynamicQuotaAllocation
        }
      }
    }
  }
}

 

Example Response

{
  "data": {
  "getRatingGroupHierarchy": {
  "id": 0,
  "name": "Root",
  "isDefault": true,
  "perUnitRounding": null,
  "unitType": "SERVICE_SPECIFIC_UNITS",
  "quotaValidityTime": null,
  "minReservation": null,
  "maxReservation": null,
  "enableDynamicQuotaAllocation": false,
  "children": [
    {
      "id": 100,
      "isDefault": true,
      "name": "Voice",
      "perUnitRounding": 60,
      "unitType": "TIME",
      "quotaValidityTime": null,
      "minReservation": null,
      "maxReservation": null,
      "enableDynamicQuotaAllocation": false,
      "children": []
    },
    {
      "id": 200,
      "isDefault": true,
      "name": "Text",
      "perUnitRounding": 1,
      "unitType": "SERVICE_SPECIFIC_UNITS",
      "quotaValidityTime": null,
      "minReservation": null,
      "maxReservation": null,
      "enableDynamicQuotaAllocation": false,
      "children": []
    },
    {
      "id": 300,
      "isDefault": true,
      "name": "Data",
      "perUnitRounding": 1024,
      "unitType": "VOLUME",
      "quotaValidityTime": null,
      "minReservation": null,
      "maxReservation": null,
      "enableDynamicQuotaAllocation": false,
      "children": [
        {
          "id": 301,
          "isDefault": true,
          "name": "WhatsApp",
          "perUnitRounding": null,
          "unitType": "VOLUME",
          "quotaValidityTime": null,
          "minReservation": null,
          "maxReservation": null,
          "enableDynamicQuotaAllocation": false
        }
      ]
    },
    {
      "id": 400,
      "isDefault": true,
      "name": "Monetary",
      "perUnitRounding": 1,
      "unitType": "SERVICE_SPECIFIC_UNITS",
      "quotaValidityTime": null,
      "minReservation": null,
      "maxReservation": null,
      "enableDynamicQuotaAllocation": false,
      "children": []
    }
   ]
  }
 }
}