OpenWiFi Analytics Service

BoardData

deleteBoardTimepoints

delete board data for a given time period.


/board/{id}/timepoints

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16009/api/v1/board/{id}/timepoints?fromDate=56&endDate=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BoardDataApi;

import java.io.File;
import java.util.*;

public class BoardDataApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        BoardDataApi apiInstance = new BoardDataApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Integer fromDate = 56; // Integer | 
        Integer endDate = 56; // Integer | 

        try {
            apiInstance.deleteBoardTimepoints(id, fromDate, endDate);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardDataApi#deleteBoardTimepoints");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BoardDataApi;

public class BoardDataApiExample {
    public static void main(String[] args) {
        BoardDataApi apiInstance = new BoardDataApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Integer fromDate = 56; // Integer | 
        Integer endDate = 56; // Integer | 

        try {
            apiInstance.deleteBoardTimepoints(id, fromDate, endDate);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardDataApi#deleteBoardTimepoints");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
BoardDataApi *apiInstance = [[BoardDataApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Integer *fromDate = 56; //  (optional) (default to null)
Integer *endDate = 56; //  (optional) (default to null)

// delete board data for a given time period.
[apiInstance deleteBoardTimepointsWith:id
    fromDate:fromDate
    endDate:endDate
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiAnalyticsService = require('open_wi_fi_analytics_service');
var defaultClient = OpenWiFiAnalyticsService.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiAnalyticsService.BoardDataApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'fromDate': 56, // {Integer} 
  'endDate': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteBoardTimepoints(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteBoardTimepointsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BoardDataApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var fromDate = 56;  // Integer |  (optional)  (default to null)
            var endDate = 56;  // Integer |  (optional)  (default to null)

            try {
                // delete board data for a given time period.
                apiInstance.deleteBoardTimepoints(id, fromDate, endDate);
            } catch (Exception e) {
                Debug.Print("Exception when calling BoardDataApi.deleteBoardTimepoints: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BoardDataApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$fromDate = 56; // Integer | 
$endDate = 56; // Integer | 

try {
    $api_instance->deleteBoardTimepoints($id, $fromDate, $endDate);
} catch (Exception $e) {
    echo 'Exception when calling BoardDataApi->deleteBoardTimepoints: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BoardDataApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BoardDataApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $fromDate = 56; # Integer | 
my $endDate = 56; # Integer | 

eval {
    $api_instance->deleteBoardTimepoints(id => $id, fromDate => $fromDate, endDate => $endDate);
};
if ($@) {
    warn "Exception when calling BoardDataApi->deleteBoardTimepoints: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BoardDataApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
fromDate = 56 # Integer |  (optional) (default to null)
endDate = 56 # Integer |  (optional) (default to null)

try:
    # delete board data for a given time period.
    api_instance.delete_board_timepoints(id, fromDate=fromDate, endDate=endDate)
except ApiException as e:
    print("Exception when calling BoardDataApi->deleteBoardTimepoints: %s\n" % e)
extern crate BoardDataApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let fromDate = 56; // Integer
    let endDate = 56; // Integer

    let mut context = BoardDataApi::Context::default();
    let result = client.deleteBoardTimepoints(id, fromDate, endDate, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Required
Query parameters
Name Description
fromDate
Integer
endDate
Integer

Responses


getBoardTimepoint

retrieve board data for a given time period.


/board/{id}/timepoints

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16009/api/v1/board/{id}/timepoints?fromDate=56&endDate=56&maxRecords=56&statsOnly=true&pointsOnly=true&pointsStatsOnly=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BoardDataApi;

import java.io.File;
import java.util.*;

public class BoardDataApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        BoardDataApi apiInstance = new BoardDataApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Integer fromDate = 56; // Integer | 
        Integer endDate = 56; // Integer | 
        Integer maxRecords = 56; // Integer | 
        Boolean statsOnly = true; // Boolean | 
        Boolean pointsOnly = true; // Boolean | 
        Boolean pointsStatsOnly = true; // Boolean | 

        try {
            apiInstance.getBoardTimepoint(id, fromDate, endDate, maxRecords, statsOnly, pointsOnly, pointsStatsOnly);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardDataApi#getBoardTimepoint");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BoardDataApi;

public class BoardDataApiExample {
    public static void main(String[] args) {
        BoardDataApi apiInstance = new BoardDataApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Integer fromDate = 56; // Integer | 
        Integer endDate = 56; // Integer | 
        Integer maxRecords = 56; // Integer | 
        Boolean statsOnly = true; // Boolean | 
        Boolean pointsOnly = true; // Boolean | 
        Boolean pointsStatsOnly = true; // Boolean | 

        try {
            apiInstance.getBoardTimepoint(id, fromDate, endDate, maxRecords, statsOnly, pointsOnly, pointsStatsOnly);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardDataApi#getBoardTimepoint");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
BoardDataApi *apiInstance = [[BoardDataApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Integer *fromDate = 56; //  (optional) (default to null)
Integer *endDate = 56; //  (optional) (default to null)
Integer *maxRecords = 56; //  (optional) (default to 100)
Boolean *statsOnly = true; //  (optional) (default to false)
Boolean *pointsOnly = true; //  (optional) (default to false)
Boolean *pointsStatsOnly = true; //  (optional) (default to false)

// retrieve board data for a given time period.
[apiInstance getBoardTimepointWith:id
    fromDate:fromDate
    endDate:endDate
    maxRecords:maxRecords
    statsOnly:statsOnly
    pointsOnly:pointsOnly
    pointsStatsOnly:pointsStatsOnly
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiAnalyticsService = require('open_wi_fi_analytics_service');
var defaultClient = OpenWiFiAnalyticsService.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiAnalyticsService.BoardDataApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'fromDate': 56, // {Integer} 
  'endDate': 56, // {Integer} 
  'maxRecords': 56, // {Integer} 
  'statsOnly': true, // {Boolean} 
  'pointsOnly': true, // {Boolean} 
  'pointsStatsOnly': true // {Boolean} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getBoardTimepoint(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getBoardTimepointExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BoardDataApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var fromDate = 56;  // Integer |  (optional)  (default to null)
            var endDate = 56;  // Integer |  (optional)  (default to null)
            var maxRecords = 56;  // Integer |  (optional)  (default to 100)
            var statsOnly = true;  // Boolean |  (optional)  (default to false)
            var pointsOnly = true;  // Boolean |  (optional)  (default to false)
            var pointsStatsOnly = true;  // Boolean |  (optional)  (default to false)

            try {
                // retrieve board data for a given time period.
                apiInstance.getBoardTimepoint(id, fromDate, endDate, maxRecords, statsOnly, pointsOnly, pointsStatsOnly);
            } catch (Exception e) {
                Debug.Print("Exception when calling BoardDataApi.getBoardTimepoint: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BoardDataApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$fromDate = 56; // Integer | 
$endDate = 56; // Integer | 
$maxRecords = 56; // Integer | 
$statsOnly = true; // Boolean | 
$pointsOnly = true; // Boolean | 
$pointsStatsOnly = true; // Boolean | 

try {
    $api_instance->getBoardTimepoint($id, $fromDate, $endDate, $maxRecords, $statsOnly, $pointsOnly, $pointsStatsOnly);
} catch (Exception $e) {
    echo 'Exception when calling BoardDataApi->getBoardTimepoint: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BoardDataApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BoardDataApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $fromDate = 56; # Integer | 
my $endDate = 56; # Integer | 
my $maxRecords = 56; # Integer | 
my $statsOnly = true; # Boolean | 
my $pointsOnly = true; # Boolean | 
my $pointsStatsOnly = true; # Boolean | 

eval {
    $api_instance->getBoardTimepoint(id => $id, fromDate => $fromDate, endDate => $endDate, maxRecords => $maxRecords, statsOnly => $statsOnly, pointsOnly => $pointsOnly, pointsStatsOnly => $pointsStatsOnly);
};
if ($@) {
    warn "Exception when calling BoardDataApi->getBoardTimepoint: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BoardDataApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
fromDate = 56 # Integer |  (optional) (default to null)
endDate = 56 # Integer |  (optional) (default to null)
maxRecords = 56 # Integer |  (optional) (default to 100)
statsOnly = true # Boolean |  (optional) (default to false)
pointsOnly = true # Boolean |  (optional) (default to false)
pointsStatsOnly = true # Boolean |  (optional) (default to false)

try:
    # retrieve board data for a given time period.
    api_instance.get_board_timepoint(id, fromDate=fromDate, endDate=endDate, maxRecords=maxRecords, statsOnly=statsOnly, pointsOnly=pointsOnly, pointsStatsOnly=pointsStatsOnly)
except ApiException as e:
    print("Exception when calling BoardDataApi->getBoardTimepoint: %s\n" % e)
extern crate BoardDataApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let fromDate = 56; // Integer
    let endDate = 56; // Integer
    let maxRecords = 56; // Integer
    let statsOnly = true; // Boolean
    let pointsOnly = true; // Boolean
    let pointsStatsOnly = true; // Boolean

    let mut context = BoardDataApi::Context::default();
    let result = client.getBoardTimepoint(id, fromDate, endDate, maxRecords, statsOnly, pointsOnly, pointsStatsOnly, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Required
Query parameters
Name Description
fromDate
Integer
endDate
Integer
maxRecords
Integer
statsOnly
Boolean
pointsOnly
Boolean
pointsStatsOnly
Boolean

Responses


BoardDevices

getBoardDevices

Get basic information about all the devices for a venue.


/board/{id}/devices

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16009/api/v1/board/{id}/devices"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BoardDevicesApi;

import java.io.File;
import java.util.*;

public class BoardDevicesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        BoardDevicesApi apiInstance = new BoardDevicesApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            apiInstance.getBoardDevices(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardDevicesApi#getBoardDevices");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BoardDevicesApi;

public class BoardDevicesApiExample {
    public static void main(String[] args) {
        BoardDevicesApi apiInstance = new BoardDevicesApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            apiInstance.getBoardDevices(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardDevicesApi#getBoardDevices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
BoardDevicesApi *apiInstance = [[BoardDevicesApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Get basic information about all the devices for a venue.
[apiInstance getBoardDevicesWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiAnalyticsService = require('open_wi_fi_analytics_service');
var defaultClient = OpenWiFiAnalyticsService.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiAnalyticsService.BoardDevicesApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getBoardDevices(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getBoardDevicesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BoardDevicesApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Get basic information about all the devices for a venue.
                apiInstance.getBoardDevices(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling BoardDevicesApi.getBoardDevices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BoardDevicesApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

try {
    $api_instance->getBoardDevices($id);
} catch (Exception $e) {
    echo 'Exception when calling BoardDevicesApi->getBoardDevices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BoardDevicesApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BoardDevicesApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->getBoardDevices(id => $id);
};
if ($@) {
    warn "Exception when calling BoardDevicesApi->getBoardDevices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BoardDevicesApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Get basic information about all the devices for a venue.
    api_instance.get_board_devices(id)
except ApiException as e:
    print("Exception when calling BoardDevicesApi->getBoardDevices: %s\n" % e)
extern crate BoardDevicesApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = BoardDevicesApi::Context::default();
    let result = client.getBoardDevices(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Required

Responses


Boards

createBoard

Create a board


/board/{id}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16009/api/v1/board/{id}" \
 -d '{
  "allOf" : {
    "notes" : [ {
      "note" : "note",
      "createdBy" : "createdBy",
      "created" : 0
    }, {
      "note" : "note",
      "createdBy" : "createdBy",
      "created" : 0
    } ],
    "created" : 6,
    "name" : "name",
    "description" : "description",
    "modified" : 1,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "tags" : [ 5, 5 ]
  },
  "venueList" : [ {
    "name" : "name",
    "description" : "description",
    "interval" : 2,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "retention" : 5,
    "monitorSubVenues" : true
  }, {
    "name" : "name",
    "description" : "description",
    "interval" : 2,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "retention" : 5,
    "monitorSubVenues" : true
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BoardsApi;

import java.io.File;
import java.util.*;

public class BoardsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        BoardsApi apiInstance = new BoardsApi();
        UUID id = value should be 0 for a post; // UUID | 
        BoardInfo boardInfo = ; // BoardInfo | 

        try {
            apiInstance.createBoard(id, boardInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardsApi#createBoard");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BoardsApi;

public class BoardsApiExample {
    public static void main(String[] args) {
        BoardsApi apiInstance = new BoardsApi();
        UUID id = value should be 0 for a post; // UUID | 
        BoardInfo boardInfo = ; // BoardInfo | 

        try {
            apiInstance.createBoard(id, boardInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardsApi#createBoard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
BoardsApi *apiInstance = [[BoardsApi alloc] init];
UUID *id = value should be 0 for a post; //  (default to null)
BoardInfo *boardInfo = ; //  (optional)

// Create a board
[apiInstance createBoardWith:id
    boardInfo:boardInfo
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiAnalyticsService = require('open_wi_fi_analytics_service');
var defaultClient = OpenWiFiAnalyticsService.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiAnalyticsService.BoardsApi()
var id = value should be 0 for a post; // {UUID} 
var opts = {
  'boardInfo':  // {BoardInfo} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createBoard(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createBoardExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BoardsApi();
            var id = value should be 0 for a post;  // UUID |  (default to null)
            var boardInfo = new BoardInfo(); // BoardInfo |  (optional) 

            try {
                // Create a board
                apiInstance.createBoard(id, boardInfo);
            } catch (Exception e) {
                Debug.Print("Exception when calling BoardsApi.createBoard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BoardsApi();
$id = value should be 0 for a post; // UUID | 
$boardInfo = ; // BoardInfo | 

try {
    $api_instance->createBoard($id, $boardInfo);
} catch (Exception $e) {
    echo 'Exception when calling BoardsApi->createBoard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BoardsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BoardsApi->new();
my $id = value should be 0 for a post; # UUID | 
my $boardInfo = WWW::OPenAPIClient::Object::BoardInfo->new(); # BoardInfo | 

eval {
    $api_instance->createBoard(id => $id, boardInfo => $boardInfo);
};
if ($@) {
    warn "Exception when calling BoardsApi->createBoard: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BoardsApi()
id = value should be 0 for a post # UUID |  (default to null)
boardInfo =  # BoardInfo |  (optional)

try:
    # Create a board
    api_instance.create_board(id, boardInfo=boardInfo)
except ApiException as e:
    print("Exception when calling BoardsApi->createBoard: %s\n" % e)
extern crate BoardsApi;

pub fn main() {
    let id = value should be 0 for a post; // UUID
    let boardInfo = ; // BoardInfo

    let mut context = BoardsApi::Context::default();
    let result = client.createBoard(id, boardInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Required
Body parameters
Name Description
boardInfo

Responses


deleteBoard

Remove a board


/board/{id}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16009/api/v1/board/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BoardsApi;

import java.io.File;
import java.util.*;

public class BoardsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        BoardsApi apiInstance = new BoardsApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            apiInstance.deleteBoard(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardsApi#deleteBoard");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BoardsApi;

public class BoardsApiExample {
    public static void main(String[] args) {
        BoardsApi apiInstance = new BoardsApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            apiInstance.deleteBoard(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardsApi#deleteBoard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
BoardsApi *apiInstance = [[BoardsApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Remove a board
[apiInstance deleteBoardWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiAnalyticsService = require('open_wi_fi_analytics_service');
var defaultClient = OpenWiFiAnalyticsService.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiAnalyticsService.BoardsApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteBoard(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteBoardExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BoardsApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Remove a board
                apiInstance.deleteBoard(id);
            } catch (Exception e) {
                Debug.Print("Exception when calling BoardsApi.deleteBoard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BoardsApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

try {
    $api_instance->deleteBoard($id);
} catch (Exception $e) {
    echo 'Exception when calling BoardsApi->deleteBoard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BoardsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BoardsApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->deleteBoard(id => $id);
};
if ($@) {
    warn "Exception when calling BoardsApi->deleteBoard: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BoardsApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Remove a board
    api_instance.delete_board(id)
except ApiException as e:
    print("Exception when calling BoardsApi->deleteBoard: %s\n" % e)
extern crate BoardsApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = BoardsApi::Context::default();
    let result = client.deleteBoard(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Required

Responses


getBoard

Retrieve a board


/board/{id}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16009/api/v1/board/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BoardsApi;

import java.io.File;
import java.util.*;

public class BoardsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        BoardsApi apiInstance = new BoardsApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            BoardInfo result = apiInstance.getBoard(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardsApi#getBoard");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BoardsApi;

public class BoardsApiExample {
    public static void main(String[] args) {
        BoardsApi apiInstance = new BoardsApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            BoardInfo result = apiInstance.getBoard(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardsApi#getBoard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
BoardsApi *apiInstance = [[BoardsApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Retrieve a board
[apiInstance getBoardWith:id
              completionHandler: ^(BoardInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiAnalyticsService = require('open_wi_fi_analytics_service');
var defaultClient = OpenWiFiAnalyticsService.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiAnalyticsService.BoardsApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBoard(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getBoardExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BoardsApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Retrieve a board
                BoardInfo result = apiInstance.getBoard(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BoardsApi.getBoard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BoardsApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

try {
    $result = $api_instance->getBoard($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardsApi->getBoard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BoardsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BoardsApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    my $result = $api_instance->getBoard(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BoardsApi->getBoard: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BoardsApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Retrieve a board
    api_response = api_instance.get_board(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BoardsApi->getBoard: %s\n" % e)
extern crate BoardsApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = BoardsApi::Context::default();
    let result = client.getBoard(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Required

Responses


getBoards

Retrieve a list of boards.


/boards

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16009/api/v1/boards?offset=56&limit=56&filter=filter_example&countOnly=true&forVenue=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BoardsApi;

import java.io.File;
import java.util.*;

public class BoardsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        BoardsApi apiInstance = new BoardsApi();
        Integer offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
        Integer limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
        String filter = filter_example; // String | Filter the results
        Boolean countOnly = true; // Boolean | return the number of boards
        UUID forVenue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | list of boards for a given venue

        try {
            BoardInfoList result = apiInstance.getBoards(offset, limit, filter, countOnly, forVenue);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardsApi#getBoards");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BoardsApi;

public class BoardsApiExample {
    public static void main(String[] args) {
        BoardsApi apiInstance = new BoardsApi();
        Integer offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
        Integer limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
        String filter = filter_example; // String | Filter the results
        Boolean countOnly = true; // Boolean | return the number of boards
        UUID forVenue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | list of boards for a given venue

        try {
            BoardInfoList result = apiInstance.getBoards(offset, limit, filter, countOnly, forVenue);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardsApi#getBoards");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
BoardsApi *apiInstance = [[BoardsApi alloc] init];
Integer *offset = 56; // Pagination start (starts at 1. If not specified, 1 is assumed) (optional) (default to null)
Integer *limit = 56; // Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)
String *filter = filter_example; // Filter the results (optional) (default to null)
Boolean *countOnly = true; // return the number of boards (optional) (default to null)
UUID *forVenue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // list of boards for a given venue (optional) (default to null)

// Retrieve a list of boards.
[apiInstance getBoardsWith:offset
    limit:limit
    filter:filter
    countOnly:countOnly
    forVenue:forVenue
              completionHandler: ^(BoardInfoList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiAnalyticsService = require('open_wi_fi_analytics_service');
var defaultClient = OpenWiFiAnalyticsService.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiAnalyticsService.BoardsApi()
var opts = {
  'offset': 56, // {Integer} Pagination start (starts at 1. If not specified, 1 is assumed)
  'limit': 56, // {Integer} Maximum number of entries to return (if absent, no limit is assumed)
  'filter': filter_example, // {String} Filter the results
  'countOnly': true, // {Boolean} return the number of boards
  'forVenue': 38400000-8cf0-11bd-b23e-10b96e4ef00d // {UUID} list of boards for a given venue
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBoards(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getBoardsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BoardsApi();
            var offset = 56;  // Integer | Pagination start (starts at 1. If not specified, 1 is assumed) (optional)  (default to null)
            var limit = 56;  // Integer | Maximum number of entries to return (if absent, no limit is assumed) (optional)  (default to null)
            var filter = filter_example;  // String | Filter the results (optional)  (default to null)
            var countOnly = true;  // Boolean | return the number of boards (optional)  (default to null)
            var forVenue = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | list of boards for a given venue (optional)  (default to null)

            try {
                // Retrieve a list of boards.
                BoardInfoList result = apiInstance.getBoards(offset, limit, filter, countOnly, forVenue);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BoardsApi.getBoards: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BoardsApi();
$offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
$limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
$filter = filter_example; // String | Filter the results
$countOnly = true; // Boolean | return the number of boards
$forVenue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | list of boards for a given venue

try {
    $result = $api_instance->getBoards($offset, $limit, $filter, $countOnly, $forVenue);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BoardsApi->getBoards: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BoardsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BoardsApi->new();
my $offset = 56; # Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
my $limit = 56; # Integer | Maximum number of entries to return (if absent, no limit is assumed)
my $filter = filter_example; # String | Filter the results
my $countOnly = true; # Boolean | return the number of boards
my $forVenue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | list of boards for a given venue

eval {
    my $result = $api_instance->getBoards(offset => $offset, limit => $limit, filter => $filter, countOnly => $countOnly, forVenue => $forVenue);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BoardsApi->getBoards: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BoardsApi()
offset = 56 # Integer | Pagination start (starts at 1. If not specified, 1 is assumed) (optional) (default to null)
limit = 56 # Integer | Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)
filter = filter_example # String | Filter the results (optional) (default to null)
countOnly = true # Boolean | return the number of boards (optional) (default to null)
forVenue = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | list of boards for a given venue (optional) (default to null)

try:
    # Retrieve a list of boards.
    api_response = api_instance.get_boards(offset=offset, limit=limit, filter=filter, countOnly=countOnly, forVenue=forVenue)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BoardsApi->getBoards: %s\n" % e)
extern crate BoardsApi;

pub fn main() {
    let offset = 56; // Integer
    let limit = 56; // Integer
    let filter = filter_example; // String
    let countOnly = true; // Boolean
    let forVenue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = BoardsApi::Context::default();
    let result = client.getBoards(offset, limit, filter, countOnly, forVenue, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
offset
Integer
Pagination start (starts at 1. If not specified, 1 is assumed)
limit
Integer
Maximum number of entries to return (if absent, no limit is assumed)
filter
String
Filter the results
countOnly
Boolean
return the number of boards
forVenue
UUID (uuid)
list of boards for a given venue

Responses


modifyBoard

Modify a board


/board/{id}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16009/api/v1/board/{id}" \
 -d '{
  "allOf" : {
    "notes" : [ {
      "note" : "note",
      "createdBy" : "createdBy",
      "created" : 0
    }, {
      "note" : "note",
      "createdBy" : "createdBy",
      "created" : 0
    } ],
    "created" : 6,
    "name" : "name",
    "description" : "description",
    "modified" : 1,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "tags" : [ 5, 5 ]
  },
  "venueList" : [ {
    "name" : "name",
    "description" : "description",
    "interval" : 2,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "retention" : 5,
    "monitorSubVenues" : true
  }, {
    "name" : "name",
    "description" : "description",
    "interval" : 2,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "retention" : 5,
    "monitorSubVenues" : true
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BoardsApi;

import java.io.File;
import java.util.*;

public class BoardsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        BoardsApi apiInstance = new BoardsApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        BoardInfo boardInfo = ; // BoardInfo | 

        try {
            apiInstance.modifyBoard(id, boardInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardsApi#modifyBoard");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BoardsApi;

public class BoardsApiExample {
    public static void main(String[] args) {
        BoardsApi apiInstance = new BoardsApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        BoardInfo boardInfo = ; // BoardInfo | 

        try {
            apiInstance.modifyBoard(id, boardInfo);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardsApi#modifyBoard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
BoardsApi *apiInstance = [[BoardsApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
BoardInfo *boardInfo = ; //  (optional)

// Modify a board
[apiInstance modifyBoardWith:id
    boardInfo:boardInfo
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiAnalyticsService = require('open_wi_fi_analytics_service');
var defaultClient = OpenWiFiAnalyticsService.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiAnalyticsService.BoardsApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'boardInfo':  // {BoardInfo} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.modifyBoard(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class modifyBoardExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new BoardsApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var boardInfo = new BoardInfo(); // BoardInfo |  (optional) 

            try {
                // Modify a board
                apiInstance.modifyBoard(id, boardInfo);
            } catch (Exception e) {
                Debug.Print("Exception when calling BoardsApi.modifyBoard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BoardsApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$boardInfo = ; // BoardInfo | 

try {
    $api_instance->modifyBoard($id, $boardInfo);
} catch (Exception $e) {
    echo 'Exception when calling BoardsApi->modifyBoard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BoardsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BoardsApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $boardInfo = WWW::OPenAPIClient::Object::BoardInfo->new(); # BoardInfo | 

eval {
    $api_instance->modifyBoard(id => $id, boardInfo => $boardInfo);
};
if ($@) {
    warn "Exception when calling BoardsApi->modifyBoard: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.BoardsApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
boardInfo =  # BoardInfo |  (optional)

try:
    # Modify a board
    api_instance.modify_board(id, boardInfo=boardInfo)
except ApiException as e:
    print("Exception when calling BoardsApi->modifyBoard: %s\n" % e)
extern crate BoardsApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let boardInfo = ; // BoardInfo

    let mut context = BoardsApi::Context::default();
    let result = client.modifyBoard(id, boardInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
UUID (uuid)
Required
Body parameters
Name Description
boardInfo

Responses


SystemCommands

getSystemCommand

Retrieve different values from the running service.


/system

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16009/api/v1/system?command=command_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemCommandsApi;

import java.io.File;
import java.util.*;

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemCommandsApi apiInstance = new SystemCommandsApi();
        String command = command_example; // String | Get a value

        try {
            apiInstance.getSystemCommand(command);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#getSystemCommand");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SystemCommandsApi;

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        SystemCommandsApi apiInstance = new SystemCommandsApi();
        String command = command_example; // String | Get a value

        try {
            apiInstance.getSystemCommand(command);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#getSystemCommand");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemCommandsApi *apiInstance = [[SystemCommandsApi alloc] init];
String *command = command_example; // Get a value (default to null)

// Retrieve different values from the running service.
[apiInstance getSystemCommandWith:command
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiAnalyticsService = require('open_wi_fi_analytics_service');
var defaultClient = OpenWiFiAnalyticsService.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiAnalyticsService.SystemCommandsApi()
var command = command_example; // {String} Get a value

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getSystemCommand(command, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSystemCommandExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemCommandsApi();
            var command = command_example;  // String | Get a value (default to null)

            try {
                // Retrieve different values from the running service.
                apiInstance.getSystemCommand(command);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemCommandsApi.getSystemCommand: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemCommandsApi();
$command = command_example; // String | Get a value

try {
    $api_instance->getSystemCommand($command);
} catch (Exception $e) {
    echo 'Exception when calling SystemCommandsApi->getSystemCommand: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemCommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemCommandsApi->new();
my $command = command_example; # String | Get a value

eval {
    $api_instance->getSystemCommand(command => $command);
};
if ($@) {
    warn "Exception when calling SystemCommandsApi->getSystemCommand: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemCommandsApi()
command = command_example # String | Get a value (default to null)

try:
    # Retrieve different values from the running service.
    api_instance.get_system_command(command)
except ApiException as e:
    print("Exception when calling SystemCommandsApi->getSystemCommand: %s\n" % e)
extern crate SystemCommandsApi;

pub fn main() {
    let command = command_example; // String

    let mut context = SystemCommandsApi::Context::default();
    let result = client.getSystemCommand(command, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
command*
String
Get a value
Required

Responses


systemCommand

Perform some system wide commands.


/system

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16009/api/v1/system" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemCommandsApi;

import java.io.File;
import java.util.*;

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemCommandsApi apiInstance = new SystemCommandsApi();
        SystemCommandRequest systemCommandRequest = ; // SystemCommandRequest | 

        try {
            systemCommand_200_response result = apiInstance.systemCommand(systemCommandRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#systemCommand");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SystemCommandsApi;

public class SystemCommandsApiExample {
    public static void main(String[] args) {
        SystemCommandsApi apiInstance = new SystemCommandsApi();
        SystemCommandRequest systemCommandRequest = ; // SystemCommandRequest | 

        try {
            systemCommand_200_response result = apiInstance.systemCommand(systemCommandRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemCommandsApi#systemCommand");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemCommandsApi *apiInstance = [[SystemCommandsApi alloc] init];
SystemCommandRequest *systemCommandRequest = ; //  (optional)

// Perform some system wide commands.
[apiInstance systemCommandWith:systemCommandRequest
              completionHandler: ^(systemCommand_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiAnalyticsService = require('open_wi_fi_analytics_service');
var defaultClient = OpenWiFiAnalyticsService.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiAnalyticsService.SystemCommandsApi()
var opts = {
  'systemCommandRequest':  // {SystemCommandRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.systemCommand(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class systemCommandExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemCommandsApi();
            var systemCommandRequest = new SystemCommandRequest(); // SystemCommandRequest |  (optional) 

            try {
                // Perform some system wide commands.
                systemCommand_200_response result = apiInstance.systemCommand(systemCommandRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemCommandsApi.systemCommand: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemCommandsApi();
$systemCommandRequest = ; // SystemCommandRequest | 

try {
    $result = $api_instance->systemCommand($systemCommandRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemCommandsApi->systemCommand: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemCommandsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemCommandsApi->new();
my $systemCommandRequest = WWW::OPenAPIClient::Object::SystemCommandRequest->new(); # SystemCommandRequest | 

eval {
    my $result = $api_instance->systemCommand(systemCommandRequest => $systemCommandRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemCommandsApi->systemCommand: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemCommandsApi()
systemCommandRequest =  # SystemCommandRequest |  (optional)

try:
    # Perform some system wide commands.
    api_response = api_instance.system_command(systemCommandRequest=systemCommandRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemCommandsApi->systemCommand: %s\n" % e)
extern crate SystemCommandsApi;

pub fn main() {
    let systemCommandRequest = ; // SystemCommandRequest

    let mut context = SystemCommandsApi::Context::default();
    let result = client.systemCommand(systemCommandRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
systemCommandRequest

Command details

Responses


SystemConfiguration

deleteSystemConfiguration

Delete all additional system configuration


/systemConfiguration

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16009/api/v1/systemConfiguration"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemConfigurationApi;

import java.io.File;
import java.util.*;

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();

        try {
            apiInstance.deleteSystemConfiguration();
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#deleteSystemConfiguration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SystemConfigurationApi;

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();

        try {
            apiInstance.deleteSystemConfiguration();
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#deleteSystemConfiguration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemConfigurationApi *apiInstance = [[SystemConfigurationApi alloc] init];

// Delete all additional system configuration
[apiInstance deleteSystemConfigurationWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiAnalyticsService = require('open_wi_fi_analytics_service');
var defaultClient = OpenWiFiAnalyticsService.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiAnalyticsService.SystemConfigurationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSystemConfiguration(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteSystemConfigurationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemConfigurationApi();

            try {
                // Delete all additional system configuration
                apiInstance.deleteSystemConfiguration();
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemConfigurationApi.deleteSystemConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemConfigurationApi();

try {
    $api_instance->deleteSystemConfiguration();
} catch (Exception $e) {
    echo 'Exception when calling SystemConfigurationApi->deleteSystemConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemConfigurationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemConfigurationApi->new();

eval {
    $api_instance->deleteSystemConfiguration();
};
if ($@) {
    warn "Exception when calling SystemConfigurationApi->deleteSystemConfiguration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemConfigurationApi()

try:
    # Delete all additional system configuration
    api_instance.delete_system_configuration()
except ApiException as e:
    print("Exception when calling SystemConfigurationApi->deleteSystemConfiguration: %s\n" % e)
extern crate SystemConfigurationApi;

pub fn main() {

    let mut context = SystemConfigurationApi::Context::default();
    let result = client.deleteSystemConfiguration(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getSystemConfiguration

Retrieve system configuration items


/systemConfiguration

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16009/api/v1/systemConfiguration?entries=["element1","element1,element2,element3"]"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemConfigurationApi;

import java.io.File;
import java.util.*;

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();
        String entries = ["element1","element1,element2,element3"]; // String | Which parameters you want to retrieve

        try {
            array[List] result = apiInstance.getSystemConfiguration(entries);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#getSystemConfiguration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SystemConfigurationApi;

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();
        String entries = ["element1","element1,element2,element3"]; // String | Which parameters you want to retrieve

        try {
            array[List] result = apiInstance.getSystemConfiguration(entries);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#getSystemConfiguration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemConfigurationApi *apiInstance = [[SystemConfigurationApi alloc] init];
String *entries = ["element1","element1,element2,element3"]; // Which parameters you want to retrieve (optional) (default to null)

// Retrieve system configuration items
[apiInstance getSystemConfigurationWith:entries
              completionHandler: ^(array[List] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiAnalyticsService = require('open_wi_fi_analytics_service');
var defaultClient = OpenWiFiAnalyticsService.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiAnalyticsService.SystemConfigurationApi()
var opts = {
  'entries': ["element1","element1,element2,element3"] // {String} Which parameters you want to retrieve
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSystemConfiguration(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSystemConfigurationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemConfigurationApi();
            var entries = ["element1","element1,element2,element3"];  // String | Which parameters you want to retrieve (optional)  (default to null)

            try {
                // Retrieve system configuration items
                array[List] result = apiInstance.getSystemConfiguration(entries);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemConfigurationApi.getSystemConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemConfigurationApi();
$entries = ["element1","element1,element2,element3"]; // String | Which parameters you want to retrieve

try {
    $result = $api_instance->getSystemConfiguration($entries);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SystemConfigurationApi->getSystemConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemConfigurationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemConfigurationApi->new();
my $entries = ["element1","element1,element2,element3"]; # String | Which parameters you want to retrieve

eval {
    my $result = $api_instance->getSystemConfiguration(entries => $entries);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SystemConfigurationApi->getSystemConfiguration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemConfigurationApi()
entries = ["element1","element1,element2,element3"] # String | Which parameters you want to retrieve (optional) (default to null)

try:
    # Retrieve system configuration items
    api_response = api_instance.get_system_configuration(entries=entries)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SystemConfigurationApi->getSystemConfiguration: %s\n" % e)
extern crate SystemConfigurationApi;

pub fn main() {
    let entries = ["element1","element1,element2,element3"]; // String

    let mut context = SystemConfigurationApi::Context::default();
    let result = client.getSystemConfiguration(entries, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
entries
String
Which parameters you want to retrieve

Responses


setSystemConfiguration

Set some or all system configuration


/systemConfiguration

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16009/api/v1/systemConfiguration" \
 -d '{
  "parameterName" : "parameterName",
  "parameterValue" : "parameterValue"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SystemConfigurationApi;

import java.io.File;
import java.util.*;

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();
        array[ExtraSystemConfiguration_inner] extraSystemConfigurationInner = ; // array[ExtraSystemConfiguration_inner] | 

        try {
            apiInstance.setSystemConfiguration(extraSystemConfigurationInner);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#setSystemConfiguration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SystemConfigurationApi;

public class SystemConfigurationApiExample {
    public static void main(String[] args) {
        SystemConfigurationApi apiInstance = new SystemConfigurationApi();
        array[ExtraSystemConfiguration_inner] extraSystemConfigurationInner = ; // array[ExtraSystemConfiguration_inner] | 

        try {
            apiInstance.setSystemConfiguration(extraSystemConfigurationInner);
        } catch (ApiException e) {
            System.err.println("Exception when calling SystemConfigurationApi#setSystemConfiguration");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SystemConfigurationApi *apiInstance = [[SystemConfigurationApi alloc] init];
array[ExtraSystemConfiguration_inner] *extraSystemConfigurationInner = ; //  (optional)

// Set some or all system configuration
[apiInstance setSystemConfigurationWith:extraSystemConfigurationInner
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiAnalyticsService = require('open_wi_fi_analytics_service');
var defaultClient = OpenWiFiAnalyticsService.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiAnalyticsService.SystemConfigurationApi()
var opts = {
  'extraSystemConfigurationInner':  // {array[ExtraSystemConfiguration_inner]} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setSystemConfiguration(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class setSystemConfigurationExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SystemConfigurationApi();
            var extraSystemConfigurationInner = new array[ExtraSystemConfiguration_inner](); // array[ExtraSystemConfiguration_inner] |  (optional) 

            try {
                // Set some or all system configuration
                apiInstance.setSystemConfiguration(extraSystemConfigurationInner);
            } catch (Exception e) {
                Debug.Print("Exception when calling SystemConfigurationApi.setSystemConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SystemConfigurationApi();
$extraSystemConfigurationInner = ; // array[ExtraSystemConfiguration_inner] | 

try {
    $api_instance->setSystemConfiguration($extraSystemConfigurationInner);
} catch (Exception $e) {
    echo 'Exception when calling SystemConfigurationApi->setSystemConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SystemConfigurationApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SystemConfigurationApi->new();
my $extraSystemConfigurationInner = [WWW::OPenAPIClient::Object::array[ExtraSystemConfiguration_inner]->new()]; # array[ExtraSystemConfiguration_inner] | 

eval {
    $api_instance->setSystemConfiguration(extraSystemConfigurationInner => $extraSystemConfigurationInner);
};
if ($@) {
    warn "Exception when calling SystemConfigurationApi->setSystemConfiguration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SystemConfigurationApi()
extraSystemConfigurationInner =  # array[ExtraSystemConfiguration_inner] |  (optional)

try:
    # Set some or all system configuration
    api_instance.set_system_configuration(extraSystemConfigurationInner=extraSystemConfigurationInner)
except ApiException as e:
    print("Exception when calling SystemConfigurationApi->setSystemConfiguration: %s\n" % e)
extern crate SystemConfigurationApi;

pub fn main() {
    let extraSystemConfigurationInner = ; // array[ExtraSystemConfiguration_inner]

    let mut context = SystemConfigurationApi::Context::default();
    let result = client.setSystemConfiguration(extraSystemConfigurationInner, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
extraSystemConfigurationInner

Responses


WiFiClientHistory

deleteWifiClientHistory

Retrieve WiFi client history for debugging purpose


/wifiClientHistory/{client}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16009/api/v1/wifiClientHistory/{client}?venue=38400000-8cf0-11bd-b23e-10b96e4ef00d&fromDate=56&endDate=56&macFilter=112233445566, 11223344*, *5566"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WiFiClientHistoryApi;

import java.io.File;
import java.util.*;

public class WiFiClientHistoryApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        WiFiClientHistoryApi apiInstance = new WiFiClientHistoryApi();
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The venue to for the search.
        String client = 112233aabbcc; // String | 
        Integer fromDate = 56; // Integer | 
        Integer endDate = 56; // Integer | 
        String macFilter = 112233445566, 11223344*, *5566; // String | Maximum number of entries to return (if absent, no limit is assumed)

        try {
            apiInstance.deleteWifiClientHistory(venue, client, fromDate, endDate, macFilter);
        } catch (ApiException e) {
            System.err.println("Exception when calling WiFiClientHistoryApi#deleteWifiClientHistory");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WiFiClientHistoryApi;

public class WiFiClientHistoryApiExample {
    public static void main(String[] args) {
        WiFiClientHistoryApi apiInstance = new WiFiClientHistoryApi();
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The venue to for the search.
        String client = 112233aabbcc; // String | 
        Integer fromDate = 56; // Integer | 
        Integer endDate = 56; // Integer | 
        String macFilter = 112233445566, 11223344*, *5566; // String | Maximum number of entries to return (if absent, no limit is assumed)

        try {
            apiInstance.deleteWifiClientHistory(venue, client, fromDate, endDate, macFilter);
        } catch (ApiException e) {
            System.err.println("Exception when calling WiFiClientHistoryApi#deleteWifiClientHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
WiFiClientHistoryApi *apiInstance = [[WiFiClientHistoryApi alloc] init];
UUID *venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The venue to for the search. (default to null)
String *client = 112233aabbcc; //  (default to null)
Integer *fromDate = 56; //  (optional) (default to null)
Integer *endDate = 56; //  (optional) (default to null)
String *macFilter = 112233445566, 11223344*, *5566; // Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)

// Retrieve WiFi client history for debugging purpose
[apiInstance deleteWifiClientHistoryWith:venue
    client:client
    fromDate:fromDate
    endDate:endDate
    macFilter:macFilter
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiAnalyticsService = require('open_wi_fi_analytics_service');
var defaultClient = OpenWiFiAnalyticsService.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiAnalyticsService.WiFiClientHistoryApi()
var venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The venue to for the search.
var client = 112233aabbcc; // {String} 
var opts = {
  'fromDate': 56, // {Integer} 
  'endDate': 56, // {Integer} 
  'macFilter': 112233445566, 11223344*, *5566 // {String} Maximum number of entries to return (if absent, no limit is assumed)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteWifiClientHistory(venue, client, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deleteWifiClientHistoryExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new WiFiClientHistoryApi();
            var venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The venue to for the search. (default to null)
            var client = 112233aabbcc;  // String |  (default to null)
            var fromDate = 56;  // Integer |  (optional)  (default to null)
            var endDate = 56;  // Integer |  (optional)  (default to null)
            var macFilter = 112233445566, 11223344*, *5566;  // String | Maximum number of entries to return (if absent, no limit is assumed) (optional)  (default to null)

            try {
                // Retrieve WiFi client history for debugging purpose
                apiInstance.deleteWifiClientHistory(venue, client, fromDate, endDate, macFilter);
            } catch (Exception e) {
                Debug.Print("Exception when calling WiFiClientHistoryApi.deleteWifiClientHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WiFiClientHistoryApi();
$venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The venue to for the search.
$client = 112233aabbcc; // String | 
$fromDate = 56; // Integer | 
$endDate = 56; // Integer | 
$macFilter = 112233445566, 11223344*, *5566; // String | Maximum number of entries to return (if absent, no limit is assumed)

try {
    $api_instance->deleteWifiClientHistory($venue, $client, $fromDate, $endDate, $macFilter);
} catch (Exception $e) {
    echo 'Exception when calling WiFiClientHistoryApi->deleteWifiClientHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WiFiClientHistoryApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WiFiClientHistoryApi->new();
my $venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The venue to for the search.
my $client = 112233aabbcc; # String | 
my $fromDate = 56; # Integer | 
my $endDate = 56; # Integer | 
my $macFilter = 112233445566, 11223344*, *5566; # String | Maximum number of entries to return (if absent, no limit is assumed)

eval {
    $api_instance->deleteWifiClientHistory(venue => $venue, client => $client, fromDate => $fromDate, endDate => $endDate, macFilter => $macFilter);
};
if ($@) {
    warn "Exception when calling WiFiClientHistoryApi->deleteWifiClientHistory: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.WiFiClientHistoryApi()
venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The venue to for the search. (default to null)
client = 112233aabbcc # String |  (default to null)
fromDate = 56 # Integer |  (optional) (default to null)
endDate = 56 # Integer |  (optional) (default to null)
macFilter = 112233445566, 11223344*, *5566 # String | Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)

try:
    # Retrieve WiFi client history for debugging purpose
    api_instance.delete_wifi_client_history(venue, client, fromDate=fromDate, endDate=endDate, macFilter=macFilter)
except ApiException as e:
    print("Exception when calling WiFiClientHistoryApi->deleteWifiClientHistory: %s\n" % e)
extern crate WiFiClientHistoryApi;

pub fn main() {
    let venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let client = 112233aabbcc; // String
    let fromDate = 56; // Integer
    let endDate = 56; // Integer
    let macFilter = 112233445566, 11223344*, *5566; // String

    let mut context = WiFiClientHistoryApi::Context::default();
    let result = client.deleteWifiClientHistory(venue, client, fromDate, endDate, macFilter, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
client*
String
Required
Query parameters
Name Description
venue*
UUID (uuid)
The venue to for the search.
Required
fromDate
Integer
endDate
Integer
macFilter
String
Maximum number of entries to return (if absent, no limit is assumed)

Responses


getWifiClientHistory

Retrieve WiFi client history for debugging purpose


/wifiClientHistory

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16009/api/v1/wifiClientHistory?fromDate=56&endDate=56&offset=56&limit=56&macsOnly=true&macFilter=112233445566, 11223344*, *5566&venue=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WiFiClientHistoryApi;

import java.io.File;
import java.util.*;

public class WiFiClientHistoryApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        WiFiClientHistoryApi apiInstance = new WiFiClientHistoryApi();
        Boolean macsOnly = true; // Boolean | Maximum number of entries to return (if absent, no limit is assumed)
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The venue to for the search.
        Integer fromDate = 56; // Integer | 
        Integer endDate = 56; // Integer | 
        Integer offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
        Integer limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
        String macFilter = 112233445566, 11223344*, *5566; // String | Maximum number of entries to return (if absent, no limit is assumed)

        try {
            apiInstance.getWifiClientHistory(macsOnly, venue, fromDate, endDate, offset, limit, macFilter);
        } catch (ApiException e) {
            System.err.println("Exception when calling WiFiClientHistoryApi#getWifiClientHistory");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WiFiClientHistoryApi;

public class WiFiClientHistoryApiExample {
    public static void main(String[] args) {
        WiFiClientHistoryApi apiInstance = new WiFiClientHistoryApi();
        Boolean macsOnly = true; // Boolean | Maximum number of entries to return (if absent, no limit is assumed)
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The venue to for the search.
        Integer fromDate = 56; // Integer | 
        Integer endDate = 56; // Integer | 
        Integer offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
        Integer limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
        String macFilter = 112233445566, 11223344*, *5566; // String | Maximum number of entries to return (if absent, no limit is assumed)

        try {
            apiInstance.getWifiClientHistory(macsOnly, venue, fromDate, endDate, offset, limit, macFilter);
        } catch (ApiException e) {
            System.err.println("Exception when calling WiFiClientHistoryApi#getWifiClientHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
WiFiClientHistoryApi *apiInstance = [[WiFiClientHistoryApi alloc] init];
Boolean *macsOnly = true; // Maximum number of entries to return (if absent, no limit is assumed) (default to false)
UUID *venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The venue to for the search. (default to null)
Integer *fromDate = 56; //  (optional) (default to null)
Integer *endDate = 56; //  (optional) (default to null)
Integer *offset = 56; // Pagination start (starts at 1. If not specified, 1 is assumed) (optional) (default to null)
Integer *limit = 56; // Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)
String *macFilter = 112233445566, 11223344*, *5566; // Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)

// Retrieve WiFi client history for debugging purpose
[apiInstance getWifiClientHistoryWith:macsOnly
    venue:venue
    fromDate:fromDate
    endDate:endDate
    offset:offset
    limit:limit
    macFilter:macFilter
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiAnalyticsService = require('open_wi_fi_analytics_service');
var defaultClient = OpenWiFiAnalyticsService.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiAnalyticsService.WiFiClientHistoryApi()
var macsOnly = true; // {Boolean} Maximum number of entries to return (if absent, no limit is assumed)
var venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The venue to for the search.
var opts = {
  'fromDate': 56, // {Integer} 
  'endDate': 56, // {Integer} 
  'offset': 56, // {Integer} Pagination start (starts at 1. If not specified, 1 is assumed)
  'limit': 56, // {Integer} Maximum number of entries to return (if absent, no limit is assumed)
  'macFilter': 112233445566, 11223344*, *5566 // {String} Maximum number of entries to return (if absent, no limit is assumed)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getWifiClientHistory(macsOnly, venue, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getWifiClientHistoryExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new WiFiClientHistoryApi();
            var macsOnly = true;  // Boolean | Maximum number of entries to return (if absent, no limit is assumed) (default to false)
            var venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The venue to for the search. (default to null)
            var fromDate = 56;  // Integer |  (optional)  (default to null)
            var endDate = 56;  // Integer |  (optional)  (default to null)
            var offset = 56;  // Integer | Pagination start (starts at 1. If not specified, 1 is assumed) (optional)  (default to null)
            var limit = 56;  // Integer | Maximum number of entries to return (if absent, no limit is assumed) (optional)  (default to null)
            var macFilter = 112233445566, 11223344*, *5566;  // String | Maximum number of entries to return (if absent, no limit is assumed) (optional)  (default to null)

            try {
                // Retrieve WiFi client history for debugging purpose
                apiInstance.getWifiClientHistory(macsOnly, venue, fromDate, endDate, offset, limit, macFilter);
            } catch (Exception e) {
                Debug.Print("Exception when calling WiFiClientHistoryApi.getWifiClientHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WiFiClientHistoryApi();
$macsOnly = true; // Boolean | Maximum number of entries to return (if absent, no limit is assumed)
$venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The venue to for the search.
$fromDate = 56; // Integer | 
$endDate = 56; // Integer | 
$offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
$limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
$macFilter = 112233445566, 11223344*, *5566; // String | Maximum number of entries to return (if absent, no limit is assumed)

try {
    $api_instance->getWifiClientHistory($macsOnly, $venue, $fromDate, $endDate, $offset, $limit, $macFilter);
} catch (Exception $e) {
    echo 'Exception when calling WiFiClientHistoryApi->getWifiClientHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WiFiClientHistoryApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WiFiClientHistoryApi->new();
my $macsOnly = true; # Boolean | Maximum number of entries to return (if absent, no limit is assumed)
my $venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The venue to for the search.
my $fromDate = 56; # Integer | 
my $endDate = 56; # Integer | 
my $offset = 56; # Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
my $limit = 56; # Integer | Maximum number of entries to return (if absent, no limit is assumed)
my $macFilter = 112233445566, 11223344*, *5566; # String | Maximum number of entries to return (if absent, no limit is assumed)

eval {
    $api_instance->getWifiClientHistory(macsOnly => $macsOnly, venue => $venue, fromDate => $fromDate, endDate => $endDate, offset => $offset, limit => $limit, macFilter => $macFilter);
};
if ($@) {
    warn "Exception when calling WiFiClientHistoryApi->getWifiClientHistory: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.WiFiClientHistoryApi()
macsOnly = true # Boolean | Maximum number of entries to return (if absent, no limit is assumed) (default to false)
venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The venue to for the search. (default to null)
fromDate = 56 # Integer |  (optional) (default to null)
endDate = 56 # Integer |  (optional) (default to null)
offset = 56 # Integer | Pagination start (starts at 1. If not specified, 1 is assumed) (optional) (default to null)
limit = 56 # Integer | Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)
macFilter = 112233445566, 11223344*, *5566 # String | Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)

try:
    # Retrieve WiFi client history for debugging purpose
    api_instance.get_wifi_client_history(macsOnly, venue, fromDate=fromDate, endDate=endDate, offset=offset, limit=limit, macFilter=macFilter)
except ApiException as e:
    print("Exception when calling WiFiClientHistoryApi->getWifiClientHistory: %s\n" % e)
extern crate WiFiClientHistoryApi;

pub fn main() {
    let macsOnly = true; // Boolean
    let venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let fromDate = 56; // Integer
    let endDate = 56; // Integer
    let offset = 56; // Integer
    let limit = 56; // Integer
    let macFilter = 112233445566, 11223344*, *5566; // String

    let mut context = WiFiClientHistoryApi::Context::default();
    let result = client.getWifiClientHistory(macsOnly, venue, fromDate, endDate, offset, limit, macFilter, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
fromDate
Integer
endDate
Integer
offset
Integer
Pagination start (starts at 1. If not specified, 1 is assumed)
limit
Integer
Maximum number of entries to return (if absent, no limit is assumed)
macsOnly*
Boolean
Maximum number of entries to return (if absent, no limit is assumed)
Required
macFilter
String
Maximum number of entries to return (if absent, no limit is assumed)
venue*
UUID (uuid)
The venue to for the search.
Required

Responses


getWifiClients

Retrieve WiFi client history for debugging purpose


/wifiClientHistory/{client}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16009/api/v1/wifiClientHistory/{client}?fromDate=56&endDate=56&offset=56&limit=56&venue=38400000-8cf0-11bd-b23e-10b96e4ef00d&orderBy=serialNumber:a,created:d&orderSpec=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WiFiClientHistoryApi;

import java.io.File;
import java.util.*;

public class WiFiClientHistoryApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        // Configure Bearer (JWT) access token for authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        WiFiClientHistoryApi apiInstance = new WiFiClientHistoryApi();
        String client = 112233aabbcc; // String | 
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The venue to for the search.
        Integer fromDate = 56; // Integer | 
        Integer endDate = 56; // Integer | 
        Integer offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
        Integer limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
        String orderBy = serialNumber:a,created:d; // String | return extended information
        Boolean orderSpec = true; // Boolean | return extended information

        try {
            apiInstance.getWifiClients(client, venue, fromDate, endDate, offset, limit, orderBy, orderSpec);
        } catch (ApiException e) {
            System.err.println("Exception when calling WiFiClientHistoryApi#getWifiClients");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.WiFiClientHistoryApi;

public class WiFiClientHistoryApiExample {
    public static void main(String[] args) {
        WiFiClientHistoryApi apiInstance = new WiFiClientHistoryApi();
        String client = 112233aabbcc; // String | 
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The venue to for the search.
        Integer fromDate = 56; // Integer | 
        Integer endDate = 56; // Integer | 
        Integer offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
        Integer limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
        String orderBy = serialNumber:a,created:d; // String | return extended information
        Boolean orderSpec = true; // Boolean | return extended information

        try {
            apiInstance.getWifiClients(client, venue, fromDate, endDate, offset, limit, orderBy, orderSpec);
        } catch (ApiException e) {
            System.err.println("Exception when calling WiFiClientHistoryApi#getWifiClients");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-KEY"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-KEY"];

// Configure Bearer (JWT) access token for authorization: bearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
WiFiClientHistoryApi *apiInstance = [[WiFiClientHistoryApi alloc] init];
String *client = 112233aabbcc; //  (default to null)
UUID *venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The venue to for the search. (default to null)
Integer *fromDate = 56; //  (optional) (default to null)
Integer *endDate = 56; //  (optional) (default to null)
Integer *offset = 56; // Pagination start (starts at 1. If not specified, 1 is assumed) (optional) (default to null)
Integer *limit = 56; // Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)
String *orderBy = serialNumber:a,created:d; // return extended information (optional) (default to null)
Boolean *orderSpec = true; // return extended information (optional) (default to false)

// Retrieve WiFi client history for debugging purpose
[apiInstance getWifiClientsWith:client
    venue:venue
    fromDate:fromDate
    endDate:endDate
    offset:offset
    limit:limit
    orderBy:orderBy
    orderSpec:orderSpec
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiAnalyticsService = require('open_wi_fi_analytics_service');
var defaultClient = OpenWiFiAnalyticsService.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-KEY'] = "Token";

// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new OpenWiFiAnalyticsService.WiFiClientHistoryApi()
var client = 112233aabbcc; // {String} 
var venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The venue to for the search.
var opts = {
  'fromDate': 56, // {Integer} 
  'endDate': 56, // {Integer} 
  'offset': 56, // {Integer} Pagination start (starts at 1. If not specified, 1 is assumed)
  'limit': 56, // {Integer} Maximum number of entries to return (if absent, no limit is assumed)
  'orderBy': serialNumber:a,created:d, // {String} return extended information
  'orderSpec': true // {Boolean} return extended information
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getWifiClients(client, venue, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getWifiClientsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-KEY", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-KEY", "Bearer");
            // Configure Bearer (JWT) access token for authorization: bearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new WiFiClientHistoryApi();
            var client = 112233aabbcc;  // String |  (default to null)
            var venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The venue to for the search. (default to null)
            var fromDate = 56;  // Integer |  (optional)  (default to null)
            var endDate = 56;  // Integer |  (optional)  (default to null)
            var offset = 56;  // Integer | Pagination start (starts at 1. If not specified, 1 is assumed) (optional)  (default to null)
            var limit = 56;  // Integer | Maximum number of entries to return (if absent, no limit is assumed) (optional)  (default to null)
            var orderBy = serialNumber:a,created:d;  // String | return extended information (optional)  (default to null)
            var orderSpec = true;  // Boolean | return extended information (optional)  (default to false)

            try {
                // Retrieve WiFi client history for debugging purpose
                apiInstance.getWifiClients(client, venue, fromDate, endDate, offset, limit, orderBy, orderSpec);
            } catch (Exception e) {
                Debug.Print("Exception when calling WiFiClientHistoryApi.getWifiClients: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure Bearer (JWT) access token for authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\WiFiClientHistoryApi();
$client = 112233aabbcc; // String | 
$venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The venue to for the search.
$fromDate = 56; // Integer | 
$endDate = 56; // Integer | 
$offset = 56; // Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
$limit = 56; // Integer | Maximum number of entries to return (if absent, no limit is assumed)
$orderBy = serialNumber:a,created:d; // String | return extended information
$orderSpec = true; // Boolean | return extended information

try {
    $api_instance->getWifiClients($client, $venue, $fromDate, $endDate, $offset, $limit, $orderBy, $orderSpec);
} catch (Exception $e) {
    echo 'Exception when calling WiFiClientHistoryApi->getWifiClients: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::WiFiClientHistoryApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-KEY'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-KEY'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: bearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::WiFiClientHistoryApi->new();
my $client = 112233aabbcc; # String | 
my $venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The venue to for the search.
my $fromDate = 56; # Integer | 
my $endDate = 56; # Integer | 
my $offset = 56; # Integer | Pagination start (starts at 1. If not specified, 1 is assumed)
my $limit = 56; # Integer | Maximum number of entries to return (if absent, no limit is assumed)
my $orderBy = serialNumber:a,created:d; # String | return extended information
my $orderSpec = true; # Boolean | return extended information

eval {
    $api_instance->getWifiClients(client => $client, venue => $venue, fromDate => $fromDate, endDate => $endDate, offset => $offset, limit => $limit, orderBy => $orderBy, orderSpec => $orderSpec);
};
if ($@) {
    warn "Exception when calling WiFiClientHistoryApi->getWifiClients: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: bearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.WiFiClientHistoryApi()
client = 112233aabbcc # String |  (default to null)
venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The venue to for the search. (default to null)
fromDate = 56 # Integer |  (optional) (default to null)
endDate = 56 # Integer |  (optional) (default to null)
offset = 56 # Integer | Pagination start (starts at 1. If not specified, 1 is assumed) (optional) (default to null)
limit = 56 # Integer | Maximum number of entries to return (if absent, no limit is assumed) (optional) (default to null)
orderBy = serialNumber:a,created:d # String | return extended information (optional) (default to null)
orderSpec = true # Boolean | return extended information (optional) (default to false)

try:
    # Retrieve WiFi client history for debugging purpose
    api_instance.get_wifi_clients(client, venue, fromDate=fromDate, endDate=endDate, offset=offset, limit=limit, orderBy=orderBy, orderSpec=orderSpec)
except ApiException as e:
    print("Exception when calling WiFiClientHistoryApi->getWifiClients: %s\n" % e)
extern crate WiFiClientHistoryApi;

pub fn main() {
    let client = 112233aabbcc; // String
    let venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let fromDate = 56; // Integer
    let endDate = 56; // Integer
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = serialNumber:a,created:d; // String
    let orderSpec = true; // Boolean

    let mut context = WiFiClientHistoryApi::Context::default();
    let result = client.getWifiClients(client, venue, fromDate, endDate, offset, limit, orderBy, orderSpec, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
client*
String
Required
Query parameters
Name Description
fromDate
Integer
endDate
Integer
offset
Integer
Pagination start (starts at 1. If not specified, 1 is assumed)
limit
Integer
Maximum number of entries to return (if absent, no limit is assumed)
venue*
UUID (uuid)
The venue to for the search.
Required
orderBy
String
return extended information
orderSpec
Boolean
return extended information

Responses