server_management

Server Management

It helps us to get the list of servers over the network. You can test the server and check it in server settings. If you add a server you can view it under the list of servers page. Guest Manager has an attribute by which it doesn’t try to connect to the server when you add one and neither does it check the version of it. If any information falls incorrect, it results into failure of the operation.

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 servers fetched
data/server application/json The JSON object for the server details
data/server/sid int The unique ID for the server.
data/server/display_name String The display name for the server.
data/server/hostname String The DNS name or IP address of the server.
data/server/instance_id int The instance ID of the server.
data/server/username String The server user account to access the server.
data/server/password String The password for the server user account.
data/server/date_created date The date and time at which the server was added to the customer account in Guest Manager.
data/server/date_modified date The date and time when the server details were last updated.
data/server/is_sso_enabled int Whether the server is SSO enabled or not. 0 indicates false and 1 indicates true.
data/server/lastSyncTime applicatio/json The JSON object for the time when the analytics information was last synced.
data/server/lastSyncTime/location date The last sync time for location analytics data.
data/server/lastSyncTime/social date The last sync time for the social analytics data.
data/server/lastSyncTime/visitor_and_conversion date The last sync time for the visitor and conversion analytics.
data/server/lastSyncTime/loyalty_and_wifi_usage date The last sync time for the loyalty and WiFi usage analytics.
data/server/syncStatus application/json The JSON object for the last sync status.
data/server/syncStatus/location boolean Whether location data syncing was successfull or not.
data/server/syncStatus/social boolean Whether social data syncing was successfull or not.
data/server/syncStatus/visitor_and_conversion boolean Whether visitor and conversion data syncing was successfull or not.
data/server/syncStatus/loyalty_and_wifi_usage boolean Whether loyalty and WiFi usage data syncing was successfull or not.

Copy Sample JSON
Sample JSON 
[
{
    "success": true,
    "message": "Record(s) Found",
    "data": {
        "totalCount": 2,
        "server": [
            {
                "sid": 1,
                "display_name": "mwmpv",
                "hostname": "mwm-pv.dt.airtightnw.com",
                "instance_id": 0,
                "username": "TEST_USER",
                "password": "TEST_USER",
                "date_created": "2017-09-08 12:25:15.407043",
                "date_modified": null,
                "is_sso_enabled": 1,
                "lastSyncTime": {
                    "location": "2018-01-22 05:35:10",
                    "social": "2018-02-01 07:00:35",
                    "visitor_and_conversion": "2018-01-22 04:37:33",
                    "loyalty_and_wifi_usage": "2018-01-22 05:35:14",
                    "wifi_user_data": "2018-02-01 00:00:58",
                    "location_tracking": "2018-01-22 05:35:14",
                    "showrooming": "2018-02-01 07:00:35"
                },
                "syncStatus": {
                    "location": false,
                    "social": true,
                    "visitor_and_conversion": false,
                    "loyalty_and_wifi_usage": true,
                    "wifi_user_data": true,
                    "location_tracking": true,
                    "showrooming": true
                }
            },
            {
                "sid": 3,
                "display_name": "Server123",
                "hostname": "192.168.62.180",
                "instance_id": 0,
                "username": "user23",
                "password": "pwd1",
                "date_created": "2018-01-24 07:24:21.15807",
                "date_modified": "2018-01-24 07:25:44.361133",
                "is_sso_enabled": 0,
                "lastSyncTime": {
                    "location": null,
                    "social": "2018-02-01 07:00:35",
                    "visitor_and_conversion": null,
                    "loyalty_and_wifi_usage": null,
                    "wifi_user_data": "2018-02-01 00:00:58",
                    "location_tracking": null,
                    "showrooming": "2018-02-01 07:00:35"
                },
                "syncStatus": {
                    "location": null,
                    "social": true,
                    "visitor_and_conversion": null,
                    "loyalty_and_wifi_usage": null,
                    "wifi_user_data": true,
                    "location_tracking": null,
                    "showrooming": true
                }
            }
        ]
    }
}
]
API Calls
Get

/V1.14/servers

Get

/V1.14/servers/{server_id}

Get

/V1.14/analytics/sync/status

Put

/V1.14/servers/{server_id}

