Querying a User Status

After the authentication request is issued, the external web portal server can query the user's authentication status.
Note: This topic is only applicable to vSZ-E platform.

The following is an example of the user status query command: 

{
 “Vendor”: “ruckus”, 
 “RequestUserName”: "myUserName" 
 “RequestPassword”: “myPassword”,
 “APIVersion”: “1.0”,
 “RequestCategory”: “UserOnlineControl”,
 “RequestType”: “Status”,
 “UE-IP”: “ENC12bc24c4777703327f2e0aabbf6b9f9e”,
 “UE-MAC”: “ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157”
}

The table lists the controller responses to these user status query commands.

Controller responses to user status query

Response Type Possible Responses
If there is a pending authentication process for this client
  • 201, Login succeeded.
  • 202, Authentication pending: Authentication is in progress, portal server needs to check the result later.
If there is no pending authentication process for this client
  • 100, Client unauthorized.

    or

  • 101, Client authorized.
Service error
  • 300, Not found: Response if the lookup fails with given UE- MAC or UE-IP address.
  • 301, Login failed: It will be replaced if the authentication reply message is returned
  • 400, Internal server error: Response when an controller internal error occurs.
  • 401, Authentication server error: Response when a authentication connection error occurs or the connection request times out.
General error
  • 302, Bad request: Response if the JSON request is not well-formed.
  • 303, Version not supported: Response if there is a version mismatch.
  • 304, Command not supported: Response if the request type is not supported.
  • 305, Category not supported: Response if the request category not supported.
  • 306, Wrong request password: Response if the request password is mismatched.
Note: If an authentication process has a result (not pending), the controller responds to it only once. For example, if the controller replies 301, Login failed to the web portal server, and the web portal server sends the same query, the response will be 100, unauthorized. If the controller replies 201, Login succeeded, and the web portal server queries again, the response will be 101, Authorized.
Parent topic: JSON Commands - User Online Control