Guestbook Configuration
A Guestbook 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 Guestbook plug-in. You can view all the configuration details for the Guestbook 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 Guestbook plugin-> Settings tab-> plugin configuration -> Guestbook 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.
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/guestbookConfig | application/json | A JSON object of the plug-in configuration. |
data/guestbookConfig/pid | int | The system-generated unique ID of the portal. |
data/guestbookConfig/date_created | Date | The dat on which the plug-in was initially configured on the portal. |
data/guestbookConfig/date_modified | Date | The last date on which the plug-in configuration was modified. |
data/guestbookConfig/email_content | String | The body text of the email to be sent to the guestbook user. |
data/guestbookConfig/email_subject | String | The subject text of the email to be sent to the guestbook user. |
data/guestbookConfig/landing_url | String | A JSON object of the plug-in configuration. |
data/guestbookConfig/bandwidth_upload_limit | int | Maximum upload bandwidth, in Kbps, for this plug-in in the portal. |
data/guestbookConfig/bandwidth_download_limit | int | Maximum download bandwidth, in Kbps, for this plug-in in the portal. |
data/guestbookConfig/session_timeout | int | The time period, in minutes, after which the guest user session for the plug-in expires. The user must re-authenticate with his login credentials if he wants 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 plug-in takes precedence over the timeout configured on the portal and the SSID profile in Wireless Manager. |
data/guestbookConfig/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 plug-in takes precedence over the blackout time configured on the portal and the SSID profile in Wireless Manager. |
data/guestbookConfig/fields | application/json | A JSON object listing the fields for the guestbooks user. Each field is a JSON object with twp parameters, display and required. The parameters take integer values indicating whether the field should be displayed and whether a value for the field is required. A value of 1 indicates true and 0 indicates false. |
data/guestbookConfig/fields/first_name | application/json | The JSON object for the first name field. |
data/guestbookConfig/fields/last_name | application/json | The JSON object for the last name field. |
data/guestbookConfig/fields/email | application/json | The JSON object for the email field. |
data/guestbookConfig/fields/company | application/json | The JSON object for the company field. |
data/guestbookConfig/fields/mobile_phone | application/json | The JSON object for the mobile phone number field. |
data/guestbookConfig/fields/address | application/json | The JSON object for the address field. |
data/guestbookConfig/fields/host | application/json | The JSON object for the host field. |
data/guestbookConfig/fields/notes | application/json | The JSON object for the notes field. |
[{ "success": true, "message": "Record Found", "data": { "totalCount": 1, "guestbookConfig": { "pid": 1, "date_created": "2017-09-11 05:37:20.992108", "date_modified": "2017-11-16 09:06:35.59143", "email_content": " Welcome to Mojo Guest WiFi" } } }]
/V1.14/portals/{pid}/guestbook/config
/V1.14/portals/{pid}/guestbook/config