MAPI Manual

NAME

LIST_ACCOUNT_BILLRATES

FUNCTION

List the bill rates of an organisation

SYNOPSIS

action: LIST_ACCOUNT_BILLRATES
mcp_org_id
keyword_set
order_by
search_limit

login_name 
login_passwd 
or 
login_name 
session_id 
or 
device_id 

DESCRIPTION

This function allows admins and account managers to list the bill rates of an organisation. Both GET and POST methods can be used to perform the request.

Required Parameters
* action: specifies the requested function. Sets to LIST_ACCOUNT_BILLRATES.
* mcp_org_id: the organization ID.
* keyword_set: searches the rates for descriptions matching the specified keywords.
* order_by: specifies the order of the results that are listed.
* search_limit: specifies a limit on the number of search results that are returned to users. It accepts two formats - either a
  number or two numbers separated by a comma. For example, if value is "5", the function will return the first five results to users;
  if value is "5,10", the function will return the results that are ordered within this range.

* login_name: the login name for authenticating the user.
* login_passwd: the login password for authenticating the user.
or
* login_name: the login name for authenticating the user.
* session_id: the session ID for authenticating the user.
or
* device_id: a unique ID of the device. The system can use it as a key to identify users.

RETURN DATA

For each valid request, the server provides a response in XML format.
The response contains the following attributes:
* org_id: the organization ID.
* mcp_channeltype_id: the channel type.
* rate_flag: specifies the pattern of the numbers. For example, "612%" represents any number beginning with "612".
* mcp_billing_rate_unit_id: the ID of billing rate unit. This specifies how the account usage will be charged. The rates can be calculated
  based on either the quantity of messages sent or the amount of time used.
* rate_cc: the basic rate.
* rate_sw: the service charge.
* min_rate: the minimum rate.
* description: the description of the rates.

For an invalid request, the response XML contains the following attribute:
* msg: a string containing the error message.

ROLE PERMITTED

Admin, account manager

EXAMPLES

The following example shows a successful HTTP GET request and response.

Request:
http://app02.yvntech.com/MapIHttpS/MapIS?action=LIST_ACCOUNT_BILLRATES&mcp_org_id=10&device_id=mydemoid

Response:
<result tftype='1' infotype='0'>
    <resultset name='mcp_account_billrate' search_found_rows=''>
        <row>
            <field name='org_id'>10</field>
            <field name='mcp_channeltype_id'>voice</field>
            <field name='rate_flag'>%</field>
            <field name='mcp_billing_rate_unit_id'>2</field>
            <field name='rate_cc'>0.2500</field>
            <field name='rate_sw'>0.0000</field>
            <field name='min_rate'>0.0000</field>
            <field name='description'></field>
        </row>
        <row>
            <field name='org_id'>10</field>
            <field name='mcp_channeltype_id'>voice</field>
            <field name='rate_flag'>+612%</field>
            <field name='mcp_billing_rate_unit_id'>2</field>
            <field name='rate_cc'>0.2500</field>
            <field name='rate_sw'>0.0000</field>
            <field name='min_rate'>0.0000</field>
            <field name='description'></field>
        </row>
        ...
        ...
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

LIST_ORGS

Mweb v2.0 YVNTECH 2014