JSON Response Examples

Example: Client unauthorized

{
"Vendor":"Ruckus",
"APIVersion":"1.0",
"ResponseCode": 100,
"ReplyMessage":"Client unauthorized",
"UE-IP":"ENC323e79bf1bbd5ac4",
"UE-MAC":"ENCf6b7f49da92a45f8978c35966b95eeafc6451102af391592",
"AP-MAC":"00:11:22:AA:BB:CC",
"SSID":" hotspot-01",
"SmartClientInfo":"",
"GuestUser":"0",
"SmartClientMode":"none"
}

Example: Client authorized

{
"Vendor": "Ruckus",
"APIVersion": "1.0",
"ResponseCode": 101,
"ReplyMessage": "Client authorized",
"UE-IP": "ENC12bc24c4777703327f2e0aabbf6b9f9e",
"UE-MAC": "ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157",
"UE-Username": "user001",
"AP-MAC": "04:4f:aa:32:25:f0",
"SSID": "hotspot-01"
"SmartClientMode": "none",
"SmartClientInfo": "",
"GuestUser": "0",
}

Example: Enrichment information

{
"Vendor": "Ruckus",
"APIVersion": "1.0",
"ResponseCode": 102,
"ReplyMessage": "Enrichment Information",
"UE-IP": "ENC12bc24c4777703327f2e0aabbf6b9f9e",
"UE-MAC": "ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157",
"AP-MAC": "04:4f:aa:32:25:f0",
"SSID": "hotspot-01",
"WLAN-ID": "1",
"Location": "a location",
"VLAN-ID": "1"
}

Example: Success information

{
"Vendor": "Ruckus",
"Version": "1.0",
"ResponseCode": 200,
"ReplyMessage": "OK"
"UE-IP": "ENC12bc24c4777703327f2e0aabbf6b9f9e",
"UE-MAC": "ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157",
"SmartClientMode": "none",
"SmartClientInfo": "",
"GuestUser": "0",
}

Example: Login succeeded

{
"Vendor": "Ruckus",
"APIVersion": "1.0",
"ResponseCode": 201,
"ReplyMessage": "Login succeeded",
"UE-IP": "ENC12bc24c4777703327f2e0aabbf6b9f9e",
"UE-MAC": "ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157",
"UE-Username": "user001",
"AP-MAC": "04:4f:aa:32:25:f0",
"SSID": "hotspot-01",
"SmartClientMode": "none",
"SmartClientInfo": "",
"GuestUser": "0",
"UE-Proxy": "0"
}

Example: Authentication pending

{
"Vendor": "ruckus",
"APIVersion": "1.0",
"ResponseCode": 202,
"ReplyMessage": "Authentication pending",
"UE-IP": "ENC12bc24c4777703327f2e0aabbf6b9f9e",
"UE-MAC": "ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157",
"UE-Username": "user001",
"AP-MAC": "04:4f:aa:32:25:f0",
"SSID": "hotspot-01",
"SmartClientMode": "none",
"SmartClientInfo": "",
"GuestUser": "0",
}

Example: Not found

{
 "Vendor": "Ruckus",
 "APIVersion": "1.0",
 "ResponseCode": 300,
 "ReplyMessage": "Not found",
}

Example: Login failed

{
"Vendor": "Ruckus",
"APIVersion": "1.0",
"ResponseCode": 301,
"ReplyMessage": "Login failed",
"UE-IP": "ENC12bc24c4777703327f2e0aabbf6b9f9e",
"UE-MAC": "ENCCDD319C6A476FA7127DF1FB80A63CD30ADC5E47C3DBE2157",
"AP-MAC": "04:4f:aa:32:25:f0",
"SSID": "hotspot-01",
"SmartClientMode": "none",
"SmartClientInfo": "",
"GuestUser": "0",
}

Example: Bad request

{
"Vendor": "ruckus",
"APIVersion": "1.0",
"ResponseCode": 302,
"ReplyMessage": "Bad request",
}

Example: Version not supported

{
"Vendor": "ruckus",
"APIVersion": "1.0",
"ResponseCode": 303,
"ReplyMessage": "Version not supported"
}

Example: Command not supported

{
"Vendor": "ruckus",
"APIVersion": "1.0",
"ResponseCode": 304,
"ReplyMessage": "Command not supported",
}

Example: Category not supported

{
"Vendor": "ruckus",
"APIVersion": "1.0",
"ResponseCode": 305,
"ReplyMessage": "Category not supported",
}

Example: Wrong request password

{
"Vendor": "ruckus",
"APIVersion": "1.0",
"ResponseCode": 306,
"ReplyMessage": "Wrong request password",
}

Example: Internal server error

{
"Vendor": "ruckus",
"APIVersion": "1.0",
"ResponseCode": 400,
"ReplyMessage": "Internal server error",
}

Example: Authentication server error

{
"Vendor": "ruckus",
"APIVersion": "1.0",
"ResponseCode": 401,
"ReplyMessage": "Authentication server error",
}

Example: Encrypt for MAC address

{
"Vendor": “ruckus”,
"RequestPassword": “myPassword”,
"APIVersion": “1.0”,
"RequestCategory": “GetConfig”,
"RequestType": “Encrypt”,
"Data": “04:4f:aa:32:25:f0”
}
The success response:
{
"Vendor": “ruckus”,
"ReplyMessage":”OK",
"ResponseCode": 200,
"APIVersion":“1.0”,
"Data": "ENC4782689566f8eac8aa30e276aa907f332d0bf93f9f60a7d8"
}

Example: Decrypt for MAC address

{
"Vendor": "ruckus",
"RequestPassword": “myPassword”,
"APIVersion": "1.0",
"RequestCategory": "GetConfig",
"RequestType": "Decrypt",
"Data": "ENC4782689566f8eac8aa30e276aa907f332d0bf93f9f60a7d8"
}
The success response:
{
"Vendor":"ruckus", 
"ReplyMessage":"OK",
"ResponseCode": 200,
"APIVersion":"1.0"
"Data": "04:4f:aa:32:25:f0"
}