Put

/V1.14/analytics/sync/status

Post

/V1.14/servers/testconnection

Post

/V1.14/servers

Delete

/V1.14/servers/{server_id}

Get Servers

Description This API returns the list of Wireless Manager servers added to the customer account of
the logged in user in Guest Manager.Guest Manager users with the Administrator role can access this API.
Syntax
GET <Base_URL>/servers
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/servers
Request Body This API call does not require any request body parameters.
Response Body If successful, the API call returns the list of servers in the response body.
The response is in the application/json format.

Get Server

Description This API returns the details of an Wireless Manager server added to the customer account of the
logged in user in Guest Manager.Guest Manager users with the Administrator role can access this API.
Syntax
GET <Base_URL>/servers/{server_id}
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/servers/1
Request Body This API call does not require any request body parameters.
Response Body If successful, the API call returns the list of servers in the response body.
The response is in the application/json format.

Get Server Sync Status

Description This API fetches the status of the analytics data sync across all Wireless Manager servers added to the customer account of the logged in Guest Manager user.
Guest Manager users with the Administrator role can access this API.
Syntax
GET <Base_URL>/analytics/sync/status
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/analytics/sync/status
Request Body This API call does not require any request body parameters.
Response Body The API specifies the overall status of the sync across all servers added to the customer account in Guest Manager. The response is in the application/json format..

Edit A Server

Description This API is used to update the details of an Wireless Manager
server added to the customer account of the logged in user in Guest Manager.
Syntax
PUT <Base_URL>/servers/{server_id}

Here,

  • serverid

    It is the ID of the server whose details you want to update.
Sample code
PUT https://marketverticalanalytics.airtightnw.com/api/v1.14/servers/3
Request Body This API call requires the new details of
the Wireless Manager server to be updated, which is passed as parameters in the request body.
The parameters are passed in the application/json format.
Response Body If successful, the API call returns the updated details of the server in the response body.
The response is in the application/json format.

Start Manual Server Sync

Description This API issues a request for a manual analytics data sync across all Wireless Manager
servers added to the customer account of the logged in Guest Manager user.
Syntax
PUT <Base_URL>/analytics/sync/status
Sample code
GET https://marketverticalanalytics.airtightnw.com/api/v1.14/analytics/sync/status
Request Body This API call does not require any request body parameters.
Response Body The API initiates a manual sync of all servers added to the customer account in Guest Manager.
The API response includes the status of the manual sync.
The response is in application/json format.

Test Server Connection

Description This API is used to check whether the Wireless Manager server is accessible over the network with the provided credentials.
Guest Manager users with the Administrator role can access this API.
Syntax
POST <Base_URL>/portals/servers/testconnection
Sample code
POST https://marketverticalanalytics.airtightnw.com/api/v1.14/servers/testconnection
Request Body This API call requires the details of the Wireless Manager server whose connection has
to be tested, which is passed as parameters in the request body.
The parameters are passed in the application/json format.
Response Body If successful, the API call returns whether the server is accessible and
whether SSO is enabled on the server.
The response is in the application/json format.

Add A Server

Description This API is used to add the details of an Wireless Manager server added to the customer
account of the logged in user in Guest Manager.Guest Manager users with the Administrator role can access this API.
Syntax
POST <Base_URL>/servers
Sample code
POST https://marketverticalanalytics.airtightnw.com/api/v1.14/servers
Request Body This API call requires the details of the Wireless Manager server to be added,
which is passed as parameters in the request body.
The parameters are passed in the application/json format.
Response Body If successful, the API call returns the details of the newly added server in the response body.
The response is in the application/json format.

Delete Server

Description This API is used to remove an Wireless Manager server added to the customer account
of the logged in user in Guest Manager.Guest Manager users with the Administrator role can access this API.
Syntax
DELETE <Base_URL>/servers/{server_id}

Here,

  • serverid

    It is the ID of the server which you want to remove from the customer account in Guest Manager.
Sample code
DELETE https://marketverticalanalytics.airtightnw.com/api/v1.14/servers/4
Request Body This API call does not require any request body parameters.
Response Body If successful, the API call removes the server from the customer account and returns the details of the removed server in the response body. The response is in the application/json format.