M2 API tariff rates get

From Kolmisoft Wiki

Jump to: navigation, search

Contents

[edit] Description

MOR API Tariff rates - allows to get rates by specific tariff.

[edit] Usage

M2 call: /api/tariff_rates_get

  • For Backwards-compatibility old name 'get_tariff' is also usable. Call: /api/get_tariff
  • Methods: POST, GET(if allowed, not recomended)



[edit] Parametres

Parameters which are included into hash (if it is used):

  • tariff_id - tariff_id parameter returns tariff and rates by specific tariff_id.
  • device_id - tariff parameter returns tariff and rates by device id. If device has both Orginator point and Terminator point tariffs, Originator point tariff is returned. When sending device_id parameter tariff_id parameter is ignored.

* Note that tariff_id or device_id is required and must be provided in to the request.


Parameters which are not included into hash:



[edit] Request

We have API Secret Key = 456789, tariff_id = 2

We send:

HTML POST: http://<SERVER_IP>/billing/api/get_tariff?u=admin&tariff_id=2&hash=d674ef6e3ceb3145e825709ac2233c710db15af8

Returning XML is put in file. That file is gziped and returned as a response content.

Please note that admin can retrieve any tariff, user can only retrieve his own tariff.

[edit] Returns

Success

<?xml version="1.0" encoding="UTF-8"?>
<page>
 <pagename> Tariff </pagename>
 <tariff_name> tariff name </tariff_name>
 <purpose> tariff type </purpose>
 <currency> currency </currency>
 <rates>
  <rate>
    <direction>  </direction>
    <destination>  </destination>
    <prefix>  </prefix>     
    <tariff_rate>  </tariff_rate>
    <con_fee>  </con_fee>
    <increment>  </increment>
    <min_time>  </min_time>
    <start_time>  </start_time>
    <end_time>  </end_time>
    <daytype>  <daytype/>
  </rate>
 </rates>
</page>

Errors

  • Tariff was not found.
<?xml version="1.0" encoding="UTF-8"?>
<page>
  <status>
     <error>No tariff found</error>
  </status>
</page>
  • User was not found by username. Use correct username. Make sure that username (u).
<?xml version="1.0" encoding="UTF-8"?>
<page>
   <status>
      <error>Bad login</error>
   </status>
</page>
  • Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
<?xml version="1.0" encoding="UTF-8"?>
<status>
    <error>Incorrect hash</error>
</status>
  • Parameters device_id or tariff_id must be provided.
<?xml version="1.0" encoding="UTF-8"?>
<status>
    <error>device_id or tariff_id was not found</error>
</status>
  • User can access only his own tariffs.
<?xml version="1.0" encoding="UTF-8"?>
<status>
    <error>Access Denied</error>
</status>
  • Manager does not have permisions to access tariffs functionality.
<?xml version="1.0" encoding="UTF-8"?>
<status>
    <error>You are not authorized to manage tariffs</error>
</status>



Personal tools

Try MOR

Try M2