MOR API tariff wholesale update

From Kolmisoft Wiki

Jump to: navigation, search

Contents

[edit] Description

MOR API Update or create new wholesale tariff

[edit] Usage

  • From MOR X4 call: /api/tariff_wholesale_update
  • For Backwards-compatibility old name 'wholesale_tariff' is also usable. Call: /api/wholesale_tariff
  • Methods: POST



[edit] Parametres

  • u - username for authentication. Required.
  • id - wholesale tariff id in MOR database. Optional.
  • name - tariff's name. Optional.
  • currency - tariff's currency code. Optional.
  • hash - SHA1 hash constructed using params and API_Secret_Key ( More described in Constructing hash). Required (if setting Disable hash checking is not checked).



[edit] Request

  • If tariff's id is not supplied, new tariff will be created with supplied name and currency code

We have tariff id=8, currency=EUR and API Secret Key = 123456

We send:

HTML POST: http://<SERVER_IP>/billing/api/tariff_wholesale_update?u=username&id=8&currency=EUR&name=test&test=1&hash=af15a89d83b6110c6424f178e1707d4f61b6f9b7
  • If tariff's id is supplied, existing tariff will be updated with supplied name and currency code

We have currency=EUR and API Secret Key = 123456

We send:

HTML POST: http://<SERVER_IP>/billing/api/tariff_wholesale_update?u=username&currency=EUR&name=test&test=1&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441

NOTE that username are not included in hash

[edit] Returns

Success

  • If tariff's id is not supplied, new tariff will be created with supplied name and currency code
<?xml version="1.0" encoding="UTF-8"?>
<page>
 <status>ok</status>
 <tariff_id> ID </tariff_id>
</page>
  • If tariff's id is supplied, existing tariff will be updated with supplied name and currency code
<?xml version="1.0" encoding="UTF-8"?>
<page>
   <status>ok</status>
</page>




Errors

  • Error if could not update or create tariff:
<response>
 <error>
   <message>error message</message>
 </error>
</response>
  • Error if tariff was not found
<?xml version="1.0" encoding="UTF-8"?>
<page>
   <error>Tariff not found</error>
</page>
  • In case incorrect hash would be supplied:
<?xml version="1.0" encoding="UTF-8"?>
<status>
    <error>Incorrect hash</error>
</status>               
  • In case incorrect login would be supplied:
<?xml version="1.0" encoding="UTF-8"?>
<page>
   <error>Bad login</error>
</page>>



[edit] See also

Personal tools

Try MOR

Try M2