Important!
This documentation has been deprecated. We are migrating Oempro help articles to our new help portal. Take a look at more detailed help articles on our new help portal.
Sections:
- Description
- Oempro Version
- Request Parameters
- Response Parameters
- Error Codes
UserGroup.Get
Description
Retrieves user group
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 = {UserGroup.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
- UserGroupID = {integer} (required)
- ID number of the target user group
Response Parameters
- Success = {true | false}
- States if there is an error or not
- ErrorCode = {integer}
- If there is an error, error's code
- UserGroup = {array}
- Requested user group information
Error Codes
- 1
- Missing user group ID
- 2
- Invalid user group ID
- 99998
- Authentication failure or session expired
- 99999
- Not enough privileges
Stay connected!