plug-ins_quality_of_service

Plug-Ins Quality of Service

You can configure the quality of service parameters such as upload and download bandwidths, blackout time, login timeout, and redirect URL for each plug-in selected in a portal. Parameters like Login Timeout (mins), Blackout Time (mins), Max. Download Bandwidth (Kbps) , Max. Upload Bandwidth (Kbps), and Redirect URL are specified for configuring Quality of Service.

JSON Table

Parameter Data Type Description
success boolean Whether the API call was successful or not.
message String A message indicating the API success or failure.
data application/json A JSON object for the response data.
data/totalCount int The total number of records fetched.
data/QoSParameters application/json A JSON for the Quality of Service parameters.
data/QoSParameters/{plugin_name) application/json A JSON for the Quality of Service parameters for each plug-in. In the response, {plugin_name} is replaced by the actual name of the plug-in.
data/QoSParameters/{plugin_name}/session_timeout int The time period, in minutes, after which the guest user session expires. The user must re-authenticate to continue using the WiFi service. A value of zero indicates that the user session does not timeout and the user must explicitly log out from the portal. A non-zero timeout configured on the user account takes precedence over the timeout configured on the plug-in, portal, and the SSID profile in Wireless Manager.
data/QoSParameters/{plugin_name}/blackout_time int The time period in minutes for which a user cannot log in to the portal after his last successful login has timed out. A value of zero indicates no blackout time. The blackout time, including zero value, configured on the user account takes precedence over the blackout time configured on the plug-in, portal, and the SSID profile in Wireless Manager.
data/QoSParameters/{plugin_name}/landing_url String The URL of the page to which the guest user is redirected to on successful login using this plug-in.
data/QoSParameters/{plugin_name}/bandwidth_upload_limit int Maximum upload bandwidth, in Kbps, for the guests using this plug-in.
data/QoSParameters/{plugin_name}/bandwidth_download_limit int Maximum download bandwidth, in Kbps, for the guests using this plug-in.
data/QoSParameters/{plugin_name}/pgid int The system-generated unique ID of the plug-in.
data/QoSParameters/{plugin_name}/display_name String The display name of the plug-in.

Copy Sample JSON
Sample JSON 
{
   "success": true,
   "message": "Record(s) Found",
   "data": {
      "totalCount": 8,
      "QoSParameters": {
         "Facebook": {
            "session_timeout": 120,
            "blackout_time": 10,
            "landing_url": "http://www.google.com",
            "bandwidth_upload_limit": 1024,
            "bandwidth_download_limit": 10024,
            "pgid": 1,
            "display_name": "Facebook"
         },
         "Twitter": {
            "session_timeout": 120,
            "blackout_time": 10,
            "landing_url": "http://www.google.com",
            "bandwidth_upload_limit": 1024,
            "bandwidth_download_limit": 1024,
            "pgid": 2,
            "display_name": "Twitter"
         },
         "Linkedin": {
            "session_timeout": 120,
            "blackout_time": 10,
            "landing_url": "http://www.google.com",
            "bandwidth_upload_limit": 1024,
            "bandwidth_download_limit": 1024,
            "pgid": 3,
            "display_name": "Linkedin"
         },
         "Gplus": {
            "session_timeout": 120,
            "blackout_time": 10,
            "landing_url": "http://www.google.com",
            "bandwidth_upload_limit": 1024,
            "bandwidth_download_limit": 1024,
            "pgid": 6,
            "display_name": "Google+"
         },
         "Guestbook": {
            "landing_url": "http://www.google.com",
            "bandwidth_upload_limit": 2048,
            "bandwidth_download_limit": 2048,
            "session_timeout": 360,
            "blackout_time": 10,
            "pgid": 4,
            "display_name": "Guestbook"
         },
         "Clickthrough": {
            "session_timeout": 60,
            "blackout_time": 10,
            "landing_url": "https://www.google.com",
            "bandwidth_upload_limit": 256,
            "bandwidth_download_limit": 512,
            "pgid": 5,
            "display_name": "Clickthrough"
         },
         "Sms": {
            "session_timeout": 120,
            "blackout_time": 10,
            "landing_url": "http://www.google.com",
            "bandwidth_upload_limit": 1024,
            "bandwidth_download_limit": 1024,
            "pgid": 7,
            "display_name": "SMS"
         },
         "WebForm": {
            "session_timeout": 240,
            "blackout_time": 5,
            "landing_url": "http://www.google.com",
            "bandwidth_upload_limit": 1024,
            "bandwidth_download_limit": 1024,
            "pgid": 8,
            "display_name": "Web Form"
         }
         "WeChat": {
            "session_timeout": 120,
            "blackout_time": 5,
            "landing_url": "http://www.google.com",
            "bandwidth_upload_limit": 1024,
            "bandwidth_download_limit": 1024,
            "pgid": 9,
            "display_name": "WeChat"
         }
      }
   }
}
API Calls
Get

/v1.14/portals/{pid}/qosparameters

Get

/v1.14/portals/{pid}/qosparameters/{plugin_name}

Put

/v1.14/portals/{pid}/qosparameters/{plugin_name}

Get Quality of Service for all Plug-Ins

Description This API is used to fetch the quality of service details of all the plug-ins active for a specified portal.
Guest Manager users with the Administrator role can access this API.
Syntax
GET <Base_URL>/portals/{pid}/qosparameters

Here,

  • pid

    It is the unique ID of the portal for which the plug-in QoS details have to be fetched. It takes integer value.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/portals/50/qosparameters
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200. The API returns the QoS details of the plug-ins in the response body.

Get Quality of Service for a Plug-In

Description This API is used to fetch the quality of service details of a plug-in for a specified portal.
Guest Manager users with the Administrator role can access this API.
Syntax
GET <Base_URL>/portals/{pid}/qosparameters/{plugin_name}

Here,

  • pid

    It is the unique ID of the portal for which the plug-in QoS details have to be fetched. It takes integer value.

  • plugin_name

    It is the name of the plug-in whose QoS details have to be fetched. This parameter can take the following values: Facebook, Twitter, Linkedin, Gplus, Sms, WebForm, WeChat, and Clickthrough. It takes String value.
Sample code
GET https://analyticsdemo.mojonetworks.com/api/v1.14/portals/50/qosparameters/Facebook
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The API returns the QoS details of the plug-in in the response body.

Edit Quality of Service for a Plug-In

Description This API is used to modify the quality of service details of a plug-in for a specified portal.
Guest Manager users with the Administrator role can access this API.
Syntax
PUT <Base_URL>/portals/{pid}/qosparameters/{plugin_name}

Here,

  • pid

    It is the unique ID of the portal for which the plug-in QoS details have to be fetched. It takes integer value.

  • plugin_name

    It is the name of the plug-in whose QoS details have to be fetched. This parameter can take the following values: Facebook, Twitter, Linkedin, Gplus, Sms, WebForm, WeChat, and Clickthrough. It takes String value.
Sample code
PUT https://analyticsdemo.mojonetworks.com/api/v1.14/portals/50/qosparameters/Facebook
Request Body The API takes the plug-in QoS details to be updated as parameters in the request body.
The parameters are passed in the application/json format. A sample request body is as follows:

{
   "session_timeout": 120,
   "blackout_time": 10,
   "landing_url": "http://www.google.com",
   "bandwidth_upload_limit": 1024,
   "bandwidth_download_limit": 1024
}
Response Body If the API call is successful, the HTTP response status is 200. The API returns the QoS details of the plug-in in the response body.