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
Client.Update
Description
Update client account information
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 = {Client.Update} (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
- Access = {user | client} (required)
- Determines the user type of api command. Default is user.
- ClientID = {integer} (required)
- ID number of the client account
- ClientUsername = {string} (required)
- Username of the client account
- ClientPassword = {string} (required)
- Password of the client account
- ClientEmailAddress = {string} (required)
- Email address of the client account
- ClientName = {string} (required)
- Name of the client account
- ClientAccountStatus = {Enabled | Disabled} (required)
- Account status of the client
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}
Error Codes
- 1
- Client name is missing
- 2
- Client username is missing
- 3
- Client password is missing
- 4
- Client email address is missing
- 5
- Invalid client account status
- 6
- Client ID is missing
- 7
- Email address format is invalid
- 8
- Insufficient privileges for updating the client account
- 9
- Username already registered to another client
- 10
- Email address already registered to another client
- 99998
- Authentication failure or session expired
- 99999
- Not enough privileges
Stay connected!