guestbook_users

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.

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 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.

Copy Sample JSON
Sample JSON 
[{
    "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": []
        }
    }
}]
API Calls
Get

/V1.14/portals/{pid}/guestbook/users/{uid}

Get

/V1.14/portals/{pid}/guestbook/users

Get

/V1.14/portals/{pid}/guestbook/users/defaultusernamepassword

Get

/V1.14/portals/{pid}/guestbook/users/exportcsv

Put

/V1.14/portals/{pid}/guestbook/users/{uid}

Put

/V1.14/portals/{pid}/guestbook/users/enabledisableusers

Post

/V1.14/portals/{pid}/guestbook/users

Post

/V1.14/portals/{pid}/guestbook/users/{uid}/mailguest

Post

/V1.14/portals/{pid}/guestbook/users/importcsv

Delete

/V1.14/portals/{pid}/guestbook/users/{uid}

Delete

/V1.14/portals/{pid}/guestbook/users/delete/bulk

Get Guestbook User

Description This API fetches the guest user account and profile details from the Guestbook plug-in of a specified portal.
Guest Manager users with the Administrator role or the Guestbook Operator role can access this API. Users with the Guestbook Operator role must have access to the portal on which the guest user account for the Guestbook plug-in exists.
Syntax
GET <Base_URL>/portals/{pid}/guestbook/users/{uid}
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/portals/1/guestbook/users/1

Here,

  • pid

    It is the unique ID of the portal in which the guest user account in the Guestbook plug-in is created.

  • uid

    It is the unique ID of the guest user account in the Guestbook plug-in that is being updated.
Request Body This API call does not require any request body parameters.
Response Body The API returns the guest user account and profile details in the response body.
The response is in the application/json format.

Get Guestbook Users

Description This API fetches the guest user account and profile details of all the guest users.
Guest Manager users with the Administrator role or the Guestbook Operator role can access this API. Users with the Guestbook Operator role must have access to the portal from which the guest user accounts for the Guestbook plug-in are fetched.
Syntax
GET <Base_URL>/portals/{pid}/guestbook/users

Here,

  • pid

    It is the unique ID of the portal in which the guest user account in the Guestbook plug-in is created.

  • uid

    It is the unique ID of the guest user account in the Guestbook plug-in that is being updated.
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/portals/1/guestbook/users
Request Body This API call does not require any request body parameters.
Response Body The API returns the guest user account and profile details in the response body.
The response is in the application/json format.

Export Guestbook Users

Description This API exports the user account details of guest users that match the specified filter criteria to a CSV file
and download the CSV file.
Guest Manager users with the Administrator role or the Guestbook Operator role can access this API. Users with the Guestbook Operator role must have access to the portal from which the guest user
accounts for the Guestbook plug-in are exported.
Syntax
GET <Base_URL>/portals/{pid}/guestbook/users/exportcsv

Here,

  • pid

    It is the unique ID of the portal in which the guest user account in the Guestbook plug-in is created.
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/portals/50/guestbook/users/
exportcsv?”&filter={“property”:”external_customer_id”,”value”:”customer11″,”operator”:”=”}
Request Body This API call does not require any request body parameters.
Response Body If successful, the API exports the guest user accounts that meet the filter criteria to a CSV file and
starts downloading the file.

Get Default Username And Password

Description This API fetches a random username (that does not exist in the system) and password for creating a guest user account.
Guest Manager users with the Administrator role or the Guestbook Operator role can access this API. Users with the Guestbook Operator role must have access to the portal on which the guest user account for the Guestbook plug-in is being created or updated.
Syntax
GET <Base_URL>/portals/{pid}/guestbook/users/defaultusernamepassword

Here,

  • pid

    It is the unique ID of the portal in which the guest user account in the Guestbook plug-in is created.
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/portals/1/
guestbook/users/defaultusernamepassword
Request Body This API call does not require any request body parameters.
Response Body The API returns a JSON with the user name and password in the response body.

Edit Guestbook User

Description This API is used to edit a guest user account in the Guestbook plug-in of a portal.
Guest Manager users with the Administrator role or the Guestbook Operator role can access this API.
Users with the Guestbook Operator role must have access to the portal on which the guest user account for the Guestbook plug-in exists.
Syntax
PUT <Base_URL>/portals/{pid}/guestbook/users/{uid}

Here,

  • pid

    It is the unique ID of the portal in which the guest user account in the Guestbook plug-in is created.

  • uid

    It is the unique ID of the guest user account in the Guestbook plug-in that is being updated.
Sample code
PUT https://marketverticalanalytics.airtightnw.com/api/v1.14/portals/1/guestbook/users/52
Request Body The API takes the guest user account and user profile details as parameters in the request body.
The parameters are passed in the application/json format.
Response Body The API returns the updated guest user account in the response body. The response is in the application/json format.

Enable Or Disable User

Description This API is used to enable or disable guest user accounts.
Guest Manager users with the Administrator role or the Guestbook Operator role can access this API.
Users with the Guestbook Operator role must have access to the portal in which the guest user accounts
for the Guestbook plug-in exist.
Syntax
PUT <Base_URL>/portals/{pid}/guestbook/users/enabledisableusers

