Difference between revisions of "MOR API device delete"

From Kolmisoft Wiki
Jump to navigationJump to search
Line 1: Line 1:
=Description=
[[MOR API]] Delete device
<br><br>
<br><br>
[[MOR API]] Delete device
=Usage=
 
* Call: /api/device_delete
* For Backwards-compatibility old name 'device_destroy' is also usable. Call: /api/device_destroy
* Methods: POST, GET(if allowed, not recomended)
<br><br>
<br><br>
----
===Parametres===
 
* device - Device ID in MOR database, whose datas we want to delete. '''Required'''.
* u - username for authentication. '''Required'''.
* [[MOR API hash construction | hash]] - SHA1 hash constructed using '''device''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
<br><br>
<br><br>
===Request===
We have device = 123, API Secret Key = 456789
We send:
HTML POST: http://<SERVER_IP>/billing/api/device_delete?u=admin&p=admin&device=123&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441


* Call: /api/device_destroy
'''NOTE that username and password are not included in hash'''
* Methods: POST, GET(if allowed, not recomended)
<br><br>
* Params:
===Returns===
** device - Device ID in MOR database, whose datas we want to delete. '''Required'''.
** u - username to login. '''Required'''.
** p - password to login. '''Required'''.
** [[MOR API hash construction | hash]] - SHA1 hash constructed using '''device''' and '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.
**


* Returns:
'''Success'''
**Success
*** <status>Device was deleted</status>


<?xml version="1.0" encoding="UTF-8"?>
<page>
  <status>Device was deleted</status>
</page>


** Errors:
*** <error>Device was not found</error> - Device was not found using device. Use correct device id.
*** <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
*** <error>Registration over API is disabled</error> - Setting: Settings->API->API allow Registration, is off. Turn on API allow Registration.
*** <error>Dont be so smart</error> - User with UNIQUEHASH not found or params id not send. Enter correct id.
<br><br>
<br><br>
----
----
*Example:
 
**We have device = 123, API Secret Key = 456789
'''Errors'''
**Hash string to be converted: "123456789"
 
**We send:
* <error>Device was not found</error> - Device was not found using device. Use correct device id.
***/api/device_destroy?u=admin&p=admin&device=123&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441
* <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
'''* Note that username and password are not included in hash'''
* <error>Registration over API is disabled</error> - Setting: Settings->API->API allow Registration, is off. Turn on API allow Registration.
* <error>Access Denied</error> - User with UNIQUEHASH not found or params id not send. Enter correct id.
<br><br>
=See also=
 
* [[MOR API]]

Revision as of 13:40, 27 May 2013

Description

MOR API Delete device

Usage

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



Parametres

  • device - Device ID in MOR database, whose datas we want to delete. Required.
  • u - username for authentication. Required.
  • hash - SHA1 hash constructed using device and API_Secret_Key ( More described in Constructing hash). Required.



Request

We have device = 123, API Secret Key = 456789

We send: 

HTML POST: http://<SERVER_IP>/billing/api/device_delete?u=admin&p=admin&device=123&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441

NOTE that username and password are not included in hash

Returns

Success 

<?xml version="1.0" encoding="UTF-8"?>
<page>
 <status>Device was deleted</status>
</page>



Errors

  • <error>Device was not found</error> - Device was not found using device. Use correct device id.
  • <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
  • <error>Registration over API is disabled</error> - Setting: Settings->API->API allow Registration, is off. Turn on API allow Registration.
  • <error>Access Denied</error> - User with UNIQUEHASH not found or params id not send. Enter correct id.



See also

Retrieved from "https://wiki.kolmisoft.com/index.php?title=MOR_API_device_delete&oldid=15767"