MOR API device rules get

From Kolmisoft Wiki

Jump to: navigation, search

Contents

[edit] Description

MOR API device rules get

[edit] Usage

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



[edit] Parameters

Parameters which are included into hash:

  • device_id - List rules of this Device. Required.



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



[edit] Request

We have device_id = 2, API Secret Key = secret

We send:

HTML POST: http://<SERVER_IP>/billing/api/device_rules_get?u=admin&device_id=4&hash=6e79d4a82f68102f43be11d873177f47817f84df



[edit] Returns

Success

<?xml version="1.0" encoding="UTF-8"?>
<page>
    <status>
        <device_rules>
            <device_rule>
                <id>1</id>
                <device_id>4</device_id>
                <name>asd</name>
                <enabled>1</enabled>
                <cut>10</cut>
                <add>20</add>
                <minlen>1</minlen>
                <maxlen>100</maxlen>
                <pr_type>dst</pr_type>
                <change_callerid_name>0</change_callerid_name>
                <devicerulegroup_id>0</devicerulegroup_id>
            </device_rule>
        </device_rules>
    </status>
</page>




Errors

  • Device was not found - User does not have permission to view this Device or Device does not exist;
  • Device has no rules - Device does not have any rules.

Example:

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



[edit] See also

Personal tools

Try MOR

Try M2