cgrates/docs/api_tprates.rst

Apier.SetTPRate
+++++++++++++++

Creates a new rate within a tariff plan.

**Request**:

 Data:
  ::

   type TPRate struct {
	TPid      string     // Tariff plan id
	RateId    string     // Rate id
	RateSlots []RateSlot // One or more RateSlots
   }

   type RateSlot struct {
	ConnectFee     float64 // ConnectFee applied once the call is answered
	Rate           float64 // Rate applied
	RatedUnits     int     //  Number of billing units this rate applies to
	RateIncrements int     // This rate will apply in increments of duration
	Weight         float64 // Rate's priority when dealing with grouped rates
   }

 Mandatory parameters: ``[]string{"TPid", "RateId", "ConnectFee", "RateSlots"}``

 *JSON sample*:
  ::

   {
    "id": 0, 
    "method": "Apier.SetTPRate", 
    "params": [
        {
            "RateId": "SAMPLE_RATE_4", 
            "RateSlots": [
                {
                    "ConnectFee": 0, 
                    "Rate": 1.2, 
                    "RateIncrements": 1, 
                    "RatedUnits": 60, 
                    "Weight": 10
                }, 
                {
                    "ConnectFee": 0, 
                    "Rate": 2.2, 
                    "RateIncrements": 1, 
                    "RatedUnits": 60, 
                    "Weight": 20
                }
            ], 
            "TPid": "SAMPLE_TP"
        }
    ]
   }

**Reply**:

 Data:
  ::

   string

 Possible answers:
  ``OK`` - Success.

 *JSON sample*:
  ::

   {
    "error": null, 
    "id": 0, 
    "result": "OK"
   }

**Errors**:

 ``MANDATORY_IE_MISSING`` - Mandatory parameter missing from request.

 ``SERVER_ERROR`` - Server error occurred.

 ``DUPLICATE`` - The specified combination of TPid/RateId already exists in StorDb.


Apier.GetTPRate
+++++++++++++++

Queries specific rate on tariff plan.

**Request**:

 Data:
  ::

   type AttrGetTPRate struct {
	TPid   string // Tariff plan id
	RateId string // Rate id
   }

 Mandatory parameters: ``[]string{"TPid", "RateId"}``

 *JSON sample*:
  ::

   {
    "id": 1, 
    "method": "Apier.GetTPRate", 
    "params": [
        {
            "RateId": "SAMPLE_RATE_4", 
            "TPid": "SAMPLE_TP"
        }
    ]
   }
   
**Reply**:

 Data:
  ::

   type TPRate struct {
	TPid      string     // Tariff plan id
	RateId    string     // Rate id
	RateSlots []RateSlot // One or more RateSlots
   }

   type RateSlot struct {
	ConnectFee     float64 // ConnectFee applied once the call is answered
	Rate           float64 // Rate applied
	RatedUnits     int     //  Number of billing units this rate applies to
	RateIncrements int     // This rate will apply in increments of duration
	Weight         float64 // Rate's priority when dealing with grouped rates
   }

 *JSON sample*:
  ::

   {
    "error": null, 
    "id": 1, 
    "result": {
        "RateId": "SAMPLE_RATE_4", 
        "RateSlots": [
            {
                "ConnectFee": 0, 
                "Rate": 1.2, 
                "RateIncrements": 1, 
                "RatedUnits": 60, 
                "Weight": 10
            }, 
            {
                "ConnectFee": 0, 
                "Rate": 2.2, 
                "RateIncrements": 1, 
                "RatedUnits": 60, 
                "Weight": 20
            }
        ], 
        "TPid": "SAMPLE_TP"
    }
   }

**Errors**:

 ``MANDATORY_IE_MISSING`` - Mandatory parameter missing from request.

 ``SERVER_ERROR`` - Server error occurred.

 ``NOT_FOUND`` - Requested rate id not found.


Apier.GetTPRateIds
++++++++++++++++++

Queries rate identities on tariff plan.

**Request**:

 Data:
  ::

   type AttrGetTPRateIds struct {
	TPid string // Tariff plan id
   }

 Mandatory parameters: ``[]string{"TPid"}``

 *JSON sample*:
  ::

   {
    "id": 1, 
    "method": "Apier.GetTPRateIds", 
    "params": [
        {
            "TPid": "SAMPLE_TP"
        }
    ]
   }

**Reply**:

 Data:
  ::

   []string

 *JSON sample*:
  ::

   {
    "error": null, 
    "id": 1, 
    "result": [
        "SAMPLE_RATE_1", 
        "SAMPLE_RATE_2", 
        "SAMPLE_RATE_3", 
        "SAMPLE_RATE_4"
    ]
   }

**Errors**:

 ``MANDATORY_IE_MISSING`` - Mandatory parameter missing from request.

 ``SERVER_ERROR`` - Server error occurred.

 ``NOT_FOUND`` - Requested tariff plan not found.