Guestbook Users
A guestbook is a private list of guest users to whom we provide access to wifi setup. When a user wants to access the Internet through our WiFi setup, they can either login with their social media account or request for a guest user account. This guest user account information is stored in the guest book of the portal. You can obtain user-specific information and add it to the user profile when creating a user account. To manage the guest book, you must have either the Administrator role or the Operator role.
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 users fetched. |
data/userAccount | application/json | A JSON for the guest user account. |
data/userAccount/uid | int | The system-generated unique ID for the guest user. |
data/userAccount/pid | int | The system-generated ID of the portal |
data/userAccount/puid | int | Portal-specific guest user ID. |
data/userAccount/username | String | The guest user account name. |
data/userAccount/password | String | The password for the guest user account. |
data/userAccount/bid | int | The guestbook batch ID for the guest user account. If the guest user account is not part of a batch, the value for this property is null. |
data/userAccount/pfid | int | The Guestbook profile ID. |
data/userAccount/active | int | Whether the guest user account is active . 1 indicates active. 0 indicates inactive. |
data/userAccount/date_created | Date | The date on which the guest user account was created. |
data/userAccount/expiration_date | Date | The date till which the guest user account will be valid. |
data/userAccount/session_timeout | int | The time period, in minutes, after which the guest user session 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 user account takes precedence over the timeout configured on the plug-in, portal, and the SSID profile in Wireless Manager. |
data/userAccount/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/userAccount/date_modified | Date | The last date on which the guest user account was modified. |
data/userAccount/send_email | int | Whether the guest account details need to be sent in an email to the user on creation or updation. 1 indicates yes and 0 indicates no. |
data/userAccount/date_email_send | Date | The last date on which email was sent to the guest user. |
data/userAccount/bandwidth_upload_limit | int | Maximum upload bandwidth, in Kbps, for this guest user account. |
data/userAccount/bandwidth_download_limit | int | Maximum download bandwidth, in Kbps, for this guest user account. |
data/userAccount/email_status | application/json | A JSON representing the status of the last email sent ot the guest. |
data/userAccount/email_status/status | String | The status of the last email sent. Applicable values are ‘Sent’ and ‘Failed’. |
data/userAccount/email_status/message | String | A message stating why the email was not sent. If sent, this is blank. |
data/userAccount/email_status/time | String | The time when the last email was sent. |
data/userAccount/UserProfile | application/json | A JSON representing the user profile. |
data/userAccount/UserProfile/firstname | String | The first name of the guest user. |
data/userAccount/UserProfile/lastname | String | The last name of the guest user. |
data/userAccount/UserProfile/email | String | The email address of the guest user. |
data/userAccount/UserProfile/company | String | The company name of the guest user. |
data/userAccount/UserProfile/mobile_phone | String | The mobile phone number of the guest user. |
data/userAccount/UserProfile/address | String | The address of the guest user. |
data/userAccount/UserProfile/host | String | The name of the person the guest user has come to meet. |
data/userAccount/UserProfile/notes | String | Additional notes about the guest user. |
[{ "success": true, "message": "Record Found", "data": { "totalCount": 1, "userAccount": { "self_registered": 0, "login_count": 0, "uid": null, "pid": null, "username": null, "password": null, "bid": null, "active": null, "date_created": null, "expiration_date": null, "session_timeout": null, "blackout_time": null, "date_modified": null, "date_email_send": null, "bandwidth_upload_limit": null, "bandwidth_download_limit": null, "device_limit": null, "user_type": null, "email": null, "first_name": null, "last_name": null, "company": null, "mobile_phone": null, "address": null, "host": null, "notes": null, "gender": null, "last_login": null, "date_sms_send": null, "ssid_name": null, "ssid_key": null, "activation_date": null, "host_approval_granted": null, "host_approval_identity": null, "host_approval_request_timestamp": null, "host_approval_response_timestamp": null, "login_count_limit": null, "last_payment_timestamp": null, "last_payment_tier_name": null, "last_payment_amount": null, "last_payment_currency": null, "last_payment_session_time": null, "paid_pending_session_time": null, "last_free_session_time": null, "free_pending_session_time": null, "logged_in_device_count": null, "registration_device_mac": null, "last_paid_session_expiry_timestamp": null, "free_session_renewal_timestamp": null, "last_session_start_timestamp": null, "last_session_stop_timestamp": null, "blackout_end_timestamp": null, "email_status": { "status": null, "message": null, "time": null }, "sms_status": { "status": null, "message": null, "time": null }, "host_approval_status": null, "client_list": [] } } }]
/V1.14/portals/{pid}/guestbook/users/{uid}
/V1.14/portals/{pid}/guestbook/users
/V1.14/portals/{pid}/guestbook/users/defaultusernamepassword
/V1.14/portals/{pid}/guestbook/users/exportcsv
/V1.14/portals/{pid}/guestbook/users/{uid}
/V1.14/portals/{pid}/guestbook/users/enabledisableusers
/V1.14/portals/{pid}/guestbook/users
/V1.14/portals/{pid}/guestbook/users/{uid}/mailguest
/V1.14/portals/{pid}/guestbook/users/importcsv
/V1.14/portals/{pid}/guestbook/users/{uid}
/V1.14/portals/{pid}/guestbook/users/delete/bulk