Difference between revisions of "MOR API did subscription stop"
From Kolmisoft Wiki
Jump to navigationJump to search
(Created page with '=Description= <!---This functionality is available from MOR X6---> MOR API DID subscription stop Please note that only admin, accountant(with device management) with permiss…') |
|||
Line 49: | Line 49: | ||
'''Errors''' | '''Errors''' | ||
* <error>DID was not found</error> – Specified | * <error>DID is not assigned to Device</error> – Specified DID is not assigned to any Device. Action cannot be made. | ||
* <error>DID was not found</error> – Specified DID does not exist or it belongs to different username(u). | |||
* <error>Access Denied</error> – Specified username (u) does not exist or u is not admin, reseller or accountant with permission. | * <error>Access Denied</error> – Specified username (u) does not exist or u is not admin, reseller or accountant with permission. | ||
* <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string. | * <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string. |
Latest revision as of 14:56, 3 July 2015
Description
MOR API DID subscription stop
Please note that only admin, accountant(with device management) with permission and reseller can use this API.
Usage
- Call: /api/did_subscription_stop
- Methods: POST, GET(if allowed, not recomended)
Parametres
Parameter which is included into hash:
- did_id – this is id of DID which have to be updated. Required.
Note that parameters are shown in the same order as they have to be when generating the hash. Last parameter in a row is API_Secret_Key
Parameters which are not included into hash:
- hash - SHA1 hash constructed using did_id and API_Secret_Key ( More described in Constructing hash). Required.
- u – username to login. Required.
Request
We have API Secret Key = secret, did_id = 6511
We send:
HTML POST: http://<server_ip>/billing/api/did_subscription_stop?u=admin&did_id=6511&hash=f7de355c9b4421ce6c705b4b32c89dbcaca51e46
* Note that username is not included in hash
Returns
Success
<page> <status> <success>DID was successfully closed</success> </status> </page>
Errors
- <error>DID is not assigned to Device</error> – Specified DID is not assigned to any Device. Action cannot be made.
- <error>DID was not found</error> – Specified DID does not exist or it belongs to different username(u).
- <error>Access Denied</error> – Specified username (u) does not exist or u is not admin, reseller or accountant with permission.
- <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.