Cloud Services

ModernOps configuration

APIs for RateCard/Integrations_V2
Published On Oct 28, 2024 - 4:09 PM

APIs for RateCard/Integrations_V2

Learn what the RateCard/Integrations_V2 APIs are and what they are used for.
The following are the RateCard/Integrations_V2 APIs, including parameters, and what they are used for.
API:
GET/shared/ratecard/clients/{client_id}/data
Used for:
Extracting data from registered clients for ratecard creation
Parameters
Name
Description
rc_id
string
(
query
)
RateCard ID
client_id
*
required
String
(path)
client_id: enter the client id
Response content type: application/json
Parameters
Code
Description
200
Success
Example Value |
Model
{
  "data_list": [
    {
      "data_type": "number",
      "description": "Default Plan",
      "id": "string",
      "max_size": 0,
      "min_size": 0,
      "name": "Default",
      "range": [
        {
          "max": 0,
          "min": 0,
          "step": 0
        }
      ],
      "regex": "string",
      "uom": [
        {
          "code": "string",
          "value": 0
        }
      ],
      "value": "string",
      "values": [
        {
          "label": "string",
          "value_id": "string"
        }
      ]
    }
  ],
  "reasons": [
    {
      "reasons": [
        {
          "id": "oidhwd",
          "messages": [
            "Successfully retrieved the ratecards"
          ],
          "status": "OK",
          "statusCode": 100,
          "translateCode": "RC_2002_GET_ALL_RATECARD",
          "translateParameters": [
            "string"
          ]
        }
      ]
    }
  ]
}
400
Bad Request
Example Value |
Model
{
  "message": "sample message",
  "translateCode": "SAMPLE TRANSLATE CODE",
  "translateParameters": [
    "param1",
    "param2"
  ]
}
404
RateCard not found
Example Value |
Model
{
  "message": "sample message",
  "translateCode": "SAMPLE TRANSLATE CODE",
  "translateParameters": [
    "param1",
    "param2"
  ]
}
Do you have two minutes for a quick survey?
Take Survey