Difference between revisions of "MOR API lcr delete"

From Kolmisoft Wiki
Jump to navigationJump to search
(Created page with "=Description= MOR API LCR Delete <br><br> =Usage= * Call: /api/lcr_delete * Methods: POST, GET(if allowed, not recomended) <br><br> ===Parameters=== Parameters which are '''included''' into hash: * '''u''' - username for authentication. '''Required'''. * '''lcr_id''' - LCR 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''' <br><br> Parameters which are...")
 
 
Line 27: Line 27:
===Request===
===Request===


We have u = admin, name = test
We have u = admin, lcr_id=2


We send:
We send:
Line 34: Line 34:


<br><br>
<br><br>
===Returns===
===Returns===



Latest revision as of 14:53, 27 January 2023

Description

MOR API LCR Delete

Usage

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



Parameters

Parameters which are included into hash:

  • u - username for authentication. Required.
  • lcr_id - LCR 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

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. Last parameter in a row is API_Secret_Key ( More described in Constructing hash). Required.




Request

We have u = admin, lcr_id=2

We send:

HTML POST: http://<SERVER_IP>/billing/api/lcr_delete?u=admin&lcr_id=2&hash=6e79d4a82f68102f43be11d873177f47817f84df



Returns

Success

<?xml version="1.0" encoding="UTF-8"?>
<page>
 <status>
   <success>LCR successfully deleted</success>
 </status>
</page>

Errors

  • <error>You are not authorized to use this functionality</error>
  • <error>Access Denied</error>
  • <error>No LCRs found</error>
    • <message>problem message</message>

Example:

<?xml version="1.0" encoding="UTF-8"?>
<page>
  <error>Error message</error>
</page>



See also