Difference between revisions of "MOR API CLI delete"

From Kolmisoft Wiki
Jump to navigationJump to search
Line 1: Line 1:
=Description=
=Description=
<!---This functionality is available from in MOR X3 and from MOR X5--->
<!---This functionality is available from in MOR X3 and from MOR X5--->
[[MOR API]] CLI get info
[[MOR API]] CLI delete


Please note that admin/reseller can delete CLI just of their own Users Devices.
Please note that admin/reseller can delete CLI just of their own Users Devices.

Revision as of 15:52, 3 June 2014

Description

MOR API CLI delete

Please note that admin/reseller can delete CLI just of their own Users Devices.

Usage

  • Call: /api/cli_delete



Parametres

  • u – username to login. Required.
  • cli_number – this specifies CLI number which will be deleted. Required.
  • hash – SHA1 hash constructed using cli_number and API_Secret_Key ( More described in Constructing hash). Required.


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

Request

We have API Secret Key = 456789, cli_number = 12345
We send:

HTML POST: http://<server_ip>/billing/api/cli_delete?u=admin&cli_number=12345&hash=71516eea4850f7e0300ac86adf9fb64bca845aa7

* Note that username and password are not included in hash

Returns

Success

<page>
    <status>
      <status>CLI successfully deleted</status>
     </status>
</page>




Errors

  • <error>CLI was not found</error> – CLI was not found.
  • <error>Access Denied</error> – User was not found by username and password. Use correct username and password. Make sure that username (u) and password (p) are specified.
  • <error>You are not authorised to use this functionality</error> - accountant needs to have Manage Device permissions.
  • <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.



See also