Querying Enrichment Information

The Northbound Portal Interface provides the JSON command EnrichmentInfo for verifying that the enrichment information has the same content as HTML header enrichment info sent from the AP.

This allows the captive portal to obtain the enriched parameters in an SSL (Secure Sockets Layer) scenario or in other cases wherein the AP enrichment info is not available.

Note: The EnrichmentInfo command is only applicable for UEs connected to Ruckus APs and not for 3rd party APs.

The following is an example of the EnrichmentInfo request: 

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

The table lists the responses for enrichment information.

Query enrichment

Response Type Possible Responses
Normal response
  • 102, Enrichment Information.
Service error
  • 300, Not found: Response if the lookup fails with given UE- MAC or UE-IP address.
  • 400, Internal server error: Response when an controller internal error occurs.
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