Difference between revisions of "MOR API provider rule delete"
From Kolmisoft Wiki
Jump to navigationJump to search
(Created page with "=Description= MOR API Delete Provider Rule. Can be used by Admin, reseller or accountant. <br><br> =Usage= * Call: /api/provider_rule_delete * Methods: POST, GET(if allowed, not recomended) <br><br> ===Parameters=== Parameters which are '''included''' into hash: * '''provider_rule_id''' - Provider rule id. '''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'''...") |
|||
| Line 2: | Line 2: | ||
[[MOR API]] Delete Provider Rule. | [[MOR API]] Delete Provider Rule. | ||
Can be used by Admin, reseller or accountant. | Can be used by Admin, reseller, or accountant. | ||
<br><br> | <br><br> | ||
=Usage= | =Usage= | ||
| Line 15: | Line 15: | ||
* '''provider_rule_id''' - Provider rule id. '''Required'''. | * '''provider_rule_id''' - Provider rule id. '''Required'''. | ||
'''Note that parameters are shown in the same order as they have to be when generating the hash. | '''Note that parameters are shown in the same order as they have to be when generating the hash. The last parameter in a row is API_Secret_Key''' | ||
<br><br> | <br><br> | ||
Parameters which are '''not included''' into hash: | Parameters which are '''not included''' into hash: | ||
* '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using '''parameters''' which are listed above. Note that parameters are shown in the same order as they have to be when generating the hash. | * '''[[MOR API hash construction | hash]]''' - SHA1 hash constructed using '''parameters''' which are listed above. Note that parameters are shown in the same order as they have to be when generating the hash. The last parameter in a row is '''API_Secret_Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.<br> | ||
* '''u''' - username for authentication. '''Required'''. | * '''u''' - username for authentication. '''Required'''. | ||
<br> | <br> | ||
| Line 41: | Line 41: | ||
* <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>Provider rule was not found</error> - Rule was not found or User does not have | * <error>Provider rule was not found</error> - Rule was not found or User does not have permission to manage this rule. | ||
<br><br> | <br><br> | ||
Latest revision as of 06:53, 17 January 2023
Description
MOR API Delete Provider Rule.
Can be used by Admin, reseller, or accountant.
Usage
- Call: /api/provider_rule_delete
- Methods: POST, GET(if allowed, not recomended)
Parameters
Parameters which are included into hash:
- provider_rule_id - Provider rule id. Required.
Note that parameters are shown in the same order as they have to be when generating the hash. The last parameter in a row is API_Secret_Key
Parameters which are not included into hash:
- hash - SHA1 hash constructed using parameters which are listed above. Note that parameters are shown in the same order as they have to be when generating the hash. The last parameter in a row is API_Secret_Key ( More described in Constructing hash). Required.
- u - username for authentication. Required.
Request
HTML POST: http://<SERVER_IP>/billing/api/provider_rule_delete?u=admin&provider_rule_id=1&hash=297dab8c386794b2e947d52affb8f576c643569e
Returns
Success
<page> <status> <success>Provider rule was successfully deleted</success> </status> </page>
Errors
- <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.
- <error>Provider rule was not found</error> - Rule was not found or User does not have permission to manage this rule.
