JSON Responses Definitions

The following table lists the definitions of JSON responses from the NBI.
Note: The following abbreviations are used in the table columns:
  • UA: User Authenticate (Login)
  • GC: Get Config (Decrypt)
Category Code Definition UA SQ TU EI GC
Informational 100 Client unauthorized x x
101 Client authorized x x
102 Enrichment Info x
Success 200 OK x x
201 Login succeeded x
202 Authentication pending x x
Client Error 300 Not found x x x x
301 Login failed x x
302 Bad request x x x x
303 Version not supported x x x x
304 Command not supported x x x x
305 Category not supported x x x x
306 Wrong request password x x x x
Server Error 400 Internal server error x x x x
401 Authentication server error x x

JSON Response Examples

There are only two API calls used by the captive portal for Ruckus Cloud. The IP address for the call needs to be extracted from the URL parameters received by the external portal. The tenant ID where the portal is configured is prefixed to the address as in: https://ebb9ea66951549548de56a621aceb3a5.wispr.ruckus.cloud:443/portalintf. Therefore, the general format for the call is https://{{tenantID}}.wispr.ruckus.cloud:443/portalintf.

This section provides the following examples of JSON responses defined in the JSON Response Definitions.

  • UserOnlineControl/Login request
    The following example shows the UserOnlineControl/Login marked in Figure 1 as Login request/response. 
    POST https://<tenantid>.wispr.ruckus.cloud:443/portalintf
{
    "Vendor": "Ruckus",
    "APIVersion": "1.0",
    "RequestUserName": "api",
    "RequestPassword": "sharedsecret",
    "RequestCategory": "UserOnlineControl",
    "RequestType": "Login",
    "UE-IP": "ENC93ee4456a0378b6e0c8df0ea83416f46",
    "UE-MAC": "ENCb58960077a8dda598864608701fd73e1aaefa125bbcc857a",
    "UE-Username": "johndoe@myvendor.com",
    "UE-Password": "e329a4b6e264b200850e461a535469e8"
}


response example:
{
   "APIVersion": "1.0",
"Vendor": "Ruckus",
"ResponseCode": 201,
"ReplyMessage": "Login succeeded",
"AP-MAC": "33:9F:37:21:88:E0",
"SSID": "MyHomeWifi",
"GuestUser": "0",
"UE-IP": "ENCb3579628807a64f0e008793bd3623389",
"UE-Proxy": 0,
"UE-Username": "bc5faa30d6e24389b7777d0d6503c8fa-facebook@2702337dd673",
"UE-MAC": "ENC2e50f302e3cc0f79756121786ce8955e7a8dbb9754ddeba0",
"SmartClientMode": "none",
"SmartClientInfo": ""
}