View source for MOR API Subscription Flat Rate Number Status Get

<!---This functionality is available from [[MOR x16| MOR x16]]--->
=Description=

[[MOR API]] method for check prefix covering flat-rate subscriptions.<br>
API returns the result if that number (prefix covering this number) is included or excluded from the flat-rate subscriptions of that user.

Can be used by:

'''Admin'''

'''Accountant''' with permissions Manage Services - write, Manage Subscriptions - read, Manage Users - read

'''Reseller'''

'''Partner''' 
<br><br>

=Usage=

* From '''MOR X16''' call: /api/user_subscriptions_check_number_status
* Methods: POST, GET(if allowed, not recomended)
<br><br>
===Parameters===  

Parameters which are included into hash

* u - username for authentication '''required'''
* user_id - '''required'''
* number - '''required'''

*[[MOR API hash construction | hash]] – SHA1 hash constructed using '''API Secret Key''' ([[MOR API hash construction | More described in Constructing hash]]). '''Required'''.

<br><br>

===Request===

If API Secret Key = secret

You send:

 HTML POST: http://<SERVER_IP>/billing/api/user_subscriptions_check_number_status?u=admin&user_id=45&number=370666888666&hash=c420ef706a02e6449994b7575b25ef5f74cc722b

<br><br>

===Returns===

 <page>
 <status>
 <number>37065</number>
 <status>included</status>
 </status>
 </page>

 <page>
 <status>
 <number>37065</number>
 <status>excluded</status>
 </status>
 </page>


'''Errors:'''

*<error>user_id must be non negative integer</error>
*<error>user_id must be provided</error>
*<error>Number must be provided</error>
*<error>User was not found</error>
*<error>User does not have any Flat-Rate subscriptions</error>


Example:

 <page>
 <status>
 <error>User was not found</error>
 </status>
 </page>

<br><br>

=See also=

* [[MOR API]]