Sections:

1. Description
2. Oempro Version
3. Request Parameters
4. Response Parameters
5. Error Codes

Users.Get

Description

Retrieves users

Oempro Version

4+

Request Parameters

SessionID = {string} (required)

Session ID which is needed to authenticate the access. It's optional and required for desktop applications only

Command = {Users.Get} (required)

API Command

ResponseFormat = {JSON | XML} (required)

Response format

JSONPCallBack = {bool}

Send this parameter for cross-domain. More info about JSONP can be found here: http: //en.wikipedia.org/wiki/JSON#JSONP

OrderField = {string} (required)

Name of the field to order based on. For multiple ordering, separate fields with pipe '|'

OrderType = {ASC | DESC} (required)

Ascending or descending ordering. For multiple ordering, separate fields with pipe '|'

RelUserGroupID = {mixed (required)

User group ID of users (integer) or account status ("Enabled", "Disabled") or online status ('Online')

RecordsPerRequest = {integer} (required)

How many rows to return per page

RecordsFrom = {integer} (required)

Start from (starts from zero)

SearchField = {string}

Name of the field

SearchKeyword = {string}

Keyword for searching

Response Parameters

Success = {true | false}

States if there is an error or not

ErrorCode = {integer}

If there is an error, error's code

ErrorText = {text}

Users = {array}

Returns the list of all users in array

TotalUsers = {integer}

Returns the total number of users

Error Codes

99998

Authentication failure or session expired

99999

Not enough privileges

Stay connected!