Here,

  • pid

    It is the unique ID of the portal in which the guest user accounts in the Guestbook plug-in exist.
Sample code
PUT https://marketverticalanalytics.airtightnw.com/api/v1.14/portals/guestbook/users/
enabledisableusers
Request Body The API takes the guest user account IDs and the value for the active porperty as parameters in the
request body.
Response Body The API returns the updated guest user account IDs and whether they are enabled
or disabled in the response body. The response is in the application/json format.

Add Guestbook Users

Description This API is used to add a guest user account in the Guestbook plug-in of a portal.
A guest can then use this account to authenticate from the Guestbook plug-in on the portal splash page and access the WiFi.
Syntax
POST <Base_URL> /portals/{pid}/guestbook/users

Here,

  • pid

    It is the unique ID of the portal in which the guest user account in the Guestbook plug-in is created.

  • uid

    It is the unique ID of the guest user account in the Guestbook plug-in that is being updated.
Sample code
POST https://marketverticalanalytics.airtightnw.com/api/v1.14/portals/2/guestbook/users
Request Body The API takes the guest user account and user profile details as parameters in the request body.
The parameters are passed to the application/JSON format.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains primary information of all templates of the specified type and for the specified location.
The response is in the application/JSON format.

Send Email To Guestbook User

Description This API sends the guest user account information through email to the guest user, if the email address is configured.
Guest Manager users with the Administrator role or the Guestbook Operator role can access this API.
Users with the Guestbook Operator role must have access to the portal in which the guest user account for the Guestbook plug-in exists.
Syntax
POST <Base_URL>/portals/{pid}/guestbook/users/{uid}/mailguest

Here,

  • pid

    It is the unique ID of the portal in which the guest user account in the Guestbook plug-in is created.

  • uid

    It is the unique ID of the guest user account in the Guestbook plug-in that is being updated.
Sample code
POST https://marketverticalanalytics.airtightnw.com/api/v1.14/portals/50/guestbook/users/1
/mailguest
Request Body This API call does not require any request body parameters.
Response Body The API returns the status of the email operation in the response body.
The response is in the application/json format.
A sample response is as follows:

{
"success": true,
"message": "Mail sent",
"data": {
"other": "Mail sent"
}
}

Import Guestbook Users

Description This API is used to import guest user accounts from a CSV file in to the Guestbook plug-in of the portal.
Guest Manager users with the Administrator role or the Guestbook Operator role can access this API.
Users with the Guestbook Operator role must have access to the portal in to which the guest user
accounts for the Guestbook plug-in are imported.
Syntax
POST <Base_URL>/portals/{pid}/guestbook/users/importcsv

Here,

  • pid

    It is the unique ID of the portal in which the guest user account in the Guestbook plug-in is created.
Sample code
POST https://marketverticalanalytics.airtightnw.com/api/v1.14/portals/1/guestbook/users/
importcsv
Request Body The API takes the CSV file and a form data as parameters in the request body.
The parameters are passed in the application/json format.
The following table describes the parameters and the applicable values.

  • csv_file

    The name of the CSV file to be imported.

  • ImportForm

    This is a form data.

  • ImportForm/csv_file

    The field must be blank.

  • ImportForm/send_email

    The name of the CSV file to be imported.
Response Body The API returns the status of the email operation in the response body.
The response is in the application/json format.

Delete Guestbook User

Description This API deletes a guest user account from the Guestbook plug-in of the specified portal.
Guest Manager users with the Administrator role or the Guestbook Operator role can access this API.
Users with the Guestbook Operator role must have access to the portal on which the guest user account for the Guestbook plug-in exists.
Syntax

DELETE <Base_URL>/portals/{pid}/guestbook/users/{uid}

Here,

  • pid

    It is the unique ID of the portal in which the guest user account for the Guestbook plug-in exists.

  • uid

    It is the unique ID of the guest user account for the Guestbook plug-in.
Sample code
DELETE https://marketverticalanalytics.airtightnw.com/api/v1.14/portals/1/guestbook/users/52
Request Body This API call does not require any request body parameters.
Response Body The API returns the guest user account and profile details of the deleted guest user in the response body.
The response is in the application/json format.

Delete Guestbook Users

Description This API deletes the guest user account and profile details of multiple guest users from the
Guestbook plug-in of the specified portal. Guest Manager users with the Administrator role or the Guestbook
Operator role can access this API.
Users with the Guestbook Operator role must have access to the portal from which the guest user
accounts for the Guestbook plug-in are deleted.
Syntax
DELETE <Base_URL>/portals/{pid}/guestbook/users/delete/bulk

Here,

  • pid

    It is the unique ID of the portal from which the guest user accounts for the Guestbook plug-in are to be deleted.
Sample code
DELETE https://marketverticalanalytics.airtightnw.com/api/v1.14/portals/1/guestbook/users/
delete/bulk
Request Body The API takes the guest user account IDs as parameter in the request body.
The parameters are passed in the application/json format.
The following table describes the parameters and the applicable values.

  • uids

    An array of guest user account IDs of the guest users that have to be deleted.
Response Body The API returns the guest user account and profile details of the deleted guest users in the response body.
The response is in the application/json format.