MOR API devices get

From Kolmisoft Wiki

Jump to: navigation, search


[edit] Description

MOR API Device list

[edit] Usage

  • From MOR X4 call: /api/devices_get
  • For Backwards-compatibility old name 'device_list' is also usable. Call: /api/device_list
  • Methods: POST, GET(if allowed, not recomended)

[edit] Parametres

  • u – username for authentication. This is owner of User (admin or reseller) Required.
  • user_id – this specifies user id whose device list to show.
  • hash – SHA1 hash constructed using user_id and API_Secret_Key ( More described in Constructing hash). Required.
  • show_hidden_devices – by default it is 1. When show_hidden_devices=0, then Blocked/Hidden devices will not be shown.

Returning XML is put in file. That file is gziped and returned as a response content.

Please note that only admin/reseller can retrieve Device list and only for their own Users.

[edit] Request

We have API Secret Key = 456789, user_id = 100

We send:

HTML POST: http://<SERVER_IP>/billing/api/devices_get?u=admin&user_id=100&hash=71516eea4850f7e0300ac86adf9fb64bca845aa7

* Note that username and password are not included in hash

[edit] Returns




  • <error>User not found</error> – User was not found.
  • <error>user_id is empty</error> – user_id was not sent.
  • <error>Bad login</error> – User was not found by username and password. Use correct username and password. Make sure that username (u) and password (p) are specified.
  • <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string.

[edit] See also

Personal tools


Try M2