Difference between revisions of "MOR API did make free"

From Kolmisoft Wiki
Jump to navigationJump to search
(Created page with '=Description= <!---This functionality is available from MOR X10---> MOR API DID make free Please note that only admin, accountant(with device management) with permission and…')
 
 
Line 53: Line 53:
* <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.
* <error>DID was not freed. Only Terminated, Reserved or Closed DIDs can be freed</error> – DID was not freed. Only Terminated, Reserved or Closed DIDs can be freed
<br><br>
<br><br>


Latest revision as of 07:20, 18 April 2023

Description

MOR API DID make free

Please note that only admin, accountant(with device management) with permission and reseller can use this API.



Usage

  • Call: /api/did_make_free
  • Methods: POST, GET(if allowed, not recomended)



Parametres

Parameter which is included into hash:

  • dids_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:



Request

We have API Secret Key = secret, dids_id = 6511
We send: 

HTML POST: http://<server_ip>/billing/api/did_make_free?u=admin&dids_id=6511&hash=f7de355c9b4421ce6c705b4b32c89dbcaca51e46

* Note that username is not included in hash

Returns

Success 

<page>
 <status>
   <success>DID successfully made available</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.
  • <error>DID was not freed. Only Terminated, Reserved or Closed DIDs can be freed</error> – DID was not freed. Only Terminated, Reserved or Closed DIDs can be freed



See also

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