Web Form Plugin Configuration
A Web Form plug-in can be configured to send real-time guest user profile information to a third party application when a guest logs in successfully using the Web Form plug-in. You can view all the configuration details for the Web Form plugin. Based on the information, a personalized message or personalized offers can be presented to the guest. You can view it by navigating through Portals-> Click the portal name for which you want to configure Web Form plugin-> Settings tab-> plugin configuration -> Web Form icon. Once done with it you need to fill up the details and save it. Once done you will be able to see the configuration settings on the portal specified.
JSON Table
| Parameter | Data Type | Description | Manadatory | Default/Sample Value |
|---|---|---|---|---|
| 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. | No | 60 |
| 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. | No | 10 |
| landing_url | String | The URL of the page to which the guest user is redirected to on successful login using this plug-in. | No | http://www.google.com |
| bandwidth_upload_limit | int | Maximum upload bandwidth, in Kbps, for the guests using this plug-in. | No | 1024 |
| bandwidth_download_limit | int | Maximum download bandwidth, in Kbps, for the guests using this plug-in. | No | 1024 |
| fields | application/json | A JSON object for the Web Form fields. | No | N/A |
| fields/{field_name} | application/json | A JSON object for each Web Form field. In the request, {field_name} is replaced by the field name. The applicable fields are: username, first_name, last_name, gender, birth_day, birth_month, birth_year, location, email, and phone_number. | No | N/A |
| fields/{field_name}/display | int | Whether the Web form field must be displayed or not. 1 indicates yes and 0 indicates no. | No | 1 |
| fields/{field_name}/required | int | Whether the guest must necessarily provide a value for the Web form field. 1 indicates yes and 0 indicates no. | No | 1 |
Copy Sample JSON
Sample JSON
[{
"success": true,
"message": "Record Found",
"data": {
"totalCount": 1,
"webFormConfig": {
"pid": 6,
"session_timeout": null,
"blackout_time": null,
"date_created": "2018-02-01 13:10:31.655334",
"date_modified": null,
"redirect_landing_url": null,
"bandwidth_upload_limit": null,
"bandwidth_download_limit": null,
"redirect_endpoint_id": null,
"redirect_campaign_id": null,
"redirect_type": "redirect_landing_url",
"fields": {
"username": {
"display": 1,
"required": 0,
"field_id": 1
},
"first_name": {
"display": 1,
"required": 0,
"field_id": 2
},
"last_name": {
"display": 1,
"required": 0,
"field_id": 3
},
"gender": {
"display": 1,
"required": 0,
"field_id": 4
},
"birth_day": {
"display": 1,
"required": 0,
"field_id": 5
},
"birth_month": {
"display": 1,
"required": 0,
"field_id": 6
},
"birth_year": {
"display": 1,
"required": 0,
"field_id": 7
},
"location": {
"display": 1,
"required": 0,
"field_id": 8
},
"email": {
"display": 1,
"required": 0,
"field_id": 9
},
"phone_number": {
"display": 1,
"required": 0,
"field_id": 10
},
"private_data": {
"display": 1,
"required": 0,
"field_id": 11
}
},
"submit_url": "/api/plugin/webForm/auth",
"campaign": null
}
}
}]
API Calls
/V1.14/portals/{pid}/webform/config
/V1.14/portals/{pid}/webform/config