MOR API user details get
From Kolmisoft Wiki
Jump to navigationJump to search
Description
MOR API user details
Admin – can get any user details
Reseller – can get his and his users details.
User – can get his own details.
Usage
- Call: /api/user_details_get
- For Backwards-compatibility old name 'user_details' is also usable. Call: /billing/api/user_details
- Methods: POST, GET(if allowed, not recomended)
Parametres
- user_id - Users ID in MOR database. Required. Type: INTEGER
- u - Users username. Required.
- hash - SHA1 hash constructed using user_id and API_Secret_Key ( More described in Constructing hash). Required.
Request
We have user_id = 123, API Secret Key = 456789
We send:
HTML POST: http://<server_ip>/api/user_details_get?u=username&user_id=123&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441
* Note that username and password are not included in hash
Returns
Success
<page> <pagename>Personal_details</pagename> <language>en</language> <userid> user id </userid> <details> <main_detail> <account>Postpaid/Prepaid</account> <balance> balance and currency </balance> <balance_number> balance </balance_number> <balance_currency> currency </balance_currency> <credit> credit </credit> </main_detail> <other_details> <username> username </username> <first_name> first name </first_name> <surname> last name </surname> <personalid></personalid> <agreement_number> </agreement_number> <agreement_date> </agreement_date> <taxation_country> </taxation_country> <vat_reg_number> </vat_reg_number> <vat_percent> </vat_percent> </other_details> <registration> <reg_address></reg_address> <reg_postcode></reg_postcode> <reg_city></reg_city> <reg_country></reg_country> <reg_state></reg_state> <reg_direction></reg_direction> <reg_phone></reg_phone> <reg_mobile></reg_mobile> <reg_fax></reg_fax> <reg_email></reg_email> </registration> </details> </page>
Errors
- <error>User was not found</error> - User was not found using user_id. Use correct user_id.
- <error>Incorrect hash</error> - Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.\