OpenWiFi Provisioning Model

ConfigurationOverrides

deleteConfigurationOverrides

delete all configuration overrides for a given device from a given source


/configurationOverrides/{serialNumber}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16005/api/v1/configurationOverrides/{serialNumber}?source=source_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationOverridesApi;

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

public class ConfigurationOverridesApiExample {
    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
        ConfigurationOverridesApi apiInstance = new ConfigurationOverridesApi();
        String serialNumber = serialNumber_example; // String | 
        String source = source_example; // String | 

        try {
            apiInstance.deleteConfigurationOverrides(serialNumber, source);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationOverridesApi#deleteConfigurationOverrides");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConfigurationOverridesApi;

public class ConfigurationOverridesApiExample {
    public static void main(String[] args) {
        ConfigurationOverridesApi apiInstance = new ConfigurationOverridesApi();
        String serialNumber = serialNumber_example; // String | 
        String source = source_example; // String | 

        try {
            apiInstance.deleteConfigurationOverrides(serialNumber, source);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationOverridesApi#deleteConfigurationOverrides");
            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
ConfigurationOverridesApi *apiInstance = [[ConfigurationOverridesApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
String *source = source_example; //  (default to null)

// delete all configuration overrides for a given device from a given source
[apiInstance deleteConfigurationOverridesWith:serialNumber
    source:source
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ConfigurationOverridesApi()
var serialNumber = serialNumber_example; // {String} 
var source = source_example; // {String} 

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

namespace Example
{
    public class deleteConfigurationOverridesExample
    {
        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 ConfigurationOverridesApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var source = source_example;  // String |  (default to null)

            try {
                // delete all configuration overrides for a given device from a given source
                apiInstance.deleteConfigurationOverrides(serialNumber, source);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationOverridesApi.deleteConfigurationOverrides: " + 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\ConfigurationOverridesApi();
$serialNumber = serialNumber_example; // String | 
$source = source_example; // String | 

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

# 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::ConfigurationOverridesApi->new();
my $serialNumber = serialNumber_example; # String | 
my $source = source_example; # String | 

eval {
    $api_instance->deleteConfigurationOverrides(serialNumber => $serialNumber, source => $source);
};
if ($@) {
    warn "Exception when calling ConfigurationOverridesApi->deleteConfigurationOverrides: $@\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.ConfigurationOverridesApi()
serialNumber = serialNumber_example # String |  (default to null)
source = source_example # String |  (default to null)

try:
    # delete all configuration overrides for a given device from a given source
    api_instance.delete_configuration_overrides(serialNumber, source)
except ApiException as e:
    print("Exception when calling ConfigurationOverridesApi->deleteConfigurationOverrides: %s\n" % e)
extern crate ConfigurationOverridesApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let source = source_example; // String

    let mut context = ConfigurationOverridesApi::Context::default();
    let result = client.deleteConfigurationOverrides(serialNumber, source, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Query parameters
Name Description
source*
String
Required

Responses


getConfigurationOverrides

retrieve a list of configuration overrides for a given device


/configurationOverrides/{serialNumber}

Usage and SDK Samples

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

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

public class ConfigurationOverridesApiExample {
    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
        ConfigurationOverridesApi apiInstance = new ConfigurationOverridesApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            ConfigurationOverrideList result = apiInstance.getConfigurationOverrides(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationOverridesApi#getConfigurationOverrides");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConfigurationOverridesApi;

public class ConfigurationOverridesApiExample {
    public static void main(String[] args) {
        ConfigurationOverridesApi apiInstance = new ConfigurationOverridesApi();
        String serialNumber = serialNumber_example; // String | 

        try {
            ConfigurationOverrideList result = apiInstance.getConfigurationOverrides(serialNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationOverridesApi#getConfigurationOverrides");
            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
ConfigurationOverridesApi *apiInstance = [[ConfigurationOverridesApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)

// retrieve a list of configuration overrides for a given device
[apiInstance getConfigurationOverridesWith:serialNumber
              completionHandler: ^(ConfigurationOverrideList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ConfigurationOverridesApi()
var serialNumber = serialNumber_example; // {String} 

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

namespace Example
{
    public class getConfigurationOverridesExample
    {
        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 ConfigurationOverridesApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)

            try {
                // retrieve a list of configuration overrides for a given device
                ConfigurationOverrideList result = apiInstance.getConfigurationOverrides(serialNumber);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationOverridesApi.getConfigurationOverrides: " + 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\ConfigurationOverridesApi();
$serialNumber = serialNumber_example; // String | 

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

# 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::ConfigurationOverridesApi->new();
my $serialNumber = serialNumber_example; # String | 

eval {
    my $result = $api_instance->getConfigurationOverrides(serialNumber => $serialNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationOverridesApi->getConfigurationOverrides: $@\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.ConfigurationOverridesApi()
serialNumber = serialNumber_example # String |  (default to null)

try:
    # retrieve a list of configuration overrides for a given device
    api_response = api_instance.get_configuration_overrides(serialNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationOverridesApi->getConfigurationOverrides: %s\n" % e)
extern crate ConfigurationOverridesApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String

    let mut context = ConfigurationOverridesApi::Context::default();
    let result = client.getConfigurationOverrides(serialNumber, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required

Responses


modifyConfigurationOverrides

modify configuration overrides for a given device for a given source


/configurationOverrides/{serialNumber}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/configurationOverrides/{serialNumber}?source=source_example" \
 -d '{
  "serialNumber" : "serialNumber",
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "overrides" : [ {
    "reason" : "reason",
    "parameterType" : "string",
    "modified" : 0,
    "source" : "source",
    "parameterName" : "parameterName",
    "parameterValue" : "parameterValue"
  }, {
    "reason" : "reason",
    "parameterType" : "string",
    "modified" : 0,
    "source" : "source",
    "parameterName" : "parameterName",
    "parameterValue" : "parameterValue"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationOverridesApi;

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

public class ConfigurationOverridesApiExample {
    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
        ConfigurationOverridesApi apiInstance = new ConfigurationOverridesApi();
        String serialNumber = serialNumber_example; // String | 
        String source = source_example; // String | 
        ConfigurationOverrideList configurationOverrideList = ; // ConfigurationOverrideList | 

        try {
            ConfigurationOverrideList result = apiInstance.modifyConfigurationOverrides(serialNumber, source, configurationOverrideList);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationOverridesApi#modifyConfigurationOverrides");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConfigurationOverridesApi;

public class ConfigurationOverridesApiExample {
    public static void main(String[] args) {
        ConfigurationOverridesApi apiInstance = new ConfigurationOverridesApi();
        String serialNumber = serialNumber_example; // String | 
        String source = source_example; // String | 
        ConfigurationOverrideList configurationOverrideList = ; // ConfigurationOverrideList | 

        try {
            ConfigurationOverrideList result = apiInstance.modifyConfigurationOverrides(serialNumber, source, configurationOverrideList);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationOverridesApi#modifyConfigurationOverrides");
            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
ConfigurationOverridesApi *apiInstance = [[ConfigurationOverridesApi alloc] init];
String *serialNumber = serialNumber_example; //  (default to null)
String *source = source_example; //  (default to null)
ConfigurationOverrideList *configurationOverrideList = ; //  (optional)

// modify configuration overrides for a given device for a given source
[apiInstance modifyConfigurationOverridesWith:serialNumber
    source:source
    configurationOverrideList:configurationOverrideList
              completionHandler: ^(ConfigurationOverrideList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ConfigurationOverridesApi()
var serialNumber = serialNumber_example; // {String} 
var source = source_example; // {String} 
var opts = {
  'configurationOverrideList':  // {ConfigurationOverrideList} 
};

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

namespace Example
{
    public class modifyConfigurationOverridesExample
    {
        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 ConfigurationOverridesApi();
            var serialNumber = serialNumber_example;  // String |  (default to null)
            var source = source_example;  // String |  (default to null)
            var configurationOverrideList = new ConfigurationOverrideList(); // ConfigurationOverrideList |  (optional) 

            try {
                // modify configuration overrides for a given device for a given source
                ConfigurationOverrideList result = apiInstance.modifyConfigurationOverrides(serialNumber, source, configurationOverrideList);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationOverridesApi.modifyConfigurationOverrides: " + 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\ConfigurationOverridesApi();
$serialNumber = serialNumber_example; // String | 
$source = source_example; // String | 
$configurationOverrideList = ; // ConfigurationOverrideList | 

try {
    $result = $api_instance->modifyConfigurationOverrides($serialNumber, $source, $configurationOverrideList);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationOverridesApi->modifyConfigurationOverrides: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConfigurationOverridesApi;

# 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::ConfigurationOverridesApi->new();
my $serialNumber = serialNumber_example; # String | 
my $source = source_example; # String | 
my $configurationOverrideList = WWW::OPenAPIClient::Object::ConfigurationOverrideList->new(); # ConfigurationOverrideList | 

eval {
    my $result = $api_instance->modifyConfigurationOverrides(serialNumber => $serialNumber, source => $source, configurationOverrideList => $configurationOverrideList);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationOverridesApi->modifyConfigurationOverrides: $@\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.ConfigurationOverridesApi()
serialNumber = serialNumber_example # String |  (default to null)
source = source_example # String |  (default to null)
configurationOverrideList =  # ConfigurationOverrideList |  (optional)

try:
    # modify configuration overrides for a given device for a given source
    api_response = api_instance.modify_configuration_overrides(serialNumber, source, configurationOverrideList=configurationOverrideList)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationOverridesApi->modifyConfigurationOverrides: %s\n" % e)
extern crate ConfigurationOverridesApi;

pub fn main() {
    let serialNumber = serialNumber_example; // String
    let source = source_example; // String
    let configurationOverrideList = ; // ConfigurationOverrideList

    let mut context = ConfigurationOverridesApi::Context::default();
    let result = client.modifyConfigurationOverrides(serialNumber, source, configurationOverrideList, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
serialNumber*
String
Required
Body parameters
Name Description
configurationOverrideList

Information used to modify the override list

Query parameters
Name Description
source*
String
Required

Responses


Configurations

createConfiguration

Create a specific configuration.


/configuration/{uuid}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/configuration/{uuid}?validateOnly=true&deviceType=deviceType_example" \
 -d '{
  "subscriberOnly" : false,
  "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 ]
  },
  "venue" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "variables" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "deviceTypes" : [ "deviceTypes", "deviceTypes" ],
  "deviceRules" : {
    "firmwareUpgrade" : "true",
    "rcOnly" : "true",
    "rrm" : "true"
  },
  "subscriber" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "configuration" : [ {
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "weight" : 0
  }, {
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "weight" : 0
  } ],
  "inUse" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationsApi;

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

public class ConfigurationsApiExample {
    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
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean validateOnly = true; // Boolean | 
        String deviceType = deviceType_example; // String | 
        DeviceConfiguration deviceConfiguration = ; // DeviceConfiguration | 

        try {
            apiInstance.createConfiguration(uuid, validateOnly, deviceType, deviceConfiguration);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#createConfiguration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConfigurationsApi;

public class ConfigurationsApiExample {
    public static void main(String[] args) {
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean validateOnly = true; // Boolean | 
        String deviceType = deviceType_example; // String | 
        DeviceConfiguration deviceConfiguration = ; // DeviceConfiguration | 

        try {
            apiInstance.createConfiguration(uuid, validateOnly, deviceType, deviceConfiguration);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#createConfiguration");
            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
ConfigurationsApi *apiInstance = [[ConfigurationsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Boolean *validateOnly = true; //  (optional) (default to null)
String *deviceType = deviceType_example; //  (optional) (default to null)
DeviceConfiguration *deviceConfiguration = ; //  (optional)

// Create a specific configuration.
[apiInstance createConfigurationWith:uuid
    validateOnly:validateOnly
    deviceType:deviceType
    deviceConfiguration:deviceConfiguration
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ConfigurationsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'validateOnly': true, // {Boolean} 
  'deviceType': deviceType_example, // {String} 
  'deviceConfiguration':  // {DeviceConfiguration} 
};

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

namespace Example
{
    public class createConfigurationExample
    {
        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 ConfigurationsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var validateOnly = true;  // Boolean |  (optional)  (default to null)
            var deviceType = deviceType_example;  // String |  (optional)  (default to null)
            var deviceConfiguration = new DeviceConfiguration(); // DeviceConfiguration |  (optional) 

            try {
                // Create a specific configuration.
                apiInstance.createConfiguration(uuid, validateOnly, deviceType, deviceConfiguration);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationsApi.createConfiguration: " + 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\ConfigurationsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$validateOnly = true; // Boolean | 
$deviceType = deviceType_example; // String | 
$deviceConfiguration = ; // DeviceConfiguration | 

try {
    $api_instance->createConfiguration($uuid, $validateOnly, $deviceType, $deviceConfiguration);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationsApi->createConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConfigurationsApi;

# 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::ConfigurationsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $validateOnly = true; # Boolean | 
my $deviceType = deviceType_example; # String | 
my $deviceConfiguration = WWW::OPenAPIClient::Object::DeviceConfiguration->new(); # DeviceConfiguration | 

eval {
    $api_instance->createConfiguration(uuid => $uuid, validateOnly => $validateOnly, deviceType => $deviceType, deviceConfiguration => $deviceConfiguration);
};
if ($@) {
    warn "Exception when calling ConfigurationsApi->createConfiguration: $@\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.ConfigurationsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
validateOnly = true # Boolean |  (optional) (default to null)
deviceType = deviceType_example # String |  (optional) (default to null)
deviceConfiguration =  # DeviceConfiguration |  (optional)

try:
    # Create a specific configuration.
    api_instance.create_configuration(uuid, validateOnly=validateOnly, deviceType=deviceType, deviceConfiguration=deviceConfiguration)
except ApiException as e:
    print("Exception when calling ConfigurationsApi->createConfiguration: %s\n" % e)
extern crate ConfigurationsApi;

pub fn main() {
    let uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let validateOnly = true; // Boolean
    let deviceType = deviceType_example; // String
    let deviceConfiguration = ; // DeviceConfiguration

    let mut context = ConfigurationsApi::Context::default();
    let result = client.createConfiguration(uuid, validateOnly, deviceType, deviceConfiguration, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
deviceConfiguration

Information used to create the new entity

Query parameters
Name Description
validateOnly
Boolean
deviceType
String

Responses


deleteConfiguration

Delete a specific configuration.


/configuration/{uuid}

Usage and SDK Samples

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

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

public class ConfigurationsApiExample {
    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
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

        try {
            apiInstance.deleteConfiguration(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#deleteConfiguration");
            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
ConfigurationsApi *apiInstance = [[ConfigurationsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Delete a specific configuration.
[apiInstance deleteConfigurationWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ConfigurationsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class deleteConfigurationExample
    {
        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 ConfigurationsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Delete a specific configuration.
                apiInstance.deleteConfiguration(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationsApi.deleteConfiguration: " + 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\ConfigurationsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::ConfigurationsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->deleteConfiguration(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling ConfigurationsApi->deleteConfiguration: $@\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.ConfigurationsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Delete a specific configuration.
    api_instance.delete_configuration(uuid)
except ApiException as e:
    print("Exception when calling ConfigurationsApi->deleteConfiguration: %s\n" % e)
extern crate ConfigurationsApi;

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

    let mut context = ConfigurationsApi::Context::default();
    let result = client.deleteConfiguration(uuid, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


geConfiguration

Retrieve a specific configuration.


/configuration/{uuid}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/configuration/{uuid}?expandInUse=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationsApi;

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

public class ConfigurationsApiExample {
    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
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean expandInUse = true; // Boolean | 

        try {
            geConfiguration_200_response result = apiInstance.geConfiguration(uuid, expandInUse);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#geConfiguration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConfigurationsApi;

public class ConfigurationsApiExample {
    public static void main(String[] args) {
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean expandInUse = true; // Boolean | 

        try {
            geConfiguration_200_response result = apiInstance.geConfiguration(uuid, expandInUse);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#geConfiguration");
            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
ConfigurationsApi *apiInstance = [[ConfigurationsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Boolean *expandInUse = true; //  (optional) (default to null)

// Retrieve a specific configuration.
[apiInstance geConfigurationWith:uuid
    expandInUse:expandInUse
              completionHandler: ^(geConfiguration_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ConfigurationsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'expandInUse': true // {Boolean} 
};

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

namespace Example
{
    public class geConfigurationExample
    {
        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 ConfigurationsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var expandInUse = true;  // Boolean |  (optional)  (default to null)

            try {
                // Retrieve a specific configuration.
                geConfiguration_200_response result = apiInstance.geConfiguration(uuid, expandInUse);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationsApi.geConfiguration: " + 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\ConfigurationsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$expandInUse = true; // Boolean | 

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

# 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::ConfigurationsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $expandInUse = true; # Boolean | 

eval {
    my $result = $api_instance->geConfiguration(uuid => $uuid, expandInUse => $expandInUse);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationsApi->geConfiguration: $@\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.ConfigurationsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
expandInUse = true # Boolean |  (optional) (default to null)

try:
    # Retrieve a specific configuration.
    api_response = api_instance.ge_configuration(uuid, expandInUse=expandInUse)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationsApi->geConfiguration: %s\n" % e)
extern crate ConfigurationsApi;

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

    let mut context = ConfigurationsApi::Context::default();
    let result = client.geConfiguration(uuid, expandInUse, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Query parameters
Name Description
expandInUse
Boolean

Responses


getConfigurations

Retrieve a list of configurations.


/configuration

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/configuration?offset=56&limit=56&filter=filter_example&select=serial1,serial2,serial3&countOnly=true&venue=38400000-8cf0-11bd-b23e-10b96e4ef00d&entity=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationsApi;

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

public class ConfigurationsApiExample {
    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
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        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
        String select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
        Boolean countOnly = true; // Boolean | return the number of devices
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UUID entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            getConfigurations_200_response result = apiInstance.getConfigurations(offset, limit, filter, select, countOnly, venue, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#getConfigurations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConfigurationsApi;

public class ConfigurationsApiExample {
    public static void main(String[] args) {
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        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
        String select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
        Boolean countOnly = true; // Boolean | return the number of devices
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UUID entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            getConfigurations_200_response result = apiInstance.getConfigurations(offset, limit, filter, select, countOnly, venue, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#getConfigurations");
            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
ConfigurationsApi *apiInstance = [[ConfigurationsApi 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)
String *select = serial1,serial2,serial3; // Supply a list of devices comma separated (optional) (default to null)
Boolean *countOnly = true; // return the number of devices (optional) (default to null)
UUID *venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (optional) (default to null)
UUID *entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (optional) (default to null)

// Retrieve a list of configurations.
[apiInstance getConfigurationsWith:offset
    limit:limit
    filter:filter
    select:select
    countOnly:countOnly
    venue:venue
    entity:entity
              completionHandler: ^(getConfigurations_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ConfigurationsApi()
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
  'select': serial1,serial2,serial3, // {String} Supply a list of devices comma separated
  'countOnly': true, // {Boolean} return the number of devices
  'venue': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} 
  'entity': 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.getConfigurations(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getConfigurationsExample
    {
        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 ConfigurationsApi();
            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 select = serial1,serial2,serial3;  // String | Supply a list of devices comma separated (optional)  (default to null)
            var countOnly = true;  // Boolean | return the number of devices (optional)  (default to null)
            var venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (optional)  (default to null)
            var entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (optional)  (default to null)

            try {
                // Retrieve a list of configurations.
                getConfigurations_200_response result = apiInstance.getConfigurations(offset, limit, filter, select, countOnly, venue, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationsApi.getConfigurations: " + 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\ConfigurationsApi();
$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
$select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
$countOnly = true; // Boolean | return the number of devices
$venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::ConfigurationsApi->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 $select = serial1,serial2,serial3; # String | Supply a list of devices comma separated
my $countOnly = true; # Boolean | return the number of devices
my $venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    my $result = $api_instance->getConfigurations(offset => $offset, limit => $limit, filter => $filter, select => $select, countOnly => $countOnly, venue => $venue, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationsApi->getConfigurations: $@\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.ConfigurationsApi()
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)
select = serial1,serial2,serial3 # String | Supply a list of devices comma separated (optional) (default to null)
countOnly = true # Boolean | return the number of devices (optional) (default to null)
venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (optional) (default to null)
entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (optional) (default to null)

try:
    # Retrieve a list of configurations.
    api_response = api_instance.get_configurations(offset=offset, limit=limit, filter=filter, select=select, countOnly=countOnly, venue=venue, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationsApi->getConfigurations: %s\n" % e)
extern crate ConfigurationsApi;

pub fn main() {
    let offset = 56; // Integer
    let limit = 56; // Integer
    let filter = filter_example; // String
    let select = serial1,serial2,serial3; // String
    let countOnly = true; // Boolean
    let venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = ConfigurationsApi::Context::default();
    let result = client.getConfigurations(offset, limit, filter, select, countOnly, venue, entity, &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
select
String
Supply a list of devices comma separated
countOnly
Boolean
return the number of devices
venue
UUID (uuid)
entity
UUID (uuid)

Responses


modifyConfiguration

Modify a specific configuration.


/configuration/{uuid}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/configuration/{uuid}?deviceType=deviceType_example" \
 -d '{
  "subscriberOnly" : false,
  "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 ]
  },
  "venue" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "variables" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "deviceTypes" : [ "deviceTypes", "deviceTypes" ],
  "deviceRules" : {
    "firmwareUpgrade" : "true",
    "rcOnly" : "true",
    "rrm" : "true"
  },
  "subscriber" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "configuration" : [ {
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "weight" : 0
  }, {
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "weight" : 0
  } ],
  "inUse" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationsApi;

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

public class ConfigurationsApiExample {
    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
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String deviceType = deviceType_example; // String | 
        DeviceConfiguration deviceConfiguration = ; // DeviceConfiguration | 

        try {
            apiInstance.modifyConfiguration(uuid, deviceType, deviceConfiguration);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#modifyConfiguration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConfigurationsApi;

public class ConfigurationsApiExample {
    public static void main(String[] args) {
        ConfigurationsApi apiInstance = new ConfigurationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String deviceType = deviceType_example; // String | 
        DeviceConfiguration deviceConfiguration = ; // DeviceConfiguration | 

        try {
            apiInstance.modifyConfiguration(uuid, deviceType, deviceConfiguration);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationsApi#modifyConfiguration");
            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
ConfigurationsApi *apiInstance = [[ConfigurationsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
String *deviceType = deviceType_example; //  (optional) (default to null)
DeviceConfiguration *deviceConfiguration = ; //  (optional)

// Modify a specific configuration.
[apiInstance modifyConfigurationWith:uuid
    deviceType:deviceType
    deviceConfiguration:deviceConfiguration
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ConfigurationsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'deviceType': deviceType_example, // {String} 
  'deviceConfiguration':  // {DeviceConfiguration} 
};

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

namespace Example
{
    public class modifyConfigurationExample
    {
        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 ConfigurationsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var deviceType = deviceType_example;  // String |  (optional)  (default to null)
            var deviceConfiguration = new DeviceConfiguration(); // DeviceConfiguration |  (optional) 

            try {
                // Modify a specific configuration.
                apiInstance.modifyConfiguration(uuid, deviceType, deviceConfiguration);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationsApi.modifyConfiguration: " + 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\ConfigurationsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$deviceType = deviceType_example; // String | 
$deviceConfiguration = ; // DeviceConfiguration | 

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

# 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::ConfigurationsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $deviceType = deviceType_example; # String | 
my $deviceConfiguration = WWW::OPenAPIClient::Object::DeviceConfiguration->new(); # DeviceConfiguration | 

eval {
    $api_instance->modifyConfiguration(uuid => $uuid, deviceType => $deviceType, deviceConfiguration => $deviceConfiguration);
};
if ($@) {
    warn "Exception when calling ConfigurationsApi->modifyConfiguration: $@\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.ConfigurationsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
deviceType = deviceType_example # String |  (optional) (default to null)
deviceConfiguration =  # DeviceConfiguration |  (optional)

try:
    # Modify a specific configuration.
    api_instance.modify_configuration(uuid, deviceType=deviceType, deviceConfiguration=deviceConfiguration)
except ApiException as e:
    print("Exception when calling ConfigurationsApi->modifyConfiguration: %s\n" % e)
extern crate ConfigurationsApi;

pub fn main() {
    let uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let deviceType = deviceType_example; // String
    let deviceConfiguration = ; // DeviceConfiguration

    let mut context = ConfigurationsApi::Context::default();
    let result = client.modifyConfiguration(uuid, deviceType, deviceConfiguration, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
deviceConfiguration

Information used to modify the new entity

Query parameters
Name Description
deviceType
String

Responses


Contacts

createContact

Create a specific entity.


/contact/{uuid}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/contact/{uuid}" \
 -d '{
  "firstname" : "firstname",
  "secondaryEmail" : "secondaryEmail",
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "initials" : "initials",
  "phones" : [ "phones", "phones" ],
  "type" : "SUBSCRIBER",
  "title" : "title",
  "lastname" : "lastname",
  "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 ]
  },
  "mobiles" : [ "mobiles", "mobiles" ],
  "inUse" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "visual" : "visual",
  "salutation" : "salutation",
  "primaryEmail" : "primaryEmail",
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "accessPIN" : "accessPIN"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContactsApi;

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

public class ContactsApiExample {
    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
        ContactsApi apiInstance = new ContactsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Contact contact = ; // Contact | 

        try {
            apiInstance.createContact(uuid, contact);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#createContact");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContactsApi;

public class ContactsApiExample {
    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Contact contact = ; // Contact | 

        try {
            apiInstance.createContact(uuid, contact);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#createContact");
            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
ContactsApi *apiInstance = [[ContactsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Contact *contact = ; //  (optional)

// Create a specific entity.
[apiInstance createContactWith:uuid
    contact:contact
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ContactsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'contact':  // {Contact} 
};

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

namespace Example
{
    public class createContactExample
    {
        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 ContactsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var contact = new Contact(); // Contact |  (optional) 

            try {
                // Create a specific entity.
                apiInstance.createContact(uuid, contact);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContactsApi.createContact: " + 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\ContactsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$contact = ; // Contact | 

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

# 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::ContactsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $contact = WWW::OPenAPIClient::Object::Contact->new(); # Contact | 

eval {
    $api_instance->createContact(uuid => $uuid, contact => $contact);
};
if ($@) {
    warn "Exception when calling ContactsApi->createContact: $@\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.ContactsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
contact =  # Contact |  (optional)

try:
    # Create a specific entity.
    api_instance.create_contact(uuid, contact=contact)
except ApiException as e:
    print("Exception when calling ContactsApi->createContact: %s\n" % e)
extern crate ContactsApi;

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

    let mut context = ContactsApi::Context::default();
    let result = client.createContact(uuid, contact, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
contact

Information used to create the new entity

Responses


deleteContact

Delete a specific contact.


/contact/{uuid}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16005/api/v1/contact/{uuid}?force=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContactsApi;

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

public class ContactsApiExample {
    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
        ContactsApi apiInstance = new ContactsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean force = true; // Boolean | 

        try {
            apiInstance.deleteContact(uuid, force);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#deleteContact");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContactsApi;

public class ContactsApiExample {
    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean force = true; // Boolean | 

        try {
            apiInstance.deleteContact(uuid, force);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#deleteContact");
            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
ContactsApi *apiInstance = [[ContactsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Boolean *force = true; //  (default to null)

// Delete a specific contact.
[apiInstance deleteContactWith:uuid
    force:force
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ContactsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var force = true; // {Boolean} 

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

namespace Example
{
    public class deleteContactExample
    {
        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 ContactsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var force = true;  // Boolean |  (default to null)

            try {
                // Delete a specific contact.
                apiInstance.deleteContact(uuid, force);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContactsApi.deleteContact: " + 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\ContactsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$force = true; // Boolean | 

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

# 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::ContactsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $force = true; # Boolean | 

eval {
    $api_instance->deleteContact(uuid => $uuid, force => $force);
};
if ($@) {
    warn "Exception when calling ContactsApi->deleteContact: $@\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.ContactsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
force = true # Boolean |  (default to null)

try:
    # Delete a specific contact.
    api_instance.delete_contact(uuid, force)
except ApiException as e:
    print("Exception when calling ContactsApi->deleteContact: %s\n" % e)
extern crate ContactsApi;

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

    let mut context = ContactsApi::Context::default();
    let result = client.deleteContact(uuid, force, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Query parameters
Name Description
force*
Boolean
Required

Responses


getContact

Retrieve a specific contact.


/contact/{uuid}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/contact/{uuid}?expandInUse=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContactsApi;

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

public class ContactsApiExample {
    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
        ContactsApi apiInstance = new ContactsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean expandInUse = true; // Boolean | 

        try {
            getContact_200_response result = apiInstance.getContact(uuid, expandInUse);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#getContact");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContactsApi;

public class ContactsApiExample {
    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean expandInUse = true; // Boolean | 

        try {
            getContact_200_response result = apiInstance.getContact(uuid, expandInUse);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#getContact");
            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
ContactsApi *apiInstance = [[ContactsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Boolean *expandInUse = true; //  (optional) (default to null)

// Retrieve a specific contact.
[apiInstance getContactWith:uuid
    expandInUse:expandInUse
              completionHandler: ^(getContact_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ContactsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'expandInUse': true // {Boolean} 
};

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

namespace Example
{
    public class getContactExample
    {
        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 ContactsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var expandInUse = true;  // Boolean |  (optional)  (default to null)

            try {
                // Retrieve a specific contact.
                getContact_200_response result = apiInstance.getContact(uuid, expandInUse);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContactsApi.getContact: " + 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\ContactsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$expandInUse = true; // Boolean | 

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

# 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::ContactsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $expandInUse = true; # Boolean | 

eval {
    my $result = $api_instance->getContact(uuid => $uuid, expandInUse => $expandInUse);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsApi->getContact: $@\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.ContactsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
expandInUse = true # Boolean |  (optional) (default to null)

try:
    # Retrieve a specific contact.
    api_response = api_instance.get_contact(uuid, expandInUse=expandInUse)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsApi->getContact: %s\n" % e)
extern crate ContactsApi;

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

    let mut context = ContactsApi::Context::default();
    let result = client.getContact(uuid, expandInUse, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Query parameters
Name Description
expandInUse
Boolean

Responses


getContacts

Retrieve a list of contacts.


/contact

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/contact?offset=56&limit=56&filter=filter_example&select=uuid1,uuid2,uuid3&countOnly=true&uuidOnly=true&venue=38400000-8cf0-11bd-b23e-10b96e4ef00d&entity=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContactsApi;

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

public class ContactsApiExample {
    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
        ContactsApi apiInstance = new ContactsApi();
        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
        String select = uuid1,uuid2,uuid3; // String | Supply a list of contacts comma separated
        Boolean countOnly = true; // Boolean | return the number of contacts
        Boolean uuidOnly = true; // Boolean | return only the UUIDs of contacts
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UUID entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            getContacts_200_response result = apiInstance.getContacts(offset, limit, filter, select, countOnly, uuidOnly, venue, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#getContacts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContactsApi;

public class ContactsApiExample {
    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        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
        String select = uuid1,uuid2,uuid3; // String | Supply a list of contacts comma separated
        Boolean countOnly = true; // Boolean | return the number of contacts
        Boolean uuidOnly = true; // Boolean | return only the UUIDs of contacts
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UUID entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            getContacts_200_response result = apiInstance.getContacts(offset, limit, filter, select, countOnly, uuidOnly, venue, entity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#getContacts");
            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
ContactsApi *apiInstance = [[ContactsApi 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)
String *select = uuid1,uuid2,uuid3; // Supply a list of contacts comma separated (optional) (default to null)
Boolean *countOnly = true; // return the number of contacts (optional) (default to null)
Boolean *uuidOnly = true; // return only the UUIDs of contacts (optional) (default to null)
UUID *venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (optional) (default to null)
UUID *entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (optional) (default to null)

// Retrieve a list of contacts.
[apiInstance getContactsWith:offset
    limit:limit
    filter:filter
    select:select
    countOnly:countOnly
    uuidOnly:uuidOnly
    venue:venue
    entity:entity
              completionHandler: ^(getContacts_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ContactsApi()
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
  'select': uuid1,uuid2,uuid3, // {String} Supply a list of contacts comma separated
  'countOnly': true, // {Boolean} return the number of contacts
  'uuidOnly': true, // {Boolean} return only the UUIDs of contacts
  'venue': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} 
  'entity': 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.getContacts(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getContactsExample
    {
        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 ContactsApi();
            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 select = uuid1,uuid2,uuid3;  // String | Supply a list of contacts comma separated (optional)  (default to null)
            var countOnly = true;  // Boolean | return the number of contacts (optional)  (default to null)
            var uuidOnly = true;  // Boolean | return only the UUIDs of contacts (optional)  (default to null)
            var venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (optional)  (default to null)
            var entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (optional)  (default to null)

            try {
                // Retrieve a list of contacts.
                getContacts_200_response result = apiInstance.getContacts(offset, limit, filter, select, countOnly, uuidOnly, venue, entity);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContactsApi.getContacts: " + 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\ContactsApi();
$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
$select = uuid1,uuid2,uuid3; // String | Supply a list of contacts comma separated
$countOnly = true; // Boolean | return the number of contacts
$uuidOnly = true; // Boolean | return only the UUIDs of contacts
$venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

try {
    $result = $api_instance->getContacts($offset, $limit, $filter, $select, $countOnly, $uuidOnly, $venue, $entity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->getContacts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContactsApi;

# 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::ContactsApi->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 $select = uuid1,uuid2,uuid3; # String | Supply a list of contacts comma separated
my $countOnly = true; # Boolean | return the number of contacts
my $uuidOnly = true; # Boolean | return only the UUIDs of contacts
my $venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    my $result = $api_instance->getContacts(offset => $offset, limit => $limit, filter => $filter, select => $select, countOnly => $countOnly, uuidOnly => $uuidOnly, venue => $venue, entity => $entity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsApi->getContacts: $@\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.ContactsApi()
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)
select = uuid1,uuid2,uuid3 # String | Supply a list of contacts comma separated (optional) (default to null)
countOnly = true # Boolean | return the number of contacts (optional) (default to null)
uuidOnly = true # Boolean | return only the UUIDs of contacts (optional) (default to null)
venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (optional) (default to null)
entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (optional) (default to null)

try:
    # Retrieve a list of contacts.
    api_response = api_instance.get_contacts(offset=offset, limit=limit, filter=filter, select=select, countOnly=countOnly, uuidOnly=uuidOnly, venue=venue, entity=entity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsApi->getContacts: %s\n" % e)
extern crate ContactsApi;

pub fn main() {
    let offset = 56; // Integer
    let limit = 56; // Integer
    let filter = filter_example; // String
    let select = uuid1,uuid2,uuid3; // String
    let countOnly = true; // Boolean
    let uuidOnly = true; // Boolean
    let venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = ContactsApi::Context::default();
    let result = client.getContacts(offset, limit, filter, select, countOnly, uuidOnly, venue, entity, &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
select
String
Supply a list of contacts comma separated
countOnly
Boolean
return the number of contacts
uuidOnly
Boolean
return only the UUIDs of contacts
venue
UUID (uuid)
entity
UUID (uuid)

Responses


modifyContact

Modify a specific contact.


/contact/{uuid}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/contact/{uuid}" \
 -d '{
  "firstname" : "firstname",
  "secondaryEmail" : "secondaryEmail",
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "initials" : "initials",
  "phones" : [ "phones", "phones" ],
  "type" : "SUBSCRIBER",
  "title" : "title",
  "lastname" : "lastname",
  "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 ]
  },
  "mobiles" : [ "mobiles", "mobiles" ],
  "inUse" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "visual" : "visual",
  "salutation" : "salutation",
  "primaryEmail" : "primaryEmail",
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "accessPIN" : "accessPIN"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContactsApi;

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

public class ContactsApiExample {
    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
        ContactsApi apiInstance = new ContactsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Contact contact = ; // Contact | 

        try {
            apiInstance.modifyContact(uuid, contact);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#modifyContact");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContactsApi;

public class ContactsApiExample {
    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Contact contact = ; // Contact | 

        try {
            apiInstance.modifyContact(uuid, contact);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#modifyContact");
            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
ContactsApi *apiInstance = [[ContactsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Contact *contact = ; //  (optional)

// Modify a specific contact.
[apiInstance modifyContactWith:uuid
    contact:contact
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ContactsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'contact':  // {Contact} 
};

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

namespace Example
{
    public class modifyContactExample
    {
        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 ContactsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var contact = new Contact(); // Contact |  (optional) 

            try {
                // Modify a specific contact.
                apiInstance.modifyContact(uuid, contact);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContactsApi.modifyContact: " + 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\ContactsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$contact = ; // Contact | 

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

# 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::ContactsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $contact = WWW::OPenAPIClient::Object::Contact->new(); # Contact | 

eval {
    $api_instance->modifyContact(uuid => $uuid, contact => $contact);
};
if ($@) {
    warn "Exception when calling ContactsApi->modifyContact: $@\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.ContactsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
contact =  # Contact |  (optional)

try:
    # Modify a specific contact.
    api_instance.modify_contact(uuid, contact=contact)
except ApiException as e:
    print("Exception when calling ContactsApi->modifyContact: %s\n" % e)
extern crate ContactsApi;

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

    let mut context = ContactsApi::Context::default();
    let result = client.modifyContact(uuid, contact, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
contact

Information used to modify the new entity

Responses


Dashboards

getDeviceDashboard

Get the last version of the dashboard.


/dashboard

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16005/api/v1/dashboard"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DashboardsApi;

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

public class DashboardsApiExample {
    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
        DashboardsApi apiInstance = new DashboardsApi();

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

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

        try {
            apiInstance.getDeviceDashboard();
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsApi#getDeviceDashboard");
            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
DashboardsApi *apiInstance = [[DashboardsApi alloc] init];

// Get the last version of the dashboard.
[apiInstance getDeviceDashboardWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.DashboardsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getDeviceDashboard(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDeviceDashboardExample
    {
        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 DashboardsApi();

            try {
                // Get the last version of the dashboard.
                apiInstance.getDeviceDashboard();
            } catch (Exception e) {
                Debug.Print("Exception when calling DashboardsApi.getDeviceDashboard: " + 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\DashboardsApi();

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

# 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::DashboardsApi->new();

eval {
    $api_instance->getDeviceDashboard();
};
if ($@) {
    warn "Exception when calling DashboardsApi->getDeviceDashboard: $@\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.DashboardsApi()

try:
    # Get the last version of the dashboard.
    api_instance.get_device_dashboard()
except ApiException as e:
    print("Exception when calling DashboardsApi->getDeviceDashboard: %s\n" % e)
extern crate DashboardsApi;

pub fn main() {

    let mut context = DashboardsApi::Context::default();
    let result = client.getDeviceDashboard(&context).wait();

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

Scopes

Parameters

Responses


Entities

createEntity

Create a specific entity.


/entity/{uuid}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/entity/{uuid}" \
 -d '{
  "parent" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "variables" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "maps" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "devices" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "configurations" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "managementPolicies" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "deviceConfiguration" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : "normal",
  "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 ]
  },
  "deviceRules" : {
    "firmwareUpgrade" : "true",
    "rcOnly" : "true",
    "rrm" : "true"
  },
  "sourceIP" : {
    "list" : [ "list", "list" ]
  },
  "children" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "defaultEntity" : false,
  "venues" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "locations" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "managementRoles" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "contacts" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesApi;

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

public class EntitiesApiExample {
    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
        EntitiesApi apiInstance = new EntitiesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Entity entity = ; // Entity | 

        try {
            apiInstance.createEntity(uuid, entity);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesApi#createEntity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EntitiesApi;

public class EntitiesApiExample {
    public static void main(String[] args) {
        EntitiesApi apiInstance = new EntitiesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Entity entity = ; // Entity | 

        try {
            apiInstance.createEntity(uuid, entity);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesApi#createEntity");
            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
EntitiesApi *apiInstance = [[EntitiesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Entity *entity = ; //  (optional)

// Create a specific entity.
[apiInstance createEntityWith:uuid
    entity:entity
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.EntitiesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'entity':  // {Entity} 
};

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

namespace Example
{
    public class createEntityExample
    {
        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 EntitiesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var entity = new Entity(); // Entity |  (optional) 

            try {
                // Create a specific entity.
                apiInstance.createEntity(uuid, entity);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesApi.createEntity: " + 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\EntitiesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$entity = ; // Entity | 

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

# 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::EntitiesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $entity = WWW::OPenAPIClient::Object::Entity->new(); # Entity | 

eval {
    $api_instance->createEntity(uuid => $uuid, entity => $entity);
};
if ($@) {
    warn "Exception when calling EntitiesApi->createEntity: $@\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.EntitiesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
entity =  # Entity |  (optional)

try:
    # Create a specific entity.
    api_instance.create_entity(uuid, entity=entity)
except ApiException as e:
    print("Exception when calling EntitiesApi->createEntity: %s\n" % e)
extern crate EntitiesApi;

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

    let mut context = EntitiesApi::Context::default();
    let result = client.createEntity(uuid, entity, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
entity

Information used to create the new entity

Responses


deleteEntity

Delete a specific entity.


/entity/{uuid}

Usage and SDK Samples

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

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

public class EntitiesApiExample {
    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
        EntitiesApi apiInstance = new EntitiesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

        try {
            apiInstance.deleteEntity(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesApi#deleteEntity");
            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
EntitiesApi *apiInstance = [[EntitiesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Delete a specific entity.
[apiInstance deleteEntityWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.EntitiesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class deleteEntityExample
    {
        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 EntitiesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Delete a specific entity.
                apiInstance.deleteEntity(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesApi.deleteEntity: " + 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\EntitiesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::EntitiesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->deleteEntity(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling EntitiesApi->deleteEntity: $@\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.EntitiesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Delete a specific entity.
    api_instance.delete_entity(uuid)
except ApiException as e:
    print("Exception when calling EntitiesApi->deleteEntity: %s\n" % e)
extern crate EntitiesApi;

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

    let mut context = EntitiesApi::Context::default();
    let result = client.deleteEntity(uuid, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


getEntities

Retrieve a list of entities.


/entity

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/entity?offset=56&limit=56&filter=filter_example&select=serial1,serial2,serial3&countOnly=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesApi;

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

public class EntitiesApiExample {
    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
        EntitiesApi apiInstance = new EntitiesApi();
        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
        String select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
        Boolean countOnly = true; // Boolean | return the number of devices

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

public class EntitiesApiExample {
    public static void main(String[] args) {
        EntitiesApi apiInstance = new EntitiesApi();
        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
        String select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
        Boolean countOnly = true; // Boolean | return the number of devices

        try {
            getEntities_200_response result = apiInstance.getEntities(offset, limit, filter, select, countOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesApi#getEntities");
            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
EntitiesApi *apiInstance = [[EntitiesApi 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)
String *select = serial1,serial2,serial3; // Supply a list of devices comma separated (optional) (default to null)
Boolean *countOnly = true; // return the number of devices (optional) (default to null)

// Retrieve a list of entities.
[apiInstance getEntitiesWith:offset
    limit:limit
    filter:filter
    select:select
    countOnly:countOnly
              completionHandler: ^(getEntities_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.EntitiesApi()
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
  'select': serial1,serial2,serial3, // {String} Supply a list of devices comma separated
  'countOnly': true // {Boolean} return the number of devices
};

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

namespace Example
{
    public class getEntitiesExample
    {
        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 EntitiesApi();
            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 select = serial1,serial2,serial3;  // String | Supply a list of devices comma separated (optional)  (default to null)
            var countOnly = true;  // Boolean | return the number of devices (optional)  (default to null)

            try {
                // Retrieve a list of entities.
                getEntities_200_response result = apiInstance.getEntities(offset, limit, filter, select, countOnly);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesApi.getEntities: " + 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\EntitiesApi();
$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
$select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
$countOnly = true; // Boolean | return the number of devices

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

# 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::EntitiesApi->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 $select = serial1,serial2,serial3; # String | Supply a list of devices comma separated
my $countOnly = true; # Boolean | return the number of devices

eval {
    my $result = $api_instance->getEntities(offset => $offset, limit => $limit, filter => $filter, select => $select, countOnly => $countOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntitiesApi->getEntities: $@\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.EntitiesApi()
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)
select = serial1,serial2,serial3 # String | Supply a list of devices comma separated (optional) (default to null)
countOnly = true # Boolean | return the number of devices (optional) (default to null)

try:
    # Retrieve a list of entities.
    api_response = api_instance.get_entities(offset=offset, limit=limit, filter=filter, select=select, countOnly=countOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntitiesApi->getEntities: %s\n" % e)
extern crate EntitiesApi;

pub fn main() {
    let offset = 56; // Integer
    let limit = 56; // Integer
    let filter = filter_example; // String
    let select = serial1,serial2,serial3; // String
    let countOnly = true; // Boolean

    let mut context = EntitiesApi::Context::default();
    let result = client.getEntities(offset, limit, filter, select, countOnly, &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
select
String
Supply a list of devices comma separated
countOnly
Boolean
return the number of devices

Responses


getEntity

Retrieve a specific entity.


/entity/{uuid}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16005/api/v1/entity/{uuid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesApi;

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

public class EntitiesApiExample {
    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
        EntitiesApi apiInstance = new EntitiesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

        try {
            apiInstance.getEntity(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesApi#getEntity");
            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
EntitiesApi *apiInstance = [[EntitiesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Retrieve a specific entity.
[apiInstance getEntityWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.EntitiesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class getEntityExample
    {
        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 EntitiesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Retrieve a specific entity.
                apiInstance.getEntity(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesApi.getEntity: " + 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\EntitiesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::EntitiesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->getEntity(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling EntitiesApi->getEntity: $@\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.EntitiesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Retrieve a specific entity.
    api_instance.get_entity(uuid)
except ApiException as e:
    print("Exception when calling EntitiesApi->getEntity: %s\n" % e)
extern crate EntitiesApi;

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

    let mut context = EntitiesApi::Context::default();
    let result = client.getEntity(uuid, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


modifyEntity

Modify a specific entity.


/entity/{uuid}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/entity/{uuid}" \
 -d '{
  "parent" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "variables" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "maps" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "devices" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "configurations" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "managementPolicies" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "deviceConfiguration" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : "normal",
  "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 ]
  },
  "deviceRules" : {
    "firmwareUpgrade" : "true",
    "rcOnly" : "true",
    "rrm" : "true"
  },
  "sourceIP" : {
    "list" : [ "list", "list" ]
  },
  "children" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "defaultEntity" : false,
  "venues" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "locations" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "managementRoles" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "contacts" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntitiesApi;

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

public class EntitiesApiExample {
    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
        EntitiesApi apiInstance = new EntitiesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Entity entity = ; // Entity | 

        try {
            apiInstance.modifyEntity(uuid, entity);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesApi#modifyEntity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EntitiesApi;

public class EntitiesApiExample {
    public static void main(String[] args) {
        EntitiesApi apiInstance = new EntitiesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Entity entity = ; // Entity | 

        try {
            apiInstance.modifyEntity(uuid, entity);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntitiesApi#modifyEntity");
            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
EntitiesApi *apiInstance = [[EntitiesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Entity *entity = ; //  (optional)

// Modify a specific entity.
[apiInstance modifyEntityWith:uuid
    entity:entity
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.EntitiesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'entity':  // {Entity} 
};

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

namespace Example
{
    public class modifyEntityExample
    {
        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 EntitiesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var entity = new Entity(); // Entity |  (optional) 

            try {
                // Modify a specific entity.
                apiInstance.modifyEntity(uuid, entity);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntitiesApi.modifyEntity: " + 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\EntitiesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$entity = ; // Entity | 

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

# 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::EntitiesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $entity = WWW::OPenAPIClient::Object::Entity->new(); # Entity | 

eval {
    $api_instance->modifyEntity(uuid => $uuid, entity => $entity);
};
if ($@) {
    warn "Exception when calling EntitiesApi->modifyEntity: $@\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.EntitiesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
entity =  # Entity |  (optional)

try:
    # Modify a specific entity.
    api_instance.modify_entity(uuid, entity=entity)
except ApiException as e:
    print("Exception when calling EntitiesApi->modifyEntity: %s\n" % e)
extern crate EntitiesApi;

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

    let mut context = EntitiesApi::Context::default();
    let result = client.modifyEntity(uuid, entity, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
entity

Information used to modify the new entity

Responses


Inventory

createInventory

Create a specific Inventory.


/inventory/{serialNumber}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/inventory/{serialNumber}" \
 -d '{
  "deviceType" : "deviceType",
  "venue" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serialNumber" : "serialNumber",
  "subscriber" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "geoCode" : "geoCode",
  "deviceConfiguration" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "devClass" : "any",
  "locale" : "locale",
  "platform" : "AP",
  "connected" : 6,
  "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 ]
  },
  "deviceRules" : {
    "firmwareUpgrade" : "true",
    "rcOnly" : "true",
    "rrm" : "true"
  },
  "qrCode" : "qrCode",
  "contact" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "imported" : 0,
  "location" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "state" : "state",
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InventoryApi;

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

public class InventoryApiExample {
    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
        InventoryApi apiInstance = new InventoryApi();
        UUID serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        InventoryTag inventoryTag = ; // InventoryTag | 

        try {
            apiInstance.createInventory(serialNumber, inventoryTag);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#createInventory");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.InventoryApi;

public class InventoryApiExample {
    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        UUID serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        InventoryTag inventoryTag = ; // InventoryTag | 

        try {
            apiInstance.createInventory(serialNumber, inventoryTag);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#createInventory");
            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
InventoryApi *apiInstance = [[InventoryApi alloc] init];
UUID *serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
InventoryTag *inventoryTag = ; //  (optional)

// Create a specific Inventory.
[apiInstance createInventoryWith:serialNumber
    inventoryTag:inventoryTag
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.InventoryApi()
var serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'inventoryTag':  // {InventoryTag} 
};

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

namespace Example
{
    public class createInventoryExample
    {
        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 InventoryApi();
            var serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var inventoryTag = new InventoryTag(); // InventoryTag |  (optional) 

            try {
                // Create a specific Inventory.
                apiInstance.createInventory(serialNumber, inventoryTag);
            } catch (Exception e) {
                Debug.Print("Exception when calling InventoryApi.createInventory: " + 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\InventoryApi();
$serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$inventoryTag = ; // InventoryTag | 

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

# 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::InventoryApi->new();
my $serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $inventoryTag = WWW::OPenAPIClient::Object::InventoryTag->new(); # InventoryTag | 

eval {
    $api_instance->createInventory(serialNumber => $serialNumber, inventoryTag => $inventoryTag);
};
if ($@) {
    warn "Exception when calling InventoryApi->createInventory: $@\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.InventoryApi()
serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
inventoryTag =  # InventoryTag |  (optional)

try:
    # Create a specific Inventory.
    api_instance.create_inventory(serialNumber, inventoryTag=inventoryTag)
except ApiException as e:
    print("Exception when calling InventoryApi->createInventory: %s\n" % e)
extern crate InventoryApi;

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

    let mut context = InventoryApi::Context::default();
    let result = client.createInventory(serialNumber, inventoryTag, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
serialNumber*
UUID (uuid)
Required
Body parameters
Name Description
inventoryTag

Information used to create the new entity

Responses


deleteInventory

Delete a specific inventory.


/inventory/{serialNumber}

Usage and SDK Samples

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

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

public class InventoryApiExample {
    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
        InventoryApi apiInstance = new InventoryApi();
        UUID serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

        try {
            apiInstance.deleteInventory(serialNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#deleteInventory");
            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
InventoryApi *apiInstance = [[InventoryApi alloc] init];
UUID *serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Delete a specific inventory.
[apiInstance deleteInventoryWith:serialNumber
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.InventoryApi()
var serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class deleteInventoryExample
    {
        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 InventoryApi();
            var serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Delete a specific inventory.
                apiInstance.deleteInventory(serialNumber);
            } catch (Exception e) {
                Debug.Print("Exception when calling InventoryApi.deleteInventory: " + 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\InventoryApi();
$serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::InventoryApi->new();
my $serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->deleteInventory(serialNumber => $serialNumber);
};
if ($@) {
    warn "Exception when calling InventoryApi->deleteInventory: $@\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.InventoryApi()
serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Delete a specific inventory.
    api_instance.delete_inventory(serialNumber)
except ApiException as e:
    print("Exception when calling InventoryApi->deleteInventory: %s\n" % e)
extern crate InventoryApi;

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

    let mut context = InventoryApi::Context::default();
    let result = client.deleteInventory(serialNumber, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
serialNumber*
UUID (uuid)
Required

Responses


getInventory

Retrieve a specific inventory tag.


/inventory/{serialNumber}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/inventory/{serialNumber}?config=true&explain=true&firmwareOptions=true&applyConfiguration=true&subscriberEntity=38400000-8cf0-11bd-b23e-10b96e4ef00d&rrmSettings=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InventoryApi;

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

public class InventoryApiExample {
    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
        InventoryApi apiInstance = new InventoryApi();
        UUID serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean config = true; // Boolean | 
        Boolean explain = true; // Boolean | 
        Boolean firmwareOptions = true; // Boolean | 
        Boolean applyConfiguration = true; // Boolean | 
        UUID subscriberEntity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean rrmSettings = true; // Boolean | return RRM settings for a specific device

        try {
            getInventory_200_response result = apiInstance.getInventory(serialNumber, config, explain, firmwareOptions, applyConfiguration, subscriberEntity, rrmSettings);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#getInventory");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.InventoryApi;

public class InventoryApiExample {
    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        UUID serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean config = true; // Boolean | 
        Boolean explain = true; // Boolean | 
        Boolean firmwareOptions = true; // Boolean | 
        Boolean applyConfiguration = true; // Boolean | 
        UUID subscriberEntity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean rrmSettings = true; // Boolean | return RRM settings for a specific device

        try {
            getInventory_200_response result = apiInstance.getInventory(serialNumber, config, explain, firmwareOptions, applyConfiguration, subscriberEntity, rrmSettings);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#getInventory");
            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
InventoryApi *apiInstance = [[InventoryApi alloc] init];
UUID *serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Boolean *config = true; //  (optional) (default to null)
Boolean *explain = true; //  (optional) (default to null)
Boolean *firmwareOptions = true; //  (optional) (default to null)
Boolean *applyConfiguration = true; //  (optional) (default to null)
UUID *subscriberEntity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (optional) (default to null)
Boolean *rrmSettings = true; // return RRM settings for a specific device (optional) (default to false)

// Retrieve a specific inventory tag.
[apiInstance getInventoryWith:serialNumber
    config:config
    explain:explain
    firmwareOptions:firmwareOptions
    applyConfiguration:applyConfiguration
    subscriberEntity:subscriberEntity
    rrmSettings:rrmSettings
              completionHandler: ^(getInventory_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.InventoryApi()
var serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'config': true, // {Boolean} 
  'explain': true, // {Boolean} 
  'firmwareOptions': true, // {Boolean} 
  'applyConfiguration': true, // {Boolean} 
  'subscriberEntity': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} 
  'rrmSettings': true // {Boolean} return RRM settings for a specific device
};

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

namespace Example
{
    public class getInventoryExample
    {
        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 InventoryApi();
            var serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var config = true;  // Boolean |  (optional)  (default to null)
            var explain = true;  // Boolean |  (optional)  (default to null)
            var firmwareOptions = true;  // Boolean |  (optional)  (default to null)
            var applyConfiguration = true;  // Boolean |  (optional)  (default to null)
            var subscriberEntity = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (optional)  (default to null)
            var rrmSettings = true;  // Boolean | return RRM settings for a specific device (optional)  (default to false)

            try {
                // Retrieve a specific inventory tag.
                getInventory_200_response result = apiInstance.getInventory(serialNumber, config, explain, firmwareOptions, applyConfiguration, subscriberEntity, rrmSettings);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InventoryApi.getInventory: " + 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\InventoryApi();
$serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$config = true; // Boolean | 
$explain = true; // Boolean | 
$firmwareOptions = true; // Boolean | 
$applyConfiguration = true; // Boolean | 
$subscriberEntity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$rrmSettings = true; // Boolean | return RRM settings for a specific device

try {
    $result = $api_instance->getInventory($serialNumber, $config, $explain, $firmwareOptions, $applyConfiguration, $subscriberEntity, $rrmSettings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->getInventory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InventoryApi;

# 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::InventoryApi->new();
my $serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $config = true; # Boolean | 
my $explain = true; # Boolean | 
my $firmwareOptions = true; # Boolean | 
my $applyConfiguration = true; # Boolean | 
my $subscriberEntity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $rrmSettings = true; # Boolean | return RRM settings for a specific device

eval {
    my $result = $api_instance->getInventory(serialNumber => $serialNumber, config => $config, explain => $explain, firmwareOptions => $firmwareOptions, applyConfiguration => $applyConfiguration, subscriberEntity => $subscriberEntity, rrmSettings => $rrmSettings);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InventoryApi->getInventory: $@\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.InventoryApi()
serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
config = true # Boolean |  (optional) (default to null)
explain = true # Boolean |  (optional) (default to null)
firmwareOptions = true # Boolean |  (optional) (default to null)
applyConfiguration = true # Boolean |  (optional) (default to null)
subscriberEntity = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (optional) (default to null)
rrmSettings = true # Boolean | return RRM settings for a specific device (optional) (default to false)

try:
    # Retrieve a specific inventory tag.
    api_response = api_instance.get_inventory(serialNumber, config=config, explain=explain, firmwareOptions=firmwareOptions, applyConfiguration=applyConfiguration, subscriberEntity=subscriberEntity, rrmSettings=rrmSettings)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryApi->getInventory: %s\n" % e)
extern crate InventoryApi;

pub fn main() {
    let serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let config = true; // Boolean
    let explain = true; // Boolean
    let firmwareOptions = true; // Boolean
    let applyConfiguration = true; // Boolean
    let subscriberEntity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let rrmSettings = true; // Boolean

    let mut context = InventoryApi::Context::default();
    let result = client.getInventory(serialNumber, config, explain, firmwareOptions, applyConfiguration, subscriberEntity, rrmSettings, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
serialNumber*
UUID (uuid)
Required
Query parameters
Name Description
config
Boolean
explain
Boolean
firmwareOptions
Boolean
applyConfiguration
Boolean
subscriberEntity
UUID (uuid)
rrmSettings
Boolean
return RRM settings for a specific device

Responses


getInventoryTags

Retrieve a list of inventory.


/inventory

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/inventory?entity=38400000-8cf0-11bd-b23e-10b96e4ef00d&venue=38400000-8cf0-11bd-b23e-10b96e4ef00d&unassigned=true&offset=56&limit=56&filter=filter_example&select=serial1,serial2,serial3&serialOnly=true&countOnly=true&withExtendedInfo=true&orderBy=serialNumber:a,created:d&orderSpec=true&rrmOnly=true&subscriber=38400000-8cf0-11bd-b23e-10b96e4ef00d&resolveConfig=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InventoryApi;

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

public class InventoryApiExample {
    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
        InventoryApi apiInstance = new InventoryApi();
        UUID entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean unassigned = true; // Boolean | 
        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
        String select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
        Boolean serialOnly = true; // Boolean | only serial numbers of full device details
        Boolean countOnly = true; // Boolean | return the number of devices
        Boolean withExtendedInfo = true; // Boolean | return extended information
        String orderBy = serialNumber:a,created:d; // String | return extended information
        Boolean orderSpec = true; // Boolean | return extended information
        Boolean rrmOnly = true; // Boolean | return the list of devices under RRM
        UUID subscriber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | return the list of devices for a subscriber
        Boolean resolveConfig = true; // Boolean | return the resolved configuration for a specific device

        try {
            getInventoryTags_200_response result = apiInstance.getInventoryTags(entity, venue, unassigned, offset, limit, filter, select, serialOnly, countOnly, withExtendedInfo, orderBy, orderSpec, rrmOnly, subscriber, resolveConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#getInventoryTags");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.InventoryApi;

public class InventoryApiExample {
    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        UUID entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean unassigned = true; // Boolean | 
        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
        String select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
        Boolean serialOnly = true; // Boolean | only serial numbers of full device details
        Boolean countOnly = true; // Boolean | return the number of devices
        Boolean withExtendedInfo = true; // Boolean | return extended information
        String orderBy = serialNumber:a,created:d; // String | return extended information
        Boolean orderSpec = true; // Boolean | return extended information
        Boolean rrmOnly = true; // Boolean | return the list of devices under RRM
        UUID subscriber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | return the list of devices for a subscriber
        Boolean resolveConfig = true; // Boolean | return the resolved configuration for a specific device

        try {
            getInventoryTags_200_response result = apiInstance.getInventoryTags(entity, venue, unassigned, offset, limit, filter, select, serialOnly, countOnly, withExtendedInfo, orderBy, orderSpec, rrmOnly, subscriber, resolveConfig);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#getInventoryTags");
            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
InventoryApi *apiInstance = [[InventoryApi alloc] init];
UUID *entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (optional) (default to null)
UUID *venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (optional) (default to null)
Boolean *unassigned = true; //  (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 *filter = filter_example; // Filter the results (optional) (default to null)
String *select = serial1,serial2,serial3; // Supply a list of devices comma separated (optional) (default to null)
Boolean *serialOnly = true; // only serial numbers of full device details (optional) (default to null)
Boolean *countOnly = true; // return the number of devices (optional) (default to null)
Boolean *withExtendedInfo = true; // return extended information (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)
Boolean *rrmOnly = true; // return the list of devices under RRM (optional) (default to false)
UUID *subscriber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // return the list of devices for a subscriber (optional) (default to null)
Boolean *resolveConfig = true; // return the resolved configuration for a specific device (optional) (default to false)

// Retrieve a list of inventory.
[apiInstance getInventoryTagsWith:entity
    venue:venue
    unassigned:unassigned
    offset:offset
    limit:limit
    filter:filter
    select:select
    serialOnly:serialOnly
    countOnly:countOnly
    withExtendedInfo:withExtendedInfo
    orderBy:orderBy
    orderSpec:orderSpec
    rrmOnly:rrmOnly
    subscriber:subscriber
    resolveConfig:resolveConfig
              completionHandler: ^(getInventoryTags_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.InventoryApi()
var opts = {
  'entity': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} 
  'venue': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} 
  'unassigned': true, // {Boolean} 
  '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
  'select': serial1,serial2,serial3, // {String} Supply a list of devices comma separated
  'serialOnly': true, // {Boolean} only serial numbers of full device details
  'countOnly': true, // {Boolean} return the number of devices
  'withExtendedInfo': true, // {Boolean} return extended information
  'orderBy': serialNumber:a,created:d, // {String} return extended information
  'orderSpec': true, // {Boolean} return extended information
  'rrmOnly': true, // {Boolean} return the list of devices under RRM
  'subscriber': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} return the list of devices for a subscriber
  'resolveConfig': true // {Boolean} return the resolved configuration for a specific device
};

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

namespace Example
{
    public class getInventoryTagsExample
    {
        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 InventoryApi();
            var entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (optional)  (default to null)
            var venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (optional)  (default to null)
            var unassigned = true;  // Boolean |  (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 filter = filter_example;  // String | Filter the results (optional)  (default to null)
            var select = serial1,serial2,serial3;  // String | Supply a list of devices comma separated (optional)  (default to null)
            var serialOnly = true;  // Boolean | only serial numbers of full device details (optional)  (default to null)
            var countOnly = true;  // Boolean | return the number of devices (optional)  (default to null)
            var withExtendedInfo = true;  // Boolean | return extended information (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)
            var rrmOnly = true;  // Boolean | return the list of devices under RRM (optional)  (default to false)
            var subscriber = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | return the list of devices for a subscriber (optional)  (default to null)
            var resolveConfig = true;  // Boolean | return the resolved configuration for a specific device (optional)  (default to false)

            try {
                // Retrieve a list of inventory.
                getInventoryTags_200_response result = apiInstance.getInventoryTags(entity, venue, unassigned, offset, limit, filter, select, serialOnly, countOnly, withExtendedInfo, orderBy, orderSpec, rrmOnly, subscriber, resolveConfig);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InventoryApi.getInventoryTags: " + 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\InventoryApi();
$entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$unassigned = true; // Boolean | 
$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
$select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
$serialOnly = true; // Boolean | only serial numbers of full device details
$countOnly = true; // Boolean | return the number of devices
$withExtendedInfo = true; // Boolean | return extended information
$orderBy = serialNumber:a,created:d; // String | return extended information
$orderSpec = true; // Boolean | return extended information
$rrmOnly = true; // Boolean | return the list of devices under RRM
$subscriber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | return the list of devices for a subscriber
$resolveConfig = true; // Boolean | return the resolved configuration for a specific device

try {
    $result = $api_instance->getInventoryTags($entity, $venue, $unassigned, $offset, $limit, $filter, $select, $serialOnly, $countOnly, $withExtendedInfo, $orderBy, $orderSpec, $rrmOnly, $subscriber, $resolveConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->getInventoryTags: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InventoryApi;

# 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::InventoryApi->new();
my $entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $unassigned = true; # Boolean | 
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 $select = serial1,serial2,serial3; # String | Supply a list of devices comma separated
my $serialOnly = true; # Boolean | only serial numbers of full device details
my $countOnly = true; # Boolean | return the number of devices
my $withExtendedInfo = true; # Boolean | return extended information
my $orderBy = serialNumber:a,created:d; # String | return extended information
my $orderSpec = true; # Boolean | return extended information
my $rrmOnly = true; # Boolean | return the list of devices under RRM
my $subscriber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | return the list of devices for a subscriber
my $resolveConfig = true; # Boolean | return the resolved configuration for a specific device

eval {
    my $result = $api_instance->getInventoryTags(entity => $entity, venue => $venue, unassigned => $unassigned, offset => $offset, limit => $limit, filter => $filter, select => $select, serialOnly => $serialOnly, countOnly => $countOnly, withExtendedInfo => $withExtendedInfo, orderBy => $orderBy, orderSpec => $orderSpec, rrmOnly => $rrmOnly, subscriber => $subscriber, resolveConfig => $resolveConfig);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InventoryApi->getInventoryTags: $@\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.InventoryApi()
entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (optional) (default to null)
venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (optional) (default to null)
unassigned = true # Boolean |  (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)
filter = filter_example # String | Filter the results (optional) (default to null)
select = serial1,serial2,serial3 # String | Supply a list of devices comma separated (optional) (default to null)
serialOnly = true # Boolean | only serial numbers of full device details (optional) (default to null)
countOnly = true # Boolean | return the number of devices (optional) (default to null)
withExtendedInfo = true # Boolean | return extended information (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)
rrmOnly = true # Boolean | return the list of devices under RRM (optional) (default to false)
subscriber = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | return the list of devices for a subscriber (optional) (default to null)
resolveConfig = true # Boolean | return the resolved configuration for a specific device (optional) (default to false)

try:
    # Retrieve a list of inventory.
    api_response = api_instance.get_inventory_tags(entity=entity, venue=venue, unassigned=unassigned, offset=offset, limit=limit, filter=filter, select=select, serialOnly=serialOnly, countOnly=countOnly, withExtendedInfo=withExtendedInfo, orderBy=orderBy, orderSpec=orderSpec, rrmOnly=rrmOnly, subscriber=subscriber, resolveConfig=resolveConfig)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryApi->getInventoryTags: %s\n" % e)
extern crate InventoryApi;

pub fn main() {
    let entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let unassigned = true; // Boolean
    let offset = 56; // Integer
    let limit = 56; // Integer
    let filter = filter_example; // String
    let select = serial1,serial2,serial3; // String
    let serialOnly = true; // Boolean
    let countOnly = true; // Boolean
    let withExtendedInfo = true; // Boolean
    let orderBy = serialNumber:a,created:d; // String
    let orderSpec = true; // Boolean
    let rrmOnly = true; // Boolean
    let subscriber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let resolveConfig = true; // Boolean

    let mut context = InventoryApi::Context::default();
    let result = client.getInventoryTags(entity, venue, unassigned, offset, limit, filter, select, serialOnly, countOnly, withExtendedInfo, orderBy, orderSpec, rrmOnly, subscriber, resolveConfig, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
entity
UUID (uuid)
venue
UUID (uuid)
unassigned
Boolean
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
select
String
Supply a list of devices comma separated
serialOnly
Boolean
only serial numbers of full device details
countOnly
Boolean
return the number of devices
withExtendedInfo
Boolean
return extended information
orderBy
String
return extended information
orderSpec
Boolean
return extended information
rrmOnly
Boolean
return the list of devices under RRM
subscriber
UUID (uuid)
return the list of devices for a subscriber
resolveConfig
Boolean
return the resolved configuration for a specific device

Responses


modifyInventory

Modify a specific inventory.


/inventory/{serialNumber}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/inventory/{serialNumber}?unassign=true&removeSubscriber=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "deviceType" : "deviceType",
  "venue" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "serialNumber" : "serialNumber",
  "subscriber" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "geoCode" : "geoCode",
  "deviceConfiguration" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "devClass" : "any",
  "locale" : "locale",
  "platform" : "AP",
  "connected" : 6,
  "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 ]
  },
  "deviceRules" : {
    "firmwareUpgrade" : "true",
    "rcOnly" : "true",
    "rrm" : "true"
  },
  "qrCode" : "qrCode",
  "contact" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "imported" : 0,
  "location" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "state" : "state",
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InventoryApi;

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

public class InventoryApiExample {
    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
        InventoryApi apiInstance = new InventoryApi();
        UUID serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UUID removeSubscriber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean unassign = true; // Boolean | 
        InventoryTag inventoryTag = ; // InventoryTag | 

        try {
            InventoryTag result = apiInstance.modifyInventory(serialNumber, removeSubscriber, unassign, inventoryTag);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#modifyInventory");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.InventoryApi;

public class InventoryApiExample {
    public static void main(String[] args) {
        InventoryApi apiInstance = new InventoryApi();
        UUID serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UUID removeSubscriber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean unassign = true; // Boolean | 
        InventoryTag inventoryTag = ; // InventoryTag | 

        try {
            InventoryTag result = apiInstance.modifyInventory(serialNumber, removeSubscriber, unassign, inventoryTag);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryApi#modifyInventory");
            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
InventoryApi *apiInstance = [[InventoryApi alloc] init];
UUID *serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
UUID *removeSubscriber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Boolean *unassign = true; //  (optional) (default to null)
InventoryTag *inventoryTag = ; //  (optional)

// Modify a specific inventory.
[apiInstance modifyInventoryWith:serialNumber
    removeSubscriber:removeSubscriber
    unassign:unassign
    inventoryTag:inventoryTag
              completionHandler: ^(InventoryTag output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.InventoryApi()
var serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var removeSubscriber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'unassign': true, // {Boolean} 
  'inventoryTag':  // {InventoryTag} 
};

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

namespace Example
{
    public class modifyInventoryExample
    {
        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 InventoryApi();
            var serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var removeSubscriber = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var unassign = true;  // Boolean |  (optional)  (default to null)
            var inventoryTag = new InventoryTag(); // InventoryTag |  (optional) 

            try {
                // Modify a specific inventory.
                InventoryTag result = apiInstance.modifyInventory(serialNumber, removeSubscriber, unassign, inventoryTag);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InventoryApi.modifyInventory: " + 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\InventoryApi();
$serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$removeSubscriber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$unassign = true; // Boolean | 
$inventoryTag = ; // InventoryTag | 

try {
    $result = $api_instance->modifyInventory($serialNumber, $removeSubscriber, $unassign, $inventoryTag);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->modifyInventory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InventoryApi;

# 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::InventoryApi->new();
my $serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $removeSubscriber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $unassign = true; # Boolean | 
my $inventoryTag = WWW::OPenAPIClient::Object::InventoryTag->new(); # InventoryTag | 

eval {
    my $result = $api_instance->modifyInventory(serialNumber => $serialNumber, removeSubscriber => $removeSubscriber, unassign => $unassign, inventoryTag => $inventoryTag);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InventoryApi->modifyInventory: $@\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.InventoryApi()
serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
removeSubscriber = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
unassign = true # Boolean |  (optional) (default to null)
inventoryTag =  # InventoryTag |  (optional)

try:
    # Modify a specific inventory.
    api_response = api_instance.modify_inventory(serialNumber, removeSubscriber, unassign=unassign, inventoryTag=inventoryTag)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryApi->modifyInventory: %s\n" % e)
extern crate InventoryApi;

pub fn main() {
    let serialNumber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let removeSubscriber = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let unassign = true; // Boolean
    let inventoryTag = ; // InventoryTag

    let mut context = InventoryApi::Context::default();
    let result = client.modifyInventory(serialNumber, removeSubscriber, unassign, inventoryTag, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
serialNumber*
UUID (uuid)
Required
Body parameters
Name Description
inventoryTag

Information used to modify the new entity

Query parameters
Name Description
unassign
Boolean
removeSubscriber*
UUID (uuid)
Required

Responses


Locations

createLocation

Create a specific location.


/location/{uuid}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/location/{uuid}" \
 -d '{
  "country" : "country",
  "city" : "city",
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "phones" : [ "phones", "phones" ],
  "geoCode" : "geoCode",
  "type" : "SERVICE",
  "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 ]
  },
  "buildingName" : "buildingName",
  "mobiles" : [ "mobiles", "mobiles" ],
  "inUse" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "addressLines" : [ "addressLines", "addressLines" ],
  "state" : "state",
  "postal" : "postal",
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LocationsApi;

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

public class LocationsApiExample {
    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
        LocationsApi apiInstance = new LocationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Location location = ; // Location | 

        try {
            apiInstance.createLocation(uuid, location);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#createLocation");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LocationsApi;

public class LocationsApiExample {
    public static void main(String[] args) {
        LocationsApi apiInstance = new LocationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Location location = ; // Location | 

        try {
            apiInstance.createLocation(uuid, location);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#createLocation");
            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
LocationsApi *apiInstance = [[LocationsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Location *location = ; //  (optional)

// Create a specific location.
[apiInstance createLocationWith:uuid
    location:location
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.LocationsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'location':  // {Location} 
};

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

namespace Example
{
    public class createLocationExample
    {
        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 LocationsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var location = new Location(); // Location |  (optional) 

            try {
                // Create a specific location.
                apiInstance.createLocation(uuid, location);
            } catch (Exception e) {
                Debug.Print("Exception when calling LocationsApi.createLocation: " + 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\LocationsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$location = ; // Location | 

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

# 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::LocationsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $location = WWW::OPenAPIClient::Object::Location->new(); # Location | 

eval {
    $api_instance->createLocation(uuid => $uuid, location => $location);
};
if ($@) {
    warn "Exception when calling LocationsApi->createLocation: $@\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.LocationsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
location =  # Location |  (optional)

try:
    # Create a specific location.
    api_instance.create_location(uuid, location=location)
except ApiException as e:
    print("Exception when calling LocationsApi->createLocation: %s\n" % e)
extern crate LocationsApi;

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

    let mut context = LocationsApi::Context::default();
    let result = client.createLocation(uuid, location, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
location

Information used to create the new location

Responses


deleteLocation

Delete a specific location.


/location/{uuid}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16005/api/v1/location/{uuid}?force=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LocationsApi;

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

public class LocationsApiExample {
    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
        LocationsApi apiInstance = new LocationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean force = true; // Boolean | 

        try {
            apiInstance.deleteLocation(uuid, force);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#deleteLocation");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LocationsApi;

public class LocationsApiExample {
    public static void main(String[] args) {
        LocationsApi apiInstance = new LocationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean force = true; // Boolean | 

        try {
            apiInstance.deleteLocation(uuid, force);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#deleteLocation");
            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
LocationsApi *apiInstance = [[LocationsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Boolean *force = true; //  (default to null)

// Delete a specific location.
[apiInstance deleteLocationWith:uuid
    force:force
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.LocationsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var force = true; // {Boolean} 

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

namespace Example
{
    public class deleteLocationExample
    {
        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 LocationsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var force = true;  // Boolean |  (default to null)

            try {
                // Delete a specific location.
                apiInstance.deleteLocation(uuid, force);
            } catch (Exception e) {
                Debug.Print("Exception when calling LocationsApi.deleteLocation: " + 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\LocationsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$force = true; // Boolean | 

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

# 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::LocationsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $force = true; # Boolean | 

eval {
    $api_instance->deleteLocation(uuid => $uuid, force => $force);
};
if ($@) {
    warn "Exception when calling LocationsApi->deleteLocation: $@\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.LocationsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
force = true # Boolean |  (default to null)

try:
    # Delete a specific location.
    api_instance.delete_location(uuid, force)
except ApiException as e:
    print("Exception when calling LocationsApi->deleteLocation: %s\n" % e)
extern crate LocationsApi;

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

    let mut context = LocationsApi::Context::default();
    let result = client.deleteLocation(uuid, force, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Query parameters
Name Description
force*
Boolean
Required

Responses


getLocation

Retrieve a specific location.


/location/{uuid}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/location/{uuid}?expandInUse=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LocationsApi;

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

public class LocationsApiExample {
    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
        LocationsApi apiInstance = new LocationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean expandInUse = true; // Boolean | 

        try {
            getLocation_200_response result = apiInstance.getLocation(uuid, expandInUse);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#getLocation");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LocationsApi;

public class LocationsApiExample {
    public static void main(String[] args) {
        LocationsApi apiInstance = new LocationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean expandInUse = true; // Boolean | 

        try {
            getLocation_200_response result = apiInstance.getLocation(uuid, expandInUse);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#getLocation");
            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
LocationsApi *apiInstance = [[LocationsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Boolean *expandInUse = true; //  (optional) (default to null)

// Retrieve a specific location.
[apiInstance getLocationWith:uuid
    expandInUse:expandInUse
              completionHandler: ^(getLocation_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.LocationsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'expandInUse': true // {Boolean} 
};

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

namespace Example
{
    public class getLocationExample
    {
        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 LocationsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var expandInUse = true;  // Boolean |  (optional)  (default to null)

            try {
                // Retrieve a specific location.
                getLocation_200_response result = apiInstance.getLocation(uuid, expandInUse);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LocationsApi.getLocation: " + 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\LocationsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$expandInUse = true; // Boolean | 

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

# 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::LocationsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $expandInUse = true; # Boolean | 

eval {
    my $result = $api_instance->getLocation(uuid => $uuid, expandInUse => $expandInUse);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LocationsApi->getLocation: $@\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.LocationsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
expandInUse = true # Boolean |  (optional) (default to null)

try:
    # Retrieve a specific location.
    api_response = api_instance.get_location(uuid, expandInUse=expandInUse)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocationsApi->getLocation: %s\n" % e)
extern crate LocationsApi;

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

    let mut context = LocationsApi::Context::default();
    let result = client.getLocation(uuid, expandInUse, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Query parameters
Name Description
expandInUse
Boolean

Responses


getLocations

Retrieve a list of locations.


/location

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/location?offset=56&limit=56&filter=filter_example&select=uuid1,uuid2,uuid3&countOnly=true&uuidOnly=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LocationsApi;

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

public class LocationsApiExample {
    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
        LocationsApi apiInstance = new LocationsApi();
        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
        String select = uuid1,uuid2,uuid3; // String | Supply a list of Locations comma separated
        Boolean countOnly = true; // Boolean | return the number of Locations
        Boolean uuidOnly = true; // Boolean | return only the UUIDs of Locations

        try {
            getLocations_200_response result = apiInstance.getLocations(offset, limit, filter, select, countOnly, uuidOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#getLocations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LocationsApi;

public class LocationsApiExample {
    public static void main(String[] args) {
        LocationsApi apiInstance = new LocationsApi();
        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
        String select = uuid1,uuid2,uuid3; // String | Supply a list of Locations comma separated
        Boolean countOnly = true; // Boolean | return the number of Locations
        Boolean uuidOnly = true; // Boolean | return only the UUIDs of Locations

        try {
            getLocations_200_response result = apiInstance.getLocations(offset, limit, filter, select, countOnly, uuidOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#getLocations");
            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
LocationsApi *apiInstance = [[LocationsApi 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)
String *select = uuid1,uuid2,uuid3; // Supply a list of Locations comma separated (optional) (default to null)
Boolean *countOnly = true; // return the number of Locations (optional) (default to null)
Boolean *uuidOnly = true; // return only the UUIDs of Locations (optional) (default to null)

// Retrieve a list of locations.
[apiInstance getLocationsWith:offset
    limit:limit
    filter:filter
    select:select
    countOnly:countOnly
    uuidOnly:uuidOnly
              completionHandler: ^(getLocations_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.LocationsApi()
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
  'select': uuid1,uuid2,uuid3, // {String} Supply a list of Locations comma separated
  'countOnly': true, // {Boolean} return the number of Locations
  'uuidOnly': true // {Boolean} return only the UUIDs of Locations
};

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

namespace Example
{
    public class getLocationsExample
    {
        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 LocationsApi();
            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 select = uuid1,uuid2,uuid3;  // String | Supply a list of Locations comma separated (optional)  (default to null)
            var countOnly = true;  // Boolean | return the number of Locations (optional)  (default to null)
            var uuidOnly = true;  // Boolean | return only the UUIDs of Locations (optional)  (default to null)

            try {
                // Retrieve a list of locations.
                getLocations_200_response result = apiInstance.getLocations(offset, limit, filter, select, countOnly, uuidOnly);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LocationsApi.getLocations: " + 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\LocationsApi();
$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
$select = uuid1,uuid2,uuid3; // String | Supply a list of Locations comma separated
$countOnly = true; // Boolean | return the number of Locations
$uuidOnly = true; // Boolean | return only the UUIDs of Locations

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

# 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::LocationsApi->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 $select = uuid1,uuid2,uuid3; # String | Supply a list of Locations comma separated
my $countOnly = true; # Boolean | return the number of Locations
my $uuidOnly = true; # Boolean | return only the UUIDs of Locations

eval {
    my $result = $api_instance->getLocations(offset => $offset, limit => $limit, filter => $filter, select => $select, countOnly => $countOnly, uuidOnly => $uuidOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LocationsApi->getLocations: $@\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.LocationsApi()
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)
select = uuid1,uuid2,uuid3 # String | Supply a list of Locations comma separated (optional) (default to null)
countOnly = true # Boolean | return the number of Locations (optional) (default to null)
uuidOnly = true # Boolean | return only the UUIDs of Locations (optional) (default to null)

try:
    # Retrieve a list of locations.
    api_response = api_instance.get_locations(offset=offset, limit=limit, filter=filter, select=select, countOnly=countOnly, uuidOnly=uuidOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LocationsApi->getLocations: %s\n" % e)
extern crate LocationsApi;

pub fn main() {
    let offset = 56; // Integer
    let limit = 56; // Integer
    let filter = filter_example; // String
    let select = uuid1,uuid2,uuid3; // String
    let countOnly = true; // Boolean
    let uuidOnly = true; // Boolean

    let mut context = LocationsApi::Context::default();
    let result = client.getLocations(offset, limit, filter, select, countOnly, uuidOnly, &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
select
String
Supply a list of Locations comma separated
countOnly
Boolean
return the number of Locations
uuidOnly
Boolean
return only the UUIDs of Locations

Responses


modifyLocation

Modify a specific location.


/location/{uuid}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/location/{uuid}" \
 -d '{
  "country" : "country",
  "city" : "city",
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "phones" : [ "phones", "phones" ],
  "geoCode" : "geoCode",
  "type" : "SERVICE",
  "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 ]
  },
  "buildingName" : "buildingName",
  "mobiles" : [ "mobiles", "mobiles" ],
  "inUse" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "addressLines" : [ "addressLines", "addressLines" ],
  "state" : "state",
  "postal" : "postal",
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LocationsApi;

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

public class LocationsApiExample {
    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
        LocationsApi apiInstance = new LocationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Location location = ; // Location | 

        try {
            apiInstance.modifyLocation(uuid, location);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#modifyLocation");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LocationsApi;

public class LocationsApiExample {
    public static void main(String[] args) {
        LocationsApi apiInstance = new LocationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Location location = ; // Location | 

        try {
            apiInstance.modifyLocation(uuid, location);
        } catch (ApiException e) {
            System.err.println("Exception when calling LocationsApi#modifyLocation");
            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
LocationsApi *apiInstance = [[LocationsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Location *location = ; //  (optional)

// Modify a specific location.
[apiInstance modifyLocationWith:uuid
    location:location
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.LocationsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'location':  // {Location} 
};

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

namespace Example
{
    public class modifyLocationExample
    {
        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 LocationsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var location = new Location(); // Location |  (optional) 

            try {
                // Modify a specific location.
                apiInstance.modifyLocation(uuid, location);
            } catch (Exception e) {
                Debug.Print("Exception when calling LocationsApi.modifyLocation: " + 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\LocationsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$location = ; // Location | 

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

# 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::LocationsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $location = WWW::OPenAPIClient::Object::Location->new(); # Location | 

eval {
    $api_instance->modifyLocation(uuid => $uuid, location => $location);
};
if ($@) {
    warn "Exception when calling LocationsApi->modifyLocation: $@\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.LocationsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
location =  # Location |  (optional)

try:
    # Modify a specific location.
    api_instance.modify_location(uuid, location=location)
except ApiException as e:
    print("Exception when calling LocationsApi->modifyLocation: %s\n" % e)
extern crate LocationsApi;

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

    let mut context = LocationsApi::Context::default();
    let result = client.modifyLocation(uuid, location, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
location

Information used to modify the new location

Responses


ManagementPolicies

createManagementPolicy

Create a specific policy.


/managementPolicy/{uuid}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/managementPolicy/{uuid}" \
 -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 ]
  },
  "venue" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "entries" : [ {
    "access" : [ "NOACCESS", "NOACCESS" ],
    "resources" : [ "resources", "resources" ],
    "users" : [ "users", "users" ],
    "policy" : "policy"
  }, {
    "access" : [ "NOACCESS", "NOACCESS" ],
    "resources" : [ "resources", "resources" ],
    "users" : [ "users", "users" ],
    "policy" : "policy"
  } ],
  "inUse" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ManagementPoliciesApi;

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

public class ManagementPoliciesApiExample {
    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
        ManagementPoliciesApi apiInstance = new ManagementPoliciesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        ManagementPolicy managementPolicy = ; // ManagementPolicy | 

        try {
            apiInstance.createManagementPolicy(uuid, managementPolicy);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementPoliciesApi#createManagementPolicy");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ManagementPoliciesApi;

public class ManagementPoliciesApiExample {
    public static void main(String[] args) {
        ManagementPoliciesApi apiInstance = new ManagementPoliciesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        ManagementPolicy managementPolicy = ; // ManagementPolicy | 

        try {
            apiInstance.createManagementPolicy(uuid, managementPolicy);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementPoliciesApi#createManagementPolicy");
            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
ManagementPoliciesApi *apiInstance = [[ManagementPoliciesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
ManagementPolicy *managementPolicy = ; //  (optional)

// Create a specific policy.
[apiInstance createManagementPolicyWith:uuid
    managementPolicy:managementPolicy
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ManagementPoliciesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'managementPolicy':  // {ManagementPolicy} 
};

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

namespace Example
{
    public class createManagementPolicyExample
    {
        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 ManagementPoliciesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var managementPolicy = new ManagementPolicy(); // ManagementPolicy |  (optional) 

            try {
                // Create a specific policy.
                apiInstance.createManagementPolicy(uuid, managementPolicy);
            } catch (Exception e) {
                Debug.Print("Exception when calling ManagementPoliciesApi.createManagementPolicy: " + 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\ManagementPoliciesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$managementPolicy = ; // ManagementPolicy | 

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

# 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::ManagementPoliciesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $managementPolicy = WWW::OPenAPIClient::Object::ManagementPolicy->new(); # ManagementPolicy | 

eval {
    $api_instance->createManagementPolicy(uuid => $uuid, managementPolicy => $managementPolicy);
};
if ($@) {
    warn "Exception when calling ManagementPoliciesApi->createManagementPolicy: $@\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.ManagementPoliciesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
managementPolicy =  # ManagementPolicy |  (optional)

try:
    # Create a specific policy.
    api_instance.create_management_policy(uuid, managementPolicy=managementPolicy)
except ApiException as e:
    print("Exception when calling ManagementPoliciesApi->createManagementPolicy: %s\n" % e)
extern crate ManagementPoliciesApi;

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

    let mut context = ManagementPoliciesApi::Context::default();
    let result = client.createManagementPolicy(uuid, managementPolicy, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
managementPolicy

Information used to create the new policy

Responses


deleteManagementPolicy

Delete a specific policy.


/managementPolicy/{uuid}

Usage and SDK Samples

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

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

public class ManagementPoliciesApiExample {
    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
        ManagementPoliciesApi apiInstance = new ManagementPoliciesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

        try {
            apiInstance.deleteManagementPolicy(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementPoliciesApi#deleteManagementPolicy");
            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
ManagementPoliciesApi *apiInstance = [[ManagementPoliciesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Delete a specific policy.
[apiInstance deleteManagementPolicyWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ManagementPoliciesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class deleteManagementPolicyExample
    {
        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 ManagementPoliciesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Delete a specific policy.
                apiInstance.deleteManagementPolicy(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling ManagementPoliciesApi.deleteManagementPolicy: " + 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\ManagementPoliciesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::ManagementPoliciesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->deleteManagementPolicy(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling ManagementPoliciesApi->deleteManagementPolicy: $@\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.ManagementPoliciesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Delete a specific policy.
    api_instance.delete_management_policy(uuid)
except ApiException as e:
    print("Exception when calling ManagementPoliciesApi->deleteManagementPolicy: %s\n" % e)
extern crate ManagementPoliciesApi;

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

    let mut context = ManagementPoliciesApi::Context::default();
    let result = client.deleteManagementPolicy(uuid, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


getManagementPolicy

Retrieve a specific policy.


/managementPolicy/{uuid}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/managementPolicy/{uuid}?expandInUse=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ManagementPoliciesApi;

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

public class ManagementPoliciesApiExample {
    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
        ManagementPoliciesApi apiInstance = new ManagementPoliciesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean expandInUse = true; // Boolean | 

        try {
            getManagementPolicy_200_response result = apiInstance.getManagementPolicy(uuid, expandInUse);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementPoliciesApi#getManagementPolicy");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ManagementPoliciesApi;

public class ManagementPoliciesApiExample {
    public static void main(String[] args) {
        ManagementPoliciesApi apiInstance = new ManagementPoliciesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean expandInUse = true; // Boolean | 

        try {
            getManagementPolicy_200_response result = apiInstance.getManagementPolicy(uuid, expandInUse);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementPoliciesApi#getManagementPolicy");
            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
ManagementPoliciesApi *apiInstance = [[ManagementPoliciesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Boolean *expandInUse = true; //  (optional) (default to null)

// Retrieve a specific policy.
[apiInstance getManagementPolicyWith:uuid
    expandInUse:expandInUse
              completionHandler: ^(getManagementPolicy_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ManagementPoliciesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'expandInUse': true // {Boolean} 
};

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

namespace Example
{
    public class getManagementPolicyExample
    {
        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 ManagementPoliciesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var expandInUse = true;  // Boolean |  (optional)  (default to null)

            try {
                // Retrieve a specific policy.
                getManagementPolicy_200_response result = apiInstance.getManagementPolicy(uuid, expandInUse);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ManagementPoliciesApi.getManagementPolicy: " + 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\ManagementPoliciesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$expandInUse = true; // Boolean | 

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

# 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::ManagementPoliciesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $expandInUse = true; # Boolean | 

eval {
    my $result = $api_instance->getManagementPolicy(uuid => $uuid, expandInUse => $expandInUse);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagementPoliciesApi->getManagementPolicy: $@\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.ManagementPoliciesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
expandInUse = true # Boolean |  (optional) (default to null)

try:
    # Retrieve a specific policy.
    api_response = api_instance.get_management_policy(uuid, expandInUse=expandInUse)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagementPoliciesApi->getManagementPolicy: %s\n" % e)
extern crate ManagementPoliciesApi;

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

    let mut context = ManagementPoliciesApi::Context::default();
    let result = client.getManagementPolicy(uuid, expandInUse, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Query parameters
Name Description
expandInUse
Boolean

Responses


getPolicies

Get a list of policies.


/managementPolicy

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/managementPolicy?entity=38400000-8cf0-11bd-b23e-10b96e4ef00d&venue=38400000-8cf0-11bd-b23e-10b96e4ef00d&unassigned=true&offset=56&limit=56&filter=filter_example&select=serial1,serial2,serial3&countOnly=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ManagementPoliciesApi;

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

public class ManagementPoliciesApiExample {
    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
        ManagementPoliciesApi apiInstance = new ManagementPoliciesApi();
        UUID entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean unassigned = true; // Boolean | 
        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
        String select = serial1,serial2,serial3; // String | Supply a list of policies comma separated
        Boolean countOnly = true; // Boolean | return the number of policies

        try {
            getPolicies_200_response result = apiInstance.getPolicies(entity, venue, unassigned, offset, limit, filter, select, countOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementPoliciesApi#getPolicies");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ManagementPoliciesApi;

public class ManagementPoliciesApiExample {
    public static void main(String[] args) {
        ManagementPoliciesApi apiInstance = new ManagementPoliciesApi();
        UUID entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean unassigned = true; // Boolean | 
        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
        String select = serial1,serial2,serial3; // String | Supply a list of policies comma separated
        Boolean countOnly = true; // Boolean | return the number of policies

        try {
            getPolicies_200_response result = apiInstance.getPolicies(entity, venue, unassigned, offset, limit, filter, select, countOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementPoliciesApi#getPolicies");
            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
ManagementPoliciesApi *apiInstance = [[ManagementPoliciesApi alloc] init];
UUID *entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (optional) (default to null)
UUID *venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (optional) (default to null)
Boolean *unassigned = true; //  (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 *filter = filter_example; // Filter the results (optional) (default to null)
String *select = serial1,serial2,serial3; // Supply a list of policies comma separated (optional) (default to null)
Boolean *countOnly = true; // return the number of policies (optional) (default to null)

// Get a list of policies.
[apiInstance getPoliciesWith:entity
    venue:venue
    unassigned:unassigned
    offset:offset
    limit:limit
    filter:filter
    select:select
    countOnly:countOnly
              completionHandler: ^(getPolicies_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ManagementPoliciesApi()
var opts = {
  'entity': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} 
  'venue': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} 
  'unassigned': true, // {Boolean} 
  '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
  'select': serial1,serial2,serial3, // {String} Supply a list of policies comma separated
  'countOnly': true // {Boolean} return the number of policies
};

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

namespace Example
{
    public class getPoliciesExample
    {
        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 ManagementPoliciesApi();
            var entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (optional)  (default to null)
            var venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (optional)  (default to null)
            var unassigned = true;  // Boolean |  (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 filter = filter_example;  // String | Filter the results (optional)  (default to null)
            var select = serial1,serial2,serial3;  // String | Supply a list of policies comma separated (optional)  (default to null)
            var countOnly = true;  // Boolean | return the number of policies (optional)  (default to null)

            try {
                // Get a list of policies.
                getPolicies_200_response result = apiInstance.getPolicies(entity, venue, unassigned, offset, limit, filter, select, countOnly);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ManagementPoliciesApi.getPolicies: " + 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\ManagementPoliciesApi();
$entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$unassigned = true; // Boolean | 
$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
$select = serial1,serial2,serial3; // String | Supply a list of policies comma separated
$countOnly = true; // Boolean | return the number of policies

try {
    $result = $api_instance->getPolicies($entity, $venue, $unassigned, $offset, $limit, $filter, $select, $countOnly);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagementPoliciesApi->getPolicies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ManagementPoliciesApi;

# 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::ManagementPoliciesApi->new();
my $entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $unassigned = true; # Boolean | 
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 $select = serial1,serial2,serial3; # String | Supply a list of policies comma separated
my $countOnly = true; # Boolean | return the number of policies

eval {
    my $result = $api_instance->getPolicies(entity => $entity, venue => $venue, unassigned => $unassigned, offset => $offset, limit => $limit, filter => $filter, select => $select, countOnly => $countOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagementPoliciesApi->getPolicies: $@\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.ManagementPoliciesApi()
entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (optional) (default to null)
venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (optional) (default to null)
unassigned = true # Boolean |  (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)
filter = filter_example # String | Filter the results (optional) (default to null)
select = serial1,serial2,serial3 # String | Supply a list of policies comma separated (optional) (default to null)
countOnly = true # Boolean | return the number of policies (optional) (default to null)

try:
    # Get a list of policies.
    api_response = api_instance.get_policies(entity=entity, venue=venue, unassigned=unassigned, offset=offset, limit=limit, filter=filter, select=select, countOnly=countOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagementPoliciesApi->getPolicies: %s\n" % e)
extern crate ManagementPoliciesApi;

pub fn main() {
    let entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let unassigned = true; // Boolean
    let offset = 56; // Integer
    let limit = 56; // Integer
    let filter = filter_example; // String
    let select = serial1,serial2,serial3; // String
    let countOnly = true; // Boolean

    let mut context = ManagementPoliciesApi::Context::default();
    let result = client.getPolicies(entity, venue, unassigned, offset, limit, filter, select, countOnly, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
entity
UUID (uuid)
venue
UUID (uuid)
unassigned
Boolean
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
select
String
Supply a list of policies comma separated
countOnly
Boolean
return the number of policies

Responses


modifyManagementPolicy

Modify a specific policy.


/managementPolicy/{uuid}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/managementPolicy/{uuid}" \
 -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 ]
  },
  "venue" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "entries" : [ {
    "access" : [ "NOACCESS", "NOACCESS" ],
    "resources" : [ "resources", "resources" ],
    "users" : [ "users", "users" ],
    "policy" : "policy"
  }, {
    "access" : [ "NOACCESS", "NOACCESS" ],
    "resources" : [ "resources", "resources" ],
    "users" : [ "users", "users" ],
    "policy" : "policy"
  } ],
  "inUse" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ManagementPoliciesApi;

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

public class ManagementPoliciesApiExample {
    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
        ManagementPoliciesApi apiInstance = new ManagementPoliciesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        ManagementPolicy managementPolicy = ; // ManagementPolicy | 

        try {
            apiInstance.modifyManagementPolicy(uuid, managementPolicy);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementPoliciesApi#modifyManagementPolicy");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ManagementPoliciesApi;

public class ManagementPoliciesApiExample {
    public static void main(String[] args) {
        ManagementPoliciesApi apiInstance = new ManagementPoliciesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        ManagementPolicy managementPolicy = ; // ManagementPolicy | 

        try {
            apiInstance.modifyManagementPolicy(uuid, managementPolicy);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementPoliciesApi#modifyManagementPolicy");
            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
ManagementPoliciesApi *apiInstance = [[ManagementPoliciesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
ManagementPolicy *managementPolicy = ; //  (optional)

// Modify a specific policy.
[apiInstance modifyManagementPolicyWith:uuid
    managementPolicy:managementPolicy
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ManagementPoliciesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'managementPolicy':  // {ManagementPolicy} 
};

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

namespace Example
{
    public class modifyManagementPolicyExample
    {
        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 ManagementPoliciesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var managementPolicy = new ManagementPolicy(); // ManagementPolicy |  (optional) 

            try {
                // Modify a specific policy.
                apiInstance.modifyManagementPolicy(uuid, managementPolicy);
            } catch (Exception e) {
                Debug.Print("Exception when calling ManagementPoliciesApi.modifyManagementPolicy: " + 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\ManagementPoliciesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$managementPolicy = ; // ManagementPolicy | 

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

# 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::ManagementPoliciesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $managementPolicy = WWW::OPenAPIClient::Object::ManagementPolicy->new(); # ManagementPolicy | 

eval {
    $api_instance->modifyManagementPolicy(uuid => $uuid, managementPolicy => $managementPolicy);
};
if ($@) {
    warn "Exception when calling ManagementPoliciesApi->modifyManagementPolicy: $@\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.ManagementPoliciesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
managementPolicy =  # ManagementPolicy |  (optional)

try:
    # Modify a specific policy.
    api_instance.modify_management_policy(uuid, managementPolicy=managementPolicy)
except ApiException as e:
    print("Exception when calling ManagementPoliciesApi->modifyManagementPolicy: %s\n" % e)
extern crate ManagementPoliciesApi;

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

    let mut context = ManagementPoliciesApi::Context::default();
    let result = client.modifyManagementPolicy(uuid, managementPolicy, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
managementPolicy

Information used to modify the new policy.

Responses


ManagementRoles

createManagementRole

Create a specific management role.


/managementRole/{uuid}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/managementRole/{uuid}" \
 -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 ]
  },
  "venue" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "inUse" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "users" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ManagementRolesApi;

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

public class ManagementRolesApiExample {
    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
        ManagementRolesApi apiInstance = new ManagementRolesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        ManagementRole managementRole = ; // ManagementRole | 

        try {
            apiInstance.createManagementRole(uuid, managementRole);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementRolesApi#createManagementRole");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ManagementRolesApi;

public class ManagementRolesApiExample {
    public static void main(String[] args) {
        ManagementRolesApi apiInstance = new ManagementRolesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        ManagementRole managementRole = ; // ManagementRole | 

        try {
            apiInstance.createManagementRole(uuid, managementRole);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementRolesApi#createManagementRole");
            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
ManagementRolesApi *apiInstance = [[ManagementRolesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
ManagementRole *managementRole = ; //  (optional)

// Create a specific management role.
[apiInstance createManagementRoleWith:uuid
    managementRole:managementRole
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ManagementRolesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'managementRole':  // {ManagementRole} 
};

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

namespace Example
{
    public class createManagementRoleExample
    {
        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 ManagementRolesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var managementRole = new ManagementRole(); // ManagementRole |  (optional) 

            try {
                // Create a specific management role.
                apiInstance.createManagementRole(uuid, managementRole);
            } catch (Exception e) {
                Debug.Print("Exception when calling ManagementRolesApi.createManagementRole: " + 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\ManagementRolesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$managementRole = ; // ManagementRole | 

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

# 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::ManagementRolesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $managementRole = WWW::OPenAPIClient::Object::ManagementRole->new(); # ManagementRole | 

eval {
    $api_instance->createManagementRole(uuid => $uuid, managementRole => $managementRole);
};
if ($@) {
    warn "Exception when calling ManagementRolesApi->createManagementRole: $@\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.ManagementRolesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
managementRole =  # ManagementRole |  (optional)

try:
    # Create a specific management role.
    api_instance.create_management_role(uuid, managementRole=managementRole)
except ApiException as e:
    print("Exception when calling ManagementRolesApi->createManagementRole: %s\n" % e)
extern crate ManagementRolesApi;

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

    let mut context = ManagementRolesApi::Context::default();
    let result = client.createManagementRole(uuid, managementRole, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
managementRole

Information used to create management role

Responses


deleteManagementRole

Delete a specific management role.


/managementRole/{uuid}

Usage and SDK Samples

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

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

public class ManagementRolesApiExample {
    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
        ManagementRolesApi apiInstance = new ManagementRolesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

        try {
            apiInstance.deleteManagementRole(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementRolesApi#deleteManagementRole");
            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
ManagementRolesApi *apiInstance = [[ManagementRolesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Delete a specific management role.
[apiInstance deleteManagementRoleWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ManagementRolesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class deleteManagementRoleExample
    {
        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 ManagementRolesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Delete a specific management role.
                apiInstance.deleteManagementRole(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling ManagementRolesApi.deleteManagementRole: " + 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\ManagementRolesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::ManagementRolesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->deleteManagementRole(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling ManagementRolesApi->deleteManagementRole: $@\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.ManagementRolesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Delete a specific management role.
    api_instance.delete_management_role(uuid)
except ApiException as e:
    print("Exception when calling ManagementRolesApi->deleteManagementRole: %s\n" % e)
extern crate ManagementRolesApi;

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

    let mut context = ManagementRolesApi::Context::default();
    let result = client.deleteManagementRole(uuid, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


getManagementRole

Retrieve a specific management role.


/managementRole/{uuid}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/managementRole/{uuid}?expandInUse=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ManagementRolesApi;

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

public class ManagementRolesApiExample {
    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
        ManagementRolesApi apiInstance = new ManagementRolesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean expandInUse = true; // Boolean | 

        try {
            getManagementRole_200_response result = apiInstance.getManagementRole(uuid, expandInUse);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementRolesApi#getManagementRole");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ManagementRolesApi;

public class ManagementRolesApiExample {
    public static void main(String[] args) {
        ManagementRolesApi apiInstance = new ManagementRolesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean expandInUse = true; // Boolean | 

        try {
            getManagementRole_200_response result = apiInstance.getManagementRole(uuid, expandInUse);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementRolesApi#getManagementRole");
            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
ManagementRolesApi *apiInstance = [[ManagementRolesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Boolean *expandInUse = true; //  (optional) (default to null)

// Retrieve a specific management role.
[apiInstance getManagementRoleWith:uuid
    expandInUse:expandInUse
              completionHandler: ^(getManagementRole_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ManagementRolesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'expandInUse': true // {Boolean} 
};

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

namespace Example
{
    public class getManagementRoleExample
    {
        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 ManagementRolesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var expandInUse = true;  // Boolean |  (optional)  (default to null)

            try {
                // Retrieve a specific management role.
                getManagementRole_200_response result = apiInstance.getManagementRole(uuid, expandInUse);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ManagementRolesApi.getManagementRole: " + 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\ManagementRolesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$expandInUse = true; // Boolean | 

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

# 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::ManagementRolesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $expandInUse = true; # Boolean | 

eval {
    my $result = $api_instance->getManagementRole(uuid => $uuid, expandInUse => $expandInUse);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagementRolesApi->getManagementRole: $@\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.ManagementRolesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
expandInUse = true # Boolean |  (optional) (default to null)

try:
    # Retrieve a specific management role.
    api_response = api_instance.get_management_role(uuid, expandInUse=expandInUse)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagementRolesApi->getManagementRole: %s\n" % e)
extern crate ManagementRolesApi;

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

    let mut context = ManagementRolesApi::Context::default();
    let result = client.getManagementRole(uuid, expandInUse, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Query parameters
Name Description
expandInUse
Boolean

Responses


getManagementRoles

Retrieve a list of management roles.


/managementRole

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/managementRole?entity=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&filter=filter_example&select=serial1,serial2,serial3&countOnly=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ManagementRolesApi;

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

public class ManagementRolesApiExample {
    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
        ManagementRolesApi apiInstance = new ManagementRolesApi();
        UUID entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        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
        String select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
        Boolean countOnly = true; // Boolean | return the number of roles

        try {
            getManagementRoles_200_response result = apiInstance.getManagementRoles(entity, offset, limit, filter, select, countOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementRolesApi#getManagementRoles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ManagementRolesApi;

public class ManagementRolesApiExample {
    public static void main(String[] args) {
        ManagementRolesApi apiInstance = new ManagementRolesApi();
        UUID entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        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
        String select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
        Boolean countOnly = true; // Boolean | return the number of roles

        try {
            getManagementRoles_200_response result = apiInstance.getManagementRoles(entity, offset, limit, filter, select, countOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementRolesApi#getManagementRoles");
            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
ManagementRolesApi *apiInstance = [[ManagementRolesApi alloc] init];
UUID *entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (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 *filter = filter_example; // Filter the results (optional) (default to null)
String *select = serial1,serial2,serial3; // Supply a list of devices comma separated (optional) (default to null)
Boolean *countOnly = true; // return the number of roles (optional) (default to null)

// Retrieve a list of management roles.
[apiInstance getManagementRolesWith:entity
    offset:offset
    limit:limit
    filter:filter
    select:select
    countOnly:countOnly
              completionHandler: ^(getManagementRoles_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ManagementRolesApi()
var opts = {
  'entity': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} 
  '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
  'select': serial1,serial2,serial3, // {String} Supply a list of devices comma separated
  'countOnly': true // {Boolean} return the number of roles
};

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

namespace Example
{
    public class getManagementRolesExample
    {
        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 ManagementRolesApi();
            var entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (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 filter = filter_example;  // String | Filter the results (optional)  (default to null)
            var select = serial1,serial2,serial3;  // String | Supply a list of devices comma separated (optional)  (default to null)
            var countOnly = true;  // Boolean | return the number of roles (optional)  (default to null)

            try {
                // Retrieve a list of management roles.
                getManagementRoles_200_response result = apiInstance.getManagementRoles(entity, offset, limit, filter, select, countOnly);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ManagementRolesApi.getManagementRoles: " + 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\ManagementRolesApi();
$entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$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
$select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
$countOnly = true; // Boolean | return the number of roles

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

# 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::ManagementRolesApi->new();
my $entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
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 $select = serial1,serial2,serial3; # String | Supply a list of devices comma separated
my $countOnly = true; # Boolean | return the number of roles

eval {
    my $result = $api_instance->getManagementRoles(entity => $entity, offset => $offset, limit => $limit, filter => $filter, select => $select, countOnly => $countOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagementRolesApi->getManagementRoles: $@\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.ManagementRolesApi()
entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (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)
filter = filter_example # String | Filter the results (optional) (default to null)
select = serial1,serial2,serial3 # String | Supply a list of devices comma separated (optional) (default to null)
countOnly = true # Boolean | return the number of roles (optional) (default to null)

try:
    # Retrieve a list of management roles.
    api_response = api_instance.get_management_roles(entity=entity, offset=offset, limit=limit, filter=filter, select=select, countOnly=countOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagementRolesApi->getManagementRoles: %s\n" % e)
extern crate ManagementRolesApi;

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

    let mut context = ManagementRolesApi::Context::default();
    let result = client.getManagementRoles(entity, offset, limit, filter, select, countOnly, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
entity
UUID (uuid)
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
select
String
Supply a list of devices comma separated
countOnly
Boolean
return the number of roles

Responses


modifyManagementRole

Modify a specific management role.


/managementRole/{uuid}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/managementRole/{uuid}" \
 -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 ]
  },
  "venue" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "inUse" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "users" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ManagementRolesApi;

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

public class ManagementRolesApiExample {
    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
        ManagementRolesApi apiInstance = new ManagementRolesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        ManagementRole managementRole = ; // ManagementRole | 

        try {
            apiInstance.modifyManagementRole(uuid, managementRole);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementRolesApi#modifyManagementRole");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ManagementRolesApi;

public class ManagementRolesApiExample {
    public static void main(String[] args) {
        ManagementRolesApi apiInstance = new ManagementRolesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        ManagementRole managementRole = ; // ManagementRole | 

        try {
            apiInstance.modifyManagementRole(uuid, managementRole);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementRolesApi#modifyManagementRole");
            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
ManagementRolesApi *apiInstance = [[ManagementRolesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
ManagementRole *managementRole = ; //  (optional)

// Modify a specific management role.
[apiInstance modifyManagementRoleWith:uuid
    managementRole:managementRole
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ManagementRolesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'managementRole':  // {ManagementRole} 
};

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

namespace Example
{
    public class modifyManagementRoleExample
    {
        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 ManagementRolesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var managementRole = new ManagementRole(); // ManagementRole |  (optional) 

            try {
                // Modify a specific management role.
                apiInstance.modifyManagementRole(uuid, managementRole);
            } catch (Exception e) {
                Debug.Print("Exception when calling ManagementRolesApi.modifyManagementRole: " + 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\ManagementRolesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$managementRole = ; // ManagementRole | 

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

# 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::ManagementRolesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $managementRole = WWW::OPenAPIClient::Object::ManagementRole->new(); # ManagementRole | 

eval {
    $api_instance->modifyManagementRole(uuid => $uuid, managementRole => $managementRole);
};
if ($@) {
    warn "Exception when calling ManagementRolesApi->modifyManagementRole: $@\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.ManagementRolesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
managementRole =  # ManagementRole |  (optional)

try:
    # Modify a specific management role.
    api_instance.modify_management_role(uuid, managementRole=managementRole)
except ApiException as e:
    print("Exception when calling ManagementRolesApi->modifyManagementRole: %s\n" % e)
extern crate ManagementRolesApi;

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

    let mut context = ManagementRolesApi::Context::default();
    let result = client.modifyManagementRole(uuid, managementRole, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
managementRole

Information used to modify management role

Responses


Maps

createMap

Create a specific map.


/map/{uuid}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/map/{uuid}" \
 -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 ]
  },
  "venue" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "creator" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "access" : {
    "list" : [ {
      "access" : "none",
      "roles" : {
        "list" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
      },
      "users" : {
        "list" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
      }
    }, {
      "access" : "none",
      "roles" : {
        "list" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
      },
      "users" : {
        "list" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
      }
    } ]
  },
  "data" : "data",
  "visibility" : "private",
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MapsApi;

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

public class MapsApiExample {
    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
        MapsApi apiInstance = new MapsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Map map = ; // Map | 

        try {
            apiInstance.createMap(uuid, map);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapsApi#createMap");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MapsApi;

public class MapsApiExample {
    public static void main(String[] args) {
        MapsApi apiInstance = new MapsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Map map = ; // Map | 

        try {
            apiInstance.createMap(uuid, map);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapsApi#createMap");
            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
MapsApi *apiInstance = [[MapsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Map *map = ; //  (optional)

// Create a specific map.
[apiInstance createMapWith:uuid
    map:map
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.MapsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'map':  // {Map} 
};

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

namespace Example
{
    public class createMapExample
    {
        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 MapsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var map = new Map(); // Map |  (optional) 

            try {
                // Create a specific map.
                apiInstance.createMap(uuid, map);
            } catch (Exception e) {
                Debug.Print("Exception when calling MapsApi.createMap: " + 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\MapsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$map = ; // Map | 

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

# 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::MapsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $map = WWW::OPenAPIClient::Object::Map->new(); # Map | 

eval {
    $api_instance->createMap(uuid => $uuid, map => $map);
};
if ($@) {
    warn "Exception when calling MapsApi->createMap: $@\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.MapsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
map =  # Map |  (optional)

try:
    # Create a specific map.
    api_instance.create_map(uuid, map=map)
except ApiException as e:
    print("Exception when calling MapsApi->createMap: %s\n" % e)
extern crate MapsApi;

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

    let mut context = MapsApi::Context::default();
    let result = client.createMap(uuid, map, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
map

Information used to create the new policy

Responses


deleteMap

Delete a specific map.


/map/{uuid}

Usage and SDK Samples

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

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

public class MapsApiExample {
    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
        MapsApi apiInstance = new MapsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

        try {
            apiInstance.deleteMap(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapsApi#deleteMap");
            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
MapsApi *apiInstance = [[MapsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Delete a specific map.
[apiInstance deleteMapWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.MapsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class deleteMapExample
    {
        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 MapsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Delete a specific map.
                apiInstance.deleteMap(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling MapsApi.deleteMap: " + 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\MapsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::MapsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->deleteMap(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling MapsApi->deleteMap: $@\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.MapsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Delete a specific map.
    api_instance.delete_map(uuid)
except ApiException as e:
    print("Exception when calling MapsApi->deleteMap: %s\n" % e)
extern crate MapsApi;

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

    let mut context = MapsApi::Context::default();
    let result = client.deleteMap(uuid, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


getMap

Retrieve a specific map.


/map/{uuid}

Usage and SDK Samples

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

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

public class MapsApiExample {
    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
        MapsApi apiInstance = new MapsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

        try {
            Map result = apiInstance.getMap(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapsApi#getMap");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MapsApi;

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

        try {
            Map result = apiInstance.getMap(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapsApi#getMap");
            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
MapsApi *apiInstance = [[MapsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Retrieve a specific map.
[apiInstance getMapWith:uuid
              completionHandler: ^(Map output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.MapsApi()
var uuid = 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.getMap(uuid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMapExample
    {
        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 MapsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Retrieve a specific map.
                Map result = apiInstance.getMap(uuid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MapsApi.getMap: " + 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\MapsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::MapsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    my $result = $api_instance->getMap(uuid => $uuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MapsApi->getMap: $@\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.MapsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Retrieve a specific map.
    api_response = api_instance.get_map(uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MapsApi->getMap: %s\n" % e)
extern crate MapsApi;

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

    let mut context = MapsApi::Context::default();
    let result = client.getMap(uuid, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


getMapList

Retrieve the list of maps


/map

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/map?offset=56&limit=56&filter=filter_example&myMaps=true&sharedWithMe=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MapsApi;

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

public class MapsApiExample {
    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
        MapsApi apiInstance = new MapsApi();
        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 myMaps = true; // Boolean | Return only maps I created
        Boolean sharedWithMe = true; // Boolean | Return only maps shared with Me

        try {
            MapList result = apiInstance.getMapList(offset, limit, filter, myMaps, sharedWithMe);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapsApi#getMapList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MapsApi;

public class MapsApiExample {
    public static void main(String[] args) {
        MapsApi apiInstance = new MapsApi();
        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 myMaps = true; // Boolean | Return only maps I created
        Boolean sharedWithMe = true; // Boolean | Return only maps shared with Me

        try {
            MapList result = apiInstance.getMapList(offset, limit, filter, myMaps, sharedWithMe);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapsApi#getMapList");
            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
MapsApi *apiInstance = [[MapsApi 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 *myMaps = true; // Return only maps I created (optional) (default to null)
Boolean *sharedWithMe = true; // Return only maps shared with Me (optional) (default to null)

// Retrieve the list of maps
[apiInstance getMapListWith:offset
    limit:limit
    filter:filter
    myMaps:myMaps
    sharedWithMe:sharedWithMe
              completionHandler: ^(MapList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.MapsApi()
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
  'myMaps': true, // {Boolean} Return only maps I created
  'sharedWithMe': true // {Boolean} Return only maps shared with Me
};

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

namespace Example
{
    public class getMapListExample
    {
        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 MapsApi();
            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 myMaps = true;  // Boolean | Return only maps I created (optional)  (default to null)
            var sharedWithMe = true;  // Boolean | Return only maps shared with Me (optional)  (default to null)

            try {
                // Retrieve the list of maps
                MapList result = apiInstance.getMapList(offset, limit, filter, myMaps, sharedWithMe);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling MapsApi.getMapList: " + 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\MapsApi();
$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
$myMaps = true; // Boolean | Return only maps I created
$sharedWithMe = true; // Boolean | Return only maps shared with Me

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

# 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::MapsApi->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 $myMaps = true; # Boolean | Return only maps I created
my $sharedWithMe = true; # Boolean | Return only maps shared with Me

eval {
    my $result = $api_instance->getMapList(offset => $offset, limit => $limit, filter => $filter, myMaps => $myMaps, sharedWithMe => $sharedWithMe);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MapsApi->getMapList: $@\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.MapsApi()
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)
myMaps = true # Boolean | Return only maps I created (optional) (default to null)
sharedWithMe = true # Boolean | Return only maps shared with Me (optional) (default to null)

try:
    # Retrieve the list of maps
    api_response = api_instance.get_map_list(offset=offset, limit=limit, filter=filter, myMaps=myMaps, sharedWithMe=sharedWithMe)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MapsApi->getMapList: %s\n" % e)
extern crate MapsApi;

pub fn main() {
    let offset = 56; // Integer
    let limit = 56; // Integer
    let filter = filter_example; // String
    let myMaps = true; // Boolean
    let sharedWithMe = true; // Boolean

    let mut context = MapsApi::Context::default();
    let result = client.getMapList(offset, limit, filter, myMaps, sharedWithMe, &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
myMaps
Boolean
Return only maps I created
sharedWithMe
Boolean
Return only maps shared with Me

Responses


modifyMap

Modify a specific map.


/map/{uuid}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/map/{uuid}" \
 -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 ]
  },
  "venue" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "creator" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "access" : {
    "list" : [ {
      "access" : "none",
      "roles" : {
        "list" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
      },
      "users" : {
        "list" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
      }
    }, {
      "access" : "none",
      "roles" : {
        "list" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
      },
      "users" : {
        "list" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
      }
    } ]
  },
  "data" : "data",
  "visibility" : "private",
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.MapsApi;

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

public class MapsApiExample {
    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
        MapsApi apiInstance = new MapsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Map map = ; // Map | 

        try {
            apiInstance.modifyMap(uuid, map);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapsApi#modifyMap");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.MapsApi;

public class MapsApiExample {
    public static void main(String[] args) {
        MapsApi apiInstance = new MapsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Map map = ; // Map | 

        try {
            apiInstance.modifyMap(uuid, map);
        } catch (ApiException e) {
            System.err.println("Exception when calling MapsApi#modifyMap");
            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
MapsApi *apiInstance = [[MapsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Map *map = ; //  (optional)

// Modify a specific map.
[apiInstance modifyMapWith:uuid
    map:map
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.MapsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'map':  // {Map} 
};

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

namespace Example
{
    public class modifyMapExample
    {
        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 MapsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var map = new Map(); // Map |  (optional) 

            try {
                // Modify a specific map.
                apiInstance.modifyMap(uuid, map);
            } catch (Exception e) {
                Debug.Print("Exception when calling MapsApi.modifyMap: " + 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\MapsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$map = ; // Map | 

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

# 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::MapsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $map = WWW::OPenAPIClient::Object::Map->new(); # Map | 

eval {
    $api_instance->modifyMap(uuid => $uuid, map => $map);
};
if ($@) {
    warn "Exception when calling MapsApi->modifyMap: $@\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.MapsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
map =  # Map |  (optional)

try:
    # Modify a specific map.
    api_instance.modify_map(uuid, map=map)
except ApiException as e:
    print("Exception when calling MapsApi->modifyMap: %s\n" % e)
extern crate MapsApi;

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

    let mut context = MapsApi::Context::default();
    let result = client.modifyMap(uuid, map, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
map

Information used to modify a map

Responses


OperatorContacts

createOperatorContact

Create a specific operator contact.


/operatorContact/{uuid}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/operatorContact/{uuid}" \
 -d '{
  "firstname" : "firstname",
  "secondaryEmail" : "secondaryEmail",
  "initials" : "initials",
  "phones" : [ "phones", "phones" ],
  "type" : "SUBSCRIBER",
  "title" : "title",
  "lastname" : "lastname",
  "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 ]
  },
  "mobiles" : [ "mobiles", "mobiles" ],
  "visual" : "visual",
  "salutation" : "salutation",
  "operatorId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "subscriberDeviceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "primaryEmail" : "primaryEmail",
  "accessPIN" : "accessPIN"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OperatorContactsApi;

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

public class OperatorContactsApiExample {
    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
        OperatorContactsApi apiInstance = new OperatorContactsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        OperatorContact operatorContact = ; // OperatorContact | 

        try {
            apiInstance.createOperatorContact(uuid, operatorContact);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorContactsApi#createOperatorContact");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OperatorContactsApi;

public class OperatorContactsApiExample {
    public static void main(String[] args) {
        OperatorContactsApi apiInstance = new OperatorContactsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        OperatorContact operatorContact = ; // OperatorContact | 

        try {
            apiInstance.createOperatorContact(uuid, operatorContact);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorContactsApi#createOperatorContact");
            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
OperatorContactsApi *apiInstance = [[OperatorContactsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
OperatorContact *operatorContact = ; //  (optional)

// Create a specific operator contact.
[apiInstance createOperatorContactWith:uuid
    operatorContact:operatorContact
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.OperatorContactsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'operatorContact':  // {OperatorContact} 
};

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

namespace Example
{
    public class createOperatorContactExample
    {
        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 OperatorContactsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var operatorContact = new OperatorContact(); // OperatorContact |  (optional) 

            try {
                // Create a specific operator contact.
                apiInstance.createOperatorContact(uuid, operatorContact);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperatorContactsApi.createOperatorContact: " + 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\OperatorContactsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$operatorContact = ; // OperatorContact | 

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

# 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::OperatorContactsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $operatorContact = WWW::OPenAPIClient::Object::OperatorContact->new(); # OperatorContact | 

eval {
    $api_instance->createOperatorContact(uuid => $uuid, operatorContact => $operatorContact);
};
if ($@) {
    warn "Exception when calling OperatorContactsApi->createOperatorContact: $@\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.OperatorContactsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
operatorContact =  # OperatorContact |  (optional)

try:
    # Create a specific operator contact.
    api_instance.create_operator_contact(uuid, operatorContact=operatorContact)
except ApiException as e:
    print("Exception when calling OperatorContactsApi->createOperatorContact: %s\n" % e)
extern crate OperatorContactsApi;

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

    let mut context = OperatorContactsApi::Context::default();
    let result = client.createOperatorContact(uuid, operatorContact, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
operatorContact

Information used to create the new entity

Responses


deleteOperatorContact

Delete a specific operator contact.


/operatorContact/{uuid}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16005/api/v1/operatorContact/{uuid}?force=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OperatorContactsApi;

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

public class OperatorContactsApiExample {
    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
        OperatorContactsApi apiInstance = new OperatorContactsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean force = true; // Boolean | 

        try {
            apiInstance.deleteOperatorContact(uuid, force);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorContactsApi#deleteOperatorContact");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OperatorContactsApi;

public class OperatorContactsApiExample {
    public static void main(String[] args) {
        OperatorContactsApi apiInstance = new OperatorContactsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean force = true; // Boolean | 

        try {
            apiInstance.deleteOperatorContact(uuid, force);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorContactsApi#deleteOperatorContact");
            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
OperatorContactsApi *apiInstance = [[OperatorContactsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Boolean *force = true; //  (default to null)

// Delete a specific operator contact.
[apiInstance deleteOperatorContactWith:uuid
    force:force
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.OperatorContactsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var force = true; // {Boolean} 

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

namespace Example
{
    public class deleteOperatorContactExample
    {
        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 OperatorContactsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var force = true;  // Boolean |  (default to null)

            try {
                // Delete a specific operator contact.
                apiInstance.deleteOperatorContact(uuid, force);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperatorContactsApi.deleteOperatorContact: " + 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\OperatorContactsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$force = true; // Boolean | 

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

# 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::OperatorContactsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $force = true; # Boolean | 

eval {
    $api_instance->deleteOperatorContact(uuid => $uuid, force => $force);
};
if ($@) {
    warn "Exception when calling OperatorContactsApi->deleteOperatorContact: $@\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.OperatorContactsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
force = true # Boolean |  (default to null)

try:
    # Delete a specific operator contact.
    api_instance.delete_operator_contact(uuid, force)
except ApiException as e:
    print("Exception when calling OperatorContactsApi->deleteOperatorContact: %s\n" % e)
extern crate OperatorContactsApi;

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

    let mut context = OperatorContactsApi::Context::default();
    let result = client.deleteOperatorContact(uuid, force, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Query parameters
Name Description
force*
Boolean
Required

Responses


getOperatorContact

Retrieve a specific operator contact.


/operatorContact/{uuid}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16005/api/v1/operatorContact/{uuid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OperatorContactsApi;

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

public class OperatorContactsApiExample {
    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
        OperatorContactsApi apiInstance = new OperatorContactsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

        try {
            apiInstance.getOperatorContact(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorContactsApi#getOperatorContact");
            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
OperatorContactsApi *apiInstance = [[OperatorContactsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Retrieve a specific operator contact.
[apiInstance getOperatorContactWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.OperatorContactsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class getOperatorContactExample
    {
        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 OperatorContactsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Retrieve a specific operator contact.
                apiInstance.getOperatorContact(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperatorContactsApi.getOperatorContact: " + 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\OperatorContactsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::OperatorContactsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->getOperatorContact(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling OperatorContactsApi->getOperatorContact: $@\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.OperatorContactsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Retrieve a specific operator contact.
    api_instance.get_operator_contact(uuid)
except ApiException as e:
    print("Exception when calling OperatorContactsApi->getOperatorContact: %s\n" % e)
extern crate OperatorContactsApi;

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

    let mut context = OperatorContactsApi::Context::default();
    let result = client.getOperatorContact(uuid, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


getOperatorContacts

Retrieve a list of operator contacts.


/operatorContact

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/operatorContact?operatorId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&filter=filter_example&select=uuid1,uuid2,uuid3&countOnly=true&uuidOnly=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OperatorContactsApi;

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

public class OperatorContactsApiExample {
    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
        OperatorContactsApi apiInstance = new OperatorContactsApi();
        UUID operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        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
        String select = uuid1,uuid2,uuid3; // String | Supply a list of operator contacts comma separated
        Boolean countOnly = true; // Boolean | return the number of operator contacts
        Boolean uuidOnly = true; // Boolean | return only the UUIDs of operator contacts

        try {
            getOperatorContacts_200_response result = apiInstance.getOperatorContacts(operatorId, offset, limit, filter, select, countOnly, uuidOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorContactsApi#getOperatorContacts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OperatorContactsApi;

public class OperatorContactsApiExample {
    public static void main(String[] args) {
        OperatorContactsApi apiInstance = new OperatorContactsApi();
        UUID operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        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
        String select = uuid1,uuid2,uuid3; // String | Supply a list of operator contacts comma separated
        Boolean countOnly = true; // Boolean | return the number of operator contacts
        Boolean uuidOnly = true; // Boolean | return only the UUIDs of operator contacts

        try {
            getOperatorContacts_200_response result = apiInstance.getOperatorContacts(operatorId, offset, limit, filter, select, countOnly, uuidOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorContactsApi#getOperatorContacts");
            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
OperatorContactsApi *apiInstance = [[OperatorContactsApi alloc] init];
UUID *operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (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 *filter = filter_example; // Filter the results (optional) (default to null)
String *select = uuid1,uuid2,uuid3; // Supply a list of operator contacts comma separated (optional) (default to null)
Boolean *countOnly = true; // return the number of operator contacts (optional) (default to null)
Boolean *uuidOnly = true; // return only the UUIDs of operator contacts (optional) (default to null)

// Retrieve a list of operator contacts.
[apiInstance getOperatorContactsWith:operatorId
    offset:offset
    limit:limit
    filter:filter
    select:select
    countOnly:countOnly
    uuidOnly:uuidOnly
              completionHandler: ^(getOperatorContacts_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.OperatorContactsApi()
var operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
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
  'select': uuid1,uuid2,uuid3, // {String} Supply a list of operator contacts comma separated
  'countOnly': true, // {Boolean} return the number of operator contacts
  'uuidOnly': true // {Boolean} return only the UUIDs of operator contacts
};

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

namespace Example
{
    public class getOperatorContactsExample
    {
        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 OperatorContactsApi();
            var operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (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 filter = filter_example;  // String | Filter the results (optional)  (default to null)
            var select = uuid1,uuid2,uuid3;  // String | Supply a list of operator contacts comma separated (optional)  (default to null)
            var countOnly = true;  // Boolean | return the number of operator contacts (optional)  (default to null)
            var uuidOnly = true;  // Boolean | return only the UUIDs of operator contacts (optional)  (default to null)

            try {
                // Retrieve a list of operator contacts.
                getOperatorContacts_200_response result = apiInstance.getOperatorContacts(operatorId, offset, limit, filter, select, countOnly, uuidOnly);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperatorContactsApi.getOperatorContacts: " + 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\OperatorContactsApi();
$operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$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
$select = uuid1,uuid2,uuid3; // String | Supply a list of operator contacts comma separated
$countOnly = true; // Boolean | return the number of operator contacts
$uuidOnly = true; // Boolean | return only the UUIDs of operator contacts

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

# 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::OperatorContactsApi->new();
my $operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
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 $select = uuid1,uuid2,uuid3; # String | Supply a list of operator contacts comma separated
my $countOnly = true; # Boolean | return the number of operator contacts
my $uuidOnly = true; # Boolean | return only the UUIDs of operator contacts

eval {
    my $result = $api_instance->getOperatorContacts(operatorId => $operatorId, offset => $offset, limit => $limit, filter => $filter, select => $select, countOnly => $countOnly, uuidOnly => $uuidOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OperatorContactsApi->getOperatorContacts: $@\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.OperatorContactsApi()
operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (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)
filter = filter_example # String | Filter the results (optional) (default to null)
select = uuid1,uuid2,uuid3 # String | Supply a list of operator contacts comma separated (optional) (default to null)
countOnly = true # Boolean | return the number of operator contacts (optional) (default to null)
uuidOnly = true # Boolean | return only the UUIDs of operator contacts (optional) (default to null)

try:
    # Retrieve a list of operator contacts.
    api_response = api_instance.get_operator_contacts(operatorId, offset=offset, limit=limit, filter=filter, select=select, countOnly=countOnly, uuidOnly=uuidOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OperatorContactsApi->getOperatorContacts: %s\n" % e)
extern crate OperatorContactsApi;

pub fn main() {
    let operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let filter = filter_example; // String
    let select = uuid1,uuid2,uuid3; // String
    let countOnly = true; // Boolean
    let uuidOnly = true; // Boolean

    let mut context = OperatorContactsApi::Context::default();
    let result = client.getOperatorContacts(operatorId, offset, limit, filter, select, countOnly, uuidOnly, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
operatorId*
UUID (uuid)
Required
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
select
String
Supply a list of operator contacts comma separated
countOnly
Boolean
return the number of operator contacts
uuidOnly
Boolean
return only the UUIDs of operator contacts

Responses


modifyOperatorContact

Modify a specific operator contact.


/operatorContact/{uuid}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/operatorContact/{uuid}" \
 -d '{
  "firstname" : "firstname",
  "secondaryEmail" : "secondaryEmail",
  "initials" : "initials",
  "phones" : [ "phones", "phones" ],
  "type" : "SUBSCRIBER",
  "title" : "title",
  "lastname" : "lastname",
  "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 ]
  },
  "mobiles" : [ "mobiles", "mobiles" ],
  "visual" : "visual",
  "salutation" : "salutation",
  "operatorId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "subscriberDeviceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "primaryEmail" : "primaryEmail",
  "accessPIN" : "accessPIN"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OperatorContactsApi;

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

public class OperatorContactsApiExample {
    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
        OperatorContactsApi apiInstance = new OperatorContactsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        OperatorContact operatorContact = ; // OperatorContact | 

        try {
            apiInstance.modifyOperatorContact(uuid, operatorContact);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorContactsApi#modifyOperatorContact");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OperatorContactsApi;

public class OperatorContactsApiExample {
    public static void main(String[] args) {
        OperatorContactsApi apiInstance = new OperatorContactsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        OperatorContact operatorContact = ; // OperatorContact | 

        try {
            apiInstance.modifyOperatorContact(uuid, operatorContact);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorContactsApi#modifyOperatorContact");
            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
OperatorContactsApi *apiInstance = [[OperatorContactsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
OperatorContact *operatorContact = ; //  (optional)

// Modify a specific operator contact.
[apiInstance modifyOperatorContactWith:uuid
    operatorContact:operatorContact
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.OperatorContactsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'operatorContact':  // {OperatorContact} 
};

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

namespace Example
{
    public class modifyOperatorContactExample
    {
        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 OperatorContactsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var operatorContact = new OperatorContact(); // OperatorContact |  (optional) 

            try {
                // Modify a specific operator contact.
                apiInstance.modifyOperatorContact(uuid, operatorContact);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperatorContactsApi.modifyOperatorContact: " + 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\OperatorContactsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$operatorContact = ; // OperatorContact | 

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

# 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::OperatorContactsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $operatorContact = WWW::OPenAPIClient::Object::OperatorContact->new(); # OperatorContact | 

eval {
    $api_instance->modifyOperatorContact(uuid => $uuid, operatorContact => $operatorContact);
};
if ($@) {
    warn "Exception when calling OperatorContactsApi->modifyOperatorContact: $@\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.OperatorContactsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
operatorContact =  # OperatorContact |  (optional)

try:
    # Modify a specific operator contact.
    api_instance.modify_operator_contact(uuid, operatorContact=operatorContact)
except ApiException as e:
    print("Exception when calling OperatorContactsApi->modifyOperatorContact: %s\n" % e)
extern crate OperatorContactsApi;

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

    let mut context = OperatorContactsApi::Context::default();
    let result = client.modifyOperatorContact(uuid, operatorContact, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
operatorContact

Information used to modify the new entity

Responses


OperatorLocations

createOperatorLocation

Create a specific location.


/operatorLocation/{uuid}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/operatorLocation/{uuid}" \
 -d '{
  "country" : "country",
  "city" : "city",
  "phones" : [ "phones", "phones" ],
  "geoCode" : "geoCode",
  "type" : "SERVICE",
  "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 ]
  },
  "buildingName" : "buildingName",
  "mobiles" : [ "mobiles", "mobiles" ],
  "addressLines" : [ "addressLines", "addressLines" ],
  "state" : "state",
  "postal" : "postal",
  "operatorId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "subscriberDeviceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OperatorLocationsApi;

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

public class OperatorLocationsApiExample {
    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
        OperatorLocationsApi apiInstance = new OperatorLocationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        OperatorLocation operatorLocation = ; // OperatorLocation | 

        try {
            apiInstance.createOperatorLocation(uuid, operatorLocation);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorLocationsApi#createOperatorLocation");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OperatorLocationsApi;

public class OperatorLocationsApiExample {
    public static void main(String[] args) {
        OperatorLocationsApi apiInstance = new OperatorLocationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        OperatorLocation operatorLocation = ; // OperatorLocation | 

        try {
            apiInstance.createOperatorLocation(uuid, operatorLocation);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorLocationsApi#createOperatorLocation");
            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
OperatorLocationsApi *apiInstance = [[OperatorLocationsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
OperatorLocation *operatorLocation = ; //  (optional)

// Create a specific location.
[apiInstance createOperatorLocationWith:uuid
    operatorLocation:operatorLocation
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.OperatorLocationsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'operatorLocation':  // {OperatorLocation} 
};

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

namespace Example
{
    public class createOperatorLocationExample
    {
        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 OperatorLocationsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var operatorLocation = new OperatorLocation(); // OperatorLocation |  (optional) 

            try {
                // Create a specific location.
                apiInstance.createOperatorLocation(uuid, operatorLocation);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperatorLocationsApi.createOperatorLocation: " + 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\OperatorLocationsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$operatorLocation = ; // OperatorLocation | 

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

# 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::OperatorLocationsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $operatorLocation = WWW::OPenAPIClient::Object::OperatorLocation->new(); # OperatorLocation | 

eval {
    $api_instance->createOperatorLocation(uuid => $uuid, operatorLocation => $operatorLocation);
};
if ($@) {
    warn "Exception when calling OperatorLocationsApi->createOperatorLocation: $@\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.OperatorLocationsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
operatorLocation =  # OperatorLocation |  (optional)

try:
    # Create a specific location.
    api_instance.create_operator_location(uuid, operatorLocation=operatorLocation)
except ApiException as e:
    print("Exception when calling OperatorLocationsApi->createOperatorLocation: %s\n" % e)
extern crate OperatorLocationsApi;

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

    let mut context = OperatorLocationsApi::Context::default();
    let result = client.createOperatorLocation(uuid, operatorLocation, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
operatorLocation

Information used to create the new location

Responses


deleteOperatorLocation

Delete a specific location.


/operatorLocation/{uuid}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16005/api/v1/operatorLocation/{uuid}?force=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OperatorLocationsApi;

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

public class OperatorLocationsApiExample {
    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
        OperatorLocationsApi apiInstance = new OperatorLocationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean force = true; // Boolean | 

        try {
            apiInstance.deleteOperatorLocation(uuid, force);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorLocationsApi#deleteOperatorLocation");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OperatorLocationsApi;

public class OperatorLocationsApiExample {
    public static void main(String[] args) {
        OperatorLocationsApi apiInstance = new OperatorLocationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean force = true; // Boolean | 

        try {
            apiInstance.deleteOperatorLocation(uuid, force);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorLocationsApi#deleteOperatorLocation");
            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
OperatorLocationsApi *apiInstance = [[OperatorLocationsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Boolean *force = true; //  (default to null)

// Delete a specific location.
[apiInstance deleteOperatorLocationWith:uuid
    force:force
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.OperatorLocationsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var force = true; // {Boolean} 

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

namespace Example
{
    public class deleteOperatorLocationExample
    {
        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 OperatorLocationsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var force = true;  // Boolean |  (default to null)

            try {
                // Delete a specific location.
                apiInstance.deleteOperatorLocation(uuid, force);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperatorLocationsApi.deleteOperatorLocation: " + 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\OperatorLocationsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$force = true; // Boolean | 

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

# 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::OperatorLocationsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $force = true; # Boolean | 

eval {
    $api_instance->deleteOperatorLocation(uuid => $uuid, force => $force);
};
if ($@) {
    warn "Exception when calling OperatorLocationsApi->deleteOperatorLocation: $@\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.OperatorLocationsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
force = true # Boolean |  (default to null)

try:
    # Delete a specific location.
    api_instance.delete_operator_location(uuid, force)
except ApiException as e:
    print("Exception when calling OperatorLocationsApi->deleteOperatorLocation: %s\n" % e)
extern crate OperatorLocationsApi;

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

    let mut context = OperatorLocationsApi::Context::default();
    let result = client.deleteOperatorLocation(uuid, force, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Query parameters
Name Description
force*
Boolean
Required

Responses


getOperatorLocation

Retrieve a specific location.


/operatorLocation/{uuid}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16005/api/v1/operatorLocation/{uuid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OperatorLocationsApi;

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

public class OperatorLocationsApiExample {
    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
        OperatorLocationsApi apiInstance = new OperatorLocationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

        try {
            apiInstance.getOperatorLocation(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorLocationsApi#getOperatorLocation");
            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
OperatorLocationsApi *apiInstance = [[OperatorLocationsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Retrieve a specific location.
[apiInstance getOperatorLocationWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.OperatorLocationsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class getOperatorLocationExample
    {
        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 OperatorLocationsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Retrieve a specific location.
                apiInstance.getOperatorLocation(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperatorLocationsApi.getOperatorLocation: " + 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\OperatorLocationsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::OperatorLocationsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->getOperatorLocation(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling OperatorLocationsApi->getOperatorLocation: $@\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.OperatorLocationsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Retrieve a specific location.
    api_instance.get_operator_location(uuid)
except ApiException as e:
    print("Exception when calling OperatorLocationsApi->getOperatorLocation: %s\n" % e)
extern crate OperatorLocationsApi;

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

    let mut context = OperatorLocationsApi::Context::default();
    let result = client.getOperatorLocation(uuid, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


getOperatorLocations

Retrieve a list of locations.


/operatorLocation

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/operatorLocation?operatorId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&filter=filter_example&select=uuid1,uuid2,uuid3&countOnly=true&uuidOnly=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OperatorLocationsApi;

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

public class OperatorLocationsApiExample {
    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
        OperatorLocationsApi apiInstance = new OperatorLocationsApi();
        UUID operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        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
        String select = uuid1,uuid2,uuid3; // String | Supply a list of Locations comma separated
        Boolean countOnly = true; // Boolean | return the number of Locations
        Boolean uuidOnly = true; // Boolean | return only the UUIDs of Locations

        try {
            getOperatorLocations_200_response result = apiInstance.getOperatorLocations(operatorId, offset, limit, filter, select, countOnly, uuidOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorLocationsApi#getOperatorLocations");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OperatorLocationsApi;

public class OperatorLocationsApiExample {
    public static void main(String[] args) {
        OperatorLocationsApi apiInstance = new OperatorLocationsApi();
        UUID operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        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
        String select = uuid1,uuid2,uuid3; // String | Supply a list of Locations comma separated
        Boolean countOnly = true; // Boolean | return the number of Locations
        Boolean uuidOnly = true; // Boolean | return only the UUIDs of Locations

        try {
            getOperatorLocations_200_response result = apiInstance.getOperatorLocations(operatorId, offset, limit, filter, select, countOnly, uuidOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorLocationsApi#getOperatorLocations");
            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
OperatorLocationsApi *apiInstance = [[OperatorLocationsApi alloc] init];
UUID *operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (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 *filter = filter_example; // Filter the results (optional) (default to null)
String *select = uuid1,uuid2,uuid3; // Supply a list of Locations comma separated (optional) (default to null)
Boolean *countOnly = true; // return the number of Locations (optional) (default to null)
Boolean *uuidOnly = true; // return only the UUIDs of Locations (optional) (default to null)

// Retrieve a list of locations.
[apiInstance getOperatorLocationsWith:operatorId
    offset:offset
    limit:limit
    filter:filter
    select:select
    countOnly:countOnly
    uuidOnly:uuidOnly
              completionHandler: ^(getOperatorLocations_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.OperatorLocationsApi()
var operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
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
  'select': uuid1,uuid2,uuid3, // {String} Supply a list of Locations comma separated
  'countOnly': true, // {Boolean} return the number of Locations
  'uuidOnly': true // {Boolean} return only the UUIDs of Locations
};

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

namespace Example
{
    public class getOperatorLocationsExample
    {
        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 OperatorLocationsApi();
            var operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (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 filter = filter_example;  // String | Filter the results (optional)  (default to null)
            var select = uuid1,uuid2,uuid3;  // String | Supply a list of Locations comma separated (optional)  (default to null)
            var countOnly = true;  // Boolean | return the number of Locations (optional)  (default to null)
            var uuidOnly = true;  // Boolean | return only the UUIDs of Locations (optional)  (default to null)

            try {
                // Retrieve a list of locations.
                getOperatorLocations_200_response result = apiInstance.getOperatorLocations(operatorId, offset, limit, filter, select, countOnly, uuidOnly);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperatorLocationsApi.getOperatorLocations: " + 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\OperatorLocationsApi();
$operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$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
$select = uuid1,uuid2,uuid3; // String | Supply a list of Locations comma separated
$countOnly = true; // Boolean | return the number of Locations
$uuidOnly = true; // Boolean | return only the UUIDs of Locations

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

# 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::OperatorLocationsApi->new();
my $operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
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 $select = uuid1,uuid2,uuid3; # String | Supply a list of Locations comma separated
my $countOnly = true; # Boolean | return the number of Locations
my $uuidOnly = true; # Boolean | return only the UUIDs of Locations

eval {
    my $result = $api_instance->getOperatorLocations(operatorId => $operatorId, offset => $offset, limit => $limit, filter => $filter, select => $select, countOnly => $countOnly, uuidOnly => $uuidOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OperatorLocationsApi->getOperatorLocations: $@\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.OperatorLocationsApi()
operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (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)
filter = filter_example # String | Filter the results (optional) (default to null)
select = uuid1,uuid2,uuid3 # String | Supply a list of Locations comma separated (optional) (default to null)
countOnly = true # Boolean | return the number of Locations (optional) (default to null)
uuidOnly = true # Boolean | return only the UUIDs of Locations (optional) (default to null)

try:
    # Retrieve a list of locations.
    api_response = api_instance.get_operator_locations(operatorId, offset=offset, limit=limit, filter=filter, select=select, countOnly=countOnly, uuidOnly=uuidOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OperatorLocationsApi->getOperatorLocations: %s\n" % e)
extern crate OperatorLocationsApi;

pub fn main() {
    let operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let filter = filter_example; // String
    let select = uuid1,uuid2,uuid3; // String
    let countOnly = true; // Boolean
    let uuidOnly = true; // Boolean

    let mut context = OperatorLocationsApi::Context::default();
    let result = client.getOperatorLocations(operatorId, offset, limit, filter, select, countOnly, uuidOnly, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
operatorId*
UUID (uuid)
Required
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
select
String
Supply a list of Locations comma separated
countOnly
Boolean
return the number of Locations
uuidOnly
Boolean
return only the UUIDs of Locations

Responses


modifyOperatorLocation

Modify a specific location.


/operatorLocation/{uuid}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/operatorLocation/{uuid}" \
 -d '{
  "country" : "country",
  "city" : "city",
  "phones" : [ "phones", "phones" ],
  "geoCode" : "geoCode",
  "type" : "SERVICE",
  "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 ]
  },
  "buildingName" : "buildingName",
  "mobiles" : [ "mobiles", "mobiles" ],
  "addressLines" : [ "addressLines", "addressLines" ],
  "state" : "state",
  "postal" : "postal",
  "operatorId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "subscriberDeviceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OperatorLocationsApi;

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

public class OperatorLocationsApiExample {
    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
        OperatorLocationsApi apiInstance = new OperatorLocationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        OperatorLocation operatorLocation = ; // OperatorLocation | 

        try {
            apiInstance.modifyOperatorLocation(uuid, operatorLocation);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorLocationsApi#modifyOperatorLocation");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OperatorLocationsApi;

public class OperatorLocationsApiExample {
    public static void main(String[] args) {
        OperatorLocationsApi apiInstance = new OperatorLocationsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        OperatorLocation operatorLocation = ; // OperatorLocation | 

        try {
            apiInstance.modifyOperatorLocation(uuid, operatorLocation);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorLocationsApi#modifyOperatorLocation");
            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
OperatorLocationsApi *apiInstance = [[OperatorLocationsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
OperatorLocation *operatorLocation = ; //  (optional)

// Modify a specific location.
[apiInstance modifyOperatorLocationWith:uuid
    operatorLocation:operatorLocation
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.OperatorLocationsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'operatorLocation':  // {OperatorLocation} 
};

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

namespace Example
{
    public class modifyOperatorLocationExample
    {
        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 OperatorLocationsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var operatorLocation = new OperatorLocation(); // OperatorLocation |  (optional) 

            try {
                // Modify a specific location.
                apiInstance.modifyOperatorLocation(uuid, operatorLocation);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperatorLocationsApi.modifyOperatorLocation: " + 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\OperatorLocationsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$operatorLocation = ; // OperatorLocation | 

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

# 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::OperatorLocationsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $operatorLocation = WWW::OPenAPIClient::Object::OperatorLocation->new(); # OperatorLocation | 

eval {
    $api_instance->modifyOperatorLocation(uuid => $uuid, operatorLocation => $operatorLocation);
};
if ($@) {
    warn "Exception when calling OperatorLocationsApi->modifyOperatorLocation: $@\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.OperatorLocationsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
operatorLocation =  # OperatorLocation |  (optional)

try:
    # Modify a specific location.
    api_instance.modify_operator_location(uuid, operatorLocation=operatorLocation)
except ApiException as e:
    print("Exception when calling OperatorLocationsApi->modifyOperatorLocation: %s\n" % e)
extern crate OperatorLocationsApi;

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

    let mut context = OperatorLocationsApi::Context::default();
    let result = client.modifyOperatorLocation(uuid, operatorLocation, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
operatorLocation

Information used to modify the new location

Responses


Operators

createOperator

Create a new operator


/operator/{uuid}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/operator/{uuid}" \
 -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 ]
  },
  "variables" : [ {
    "prefix" : "prefix",
    "weight" : 0,
    "type" : "integer",
    "value" : "value"
  }, {
    "prefix" : "prefix",
    "weight" : 0,
    "type" : "integer",
    "value" : "value"
  } ],
  "deviceRules" : {
    "firmwareUpgrade" : "true",
    "rcOnly" : "true",
    "rrm" : "true"
  },
  "sourceIP" : {
    "list" : [ "list", "list" ]
  },
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "defaultOperator" : false,
  "registrationId" : "registrationId",
  "managementRoles" : {
    "roles" : [ {
      "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 ]
      },
      "venue" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "inUse" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
      "users" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
      "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "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 ]
      },
      "venue" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "inUse" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
      "users" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
      "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ]
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OperatorsApi;

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

public class OperatorsApiExample {
    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
        OperatorsApi apiInstance = new OperatorsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Operator operator = ; // Operator | 

        try {
            apiInstance.createOperator(uuid, operator);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorsApi#createOperator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OperatorsApi;

public class OperatorsApiExample {
    public static void main(String[] args) {
        OperatorsApi apiInstance = new OperatorsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Operator operator = ; // Operator | 

        try {
            apiInstance.createOperator(uuid, operator);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorsApi#createOperator");
            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
OperatorsApi *apiInstance = [[OperatorsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Operator *operator = ; //  (optional)

// Create a new operator
[apiInstance createOperatorWith:uuid
    operator:operator
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.OperatorsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'operator':  // {Operator} 
};

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

namespace Example
{
    public class createOperatorExample
    {
        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 OperatorsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var operator = new Operator(); // Operator |  (optional) 

            try {
                // Create a new operator
                apiInstance.createOperator(uuid, operator);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperatorsApi.createOperator: " + 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\OperatorsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$operator = ; // Operator | 

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

# 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::OperatorsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $operator = WWW::OPenAPIClient::Object::Operator->new(); # Operator | 

eval {
    $api_instance->createOperator(uuid => $uuid, operator => $operator);
};
if ($@) {
    warn "Exception when calling OperatorsApi->createOperator: $@\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.OperatorsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
operator =  # Operator |  (optional)

try:
    # Create a new operator
    api_instance.create_operator(uuid, operator=operator)
except ApiException as e:
    print("Exception when calling OperatorsApi->createOperator: %s\n" % e)
extern crate OperatorsApi;

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

    let mut context = OperatorsApi::Context::default();
    let result = client.createOperator(uuid, operator, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
operator

Responses


deleteOperator

Delete an operator


/operator/{uuid}

Usage and SDK Samples

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

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

public class OperatorsApiExample {
    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
        OperatorsApi apiInstance = new OperatorsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

        try {
            apiInstance.deleteOperator(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorsApi#deleteOperator");
            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
OperatorsApi *apiInstance = [[OperatorsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Delete an operator
[apiInstance deleteOperatorWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.OperatorsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class deleteOperatorExample
    {
        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 OperatorsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Delete an operator
                apiInstance.deleteOperator(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperatorsApi.deleteOperator: " + 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\OperatorsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::OperatorsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->deleteOperator(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling OperatorsApi->deleteOperator: $@\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.OperatorsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Delete an operator
    api_instance.delete_operator(uuid)
except ApiException as e:
    print("Exception when calling OperatorsApi->deleteOperator: %s\n" % e)
extern crate OperatorsApi;

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

    let mut context = OperatorsApi::Context::default();
    let result = client.deleteOperator(uuid, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


getOperator

Retrieve an operator


/operator/{uuid}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16005/api/v1/operator/{uuid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OperatorsApi;

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

public class OperatorsApiExample {
    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
        OperatorsApi apiInstance = new OperatorsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

        try {
            apiInstance.getOperator(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorsApi#getOperator");
            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
OperatorsApi *apiInstance = [[OperatorsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Retrieve an operator
[apiInstance getOperatorWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.OperatorsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class getOperatorExample
    {
        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 OperatorsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Retrieve an operator
                apiInstance.getOperator(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperatorsApi.getOperator: " + 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\OperatorsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::OperatorsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->getOperator(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling OperatorsApi->getOperator: $@\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.OperatorsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Retrieve an operator
    api_instance.get_operator(uuid)
except ApiException as e:
    print("Exception when calling OperatorsApi->getOperator: %s\n" % e)
extern crate OperatorsApi;

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

    let mut context = OperatorsApi::Context::default();
    let result = client.getOperator(uuid, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


getOperators

Retrieve the list of currently configured operators


/operator

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/operator?offset=56&limit=56&filter=filter_example&select=serial1,serial2,serial3&countOnly=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OperatorsApi;

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

public class OperatorsApiExample {
    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
        OperatorsApi apiInstance = new OperatorsApi();
        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
        String select = serial1,serial2,serial3; // String | Supply a list of operators comma separated
        Boolean countOnly = true; // Boolean | return the number of operators

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

public class OperatorsApiExample {
    public static void main(String[] args) {
        OperatorsApi apiInstance = new OperatorsApi();
        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
        String select = serial1,serial2,serial3; // String | Supply a list of operators comma separated
        Boolean countOnly = true; // Boolean | return the number of operators

        try {
            getOperators_200_response result = apiInstance.getOperators(offset, limit, filter, select, countOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorsApi#getOperators");
            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
OperatorsApi *apiInstance = [[OperatorsApi 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)
String *select = serial1,serial2,serial3; // Supply a list of operators comma separated (optional) (default to null)
Boolean *countOnly = true; // return the number of operators (optional) (default to null)

// Retrieve the list of currently configured operators
[apiInstance getOperatorsWith:offset
    limit:limit
    filter:filter
    select:select
    countOnly:countOnly
              completionHandler: ^(getOperators_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.OperatorsApi()
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
  'select': serial1,serial2,serial3, // {String} Supply a list of operators comma separated
  'countOnly': true // {Boolean} return the number of operators
};

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

namespace Example
{
    public class getOperatorsExample
    {
        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 OperatorsApi();
            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 select = serial1,serial2,serial3;  // String | Supply a list of operators comma separated (optional)  (default to null)
            var countOnly = true;  // Boolean | return the number of operators (optional)  (default to null)

            try {
                // Retrieve the list of currently configured operators
                getOperators_200_response result = apiInstance.getOperators(offset, limit, filter, select, countOnly);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperatorsApi.getOperators: " + 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\OperatorsApi();
$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
$select = serial1,serial2,serial3; // String | Supply a list of operators comma separated
$countOnly = true; // Boolean | return the number of operators

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

# 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::OperatorsApi->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 $select = serial1,serial2,serial3; # String | Supply a list of operators comma separated
my $countOnly = true; # Boolean | return the number of operators

eval {
    my $result = $api_instance->getOperators(offset => $offset, limit => $limit, filter => $filter, select => $select, countOnly => $countOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OperatorsApi->getOperators: $@\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.OperatorsApi()
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)
select = serial1,serial2,serial3 # String | Supply a list of operators comma separated (optional) (default to null)
countOnly = true # Boolean | return the number of operators (optional) (default to null)

try:
    # Retrieve the list of currently configured operators
    api_response = api_instance.get_operators(offset=offset, limit=limit, filter=filter, select=select, countOnly=countOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OperatorsApi->getOperators: %s\n" % e)
extern crate OperatorsApi;

pub fn main() {
    let offset = 56; // Integer
    let limit = 56; // Integer
    let filter = filter_example; // String
    let select = serial1,serial2,serial3; // String
    let countOnly = true; // Boolean

    let mut context = OperatorsApi::Context::default();
    let result = client.getOperators(offset, limit, filter, select, countOnly, &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
select
String
Supply a list of operators comma separated
countOnly
Boolean
return the number of operators

Responses


updateOperator

Update an existing operator


/operator/{uuid}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/operator/{uuid}" \
 -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 ]
  },
  "variables" : [ {
    "prefix" : "prefix",
    "weight" : 0,
    "type" : "integer",
    "value" : "value"
  }, {
    "prefix" : "prefix",
    "weight" : 0,
    "type" : "integer",
    "value" : "value"
  } ],
  "deviceRules" : {
    "firmwareUpgrade" : "true",
    "rcOnly" : "true",
    "rrm" : "true"
  },
  "sourceIP" : {
    "list" : [ "list", "list" ]
  },
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "defaultOperator" : false,
  "registrationId" : "registrationId",
  "managementRoles" : {
    "roles" : [ {
      "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 ]
      },
      "venue" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "inUse" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
      "users" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
      "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "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 ]
      },
      "venue" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "inUse" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
      "users" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
      "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ]
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OperatorsApi;

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

public class OperatorsApiExample {
    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
        OperatorsApi apiInstance = new OperatorsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Operator operator = ; // Operator | 

        try {
            apiInstance.updateOperator(uuid, operator);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorsApi#updateOperator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OperatorsApi;

public class OperatorsApiExample {
    public static void main(String[] args) {
        OperatorsApi apiInstance = new OperatorsApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Operator operator = ; // Operator | 

        try {
            apiInstance.updateOperator(uuid, operator);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorsApi#updateOperator");
            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
OperatorsApi *apiInstance = [[OperatorsApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Operator *operator = ; //  (optional)

// Update an existing operator
[apiInstance updateOperatorWith:uuid
    operator:operator
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.OperatorsApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'operator':  // {Operator} 
};

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

namespace Example
{
    public class updateOperatorExample
    {
        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 OperatorsApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var operator = new Operator(); // Operator |  (optional) 

            try {
                // Update an existing operator
                apiInstance.updateOperator(uuid, operator);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperatorsApi.updateOperator: " + 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\OperatorsApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$operator = ; // Operator | 

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

# 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::OperatorsApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $operator = WWW::OPenAPIClient::Object::Operator->new(); # Operator | 

eval {
    $api_instance->updateOperator(uuid => $uuid, operator => $operator);
};
if ($@) {
    warn "Exception when calling OperatorsApi->updateOperator: $@\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.OperatorsApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
operator =  # Operator |  (optional)

try:
    # Update an existing operator
    api_instance.update_operator(uuid, operator=operator)
except ApiException as e:
    print("Exception when calling OperatorsApi->updateOperator: %s\n" % e)
extern crate OperatorsApi;

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

    let mut context = OperatorsApi::Context::default();
    let result = client.updateOperator(uuid, operator, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
operator

Responses


ServiceClass

createServiceClass

Create a service class


/serviceClass/{uuid}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/serviceClass/{uuid}" \
 -d '{
  "billingCode" : "billingCode",
  "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 ]
  },
  "period" : "monthly",
  "variables" : [ {
    "prefix" : "prefix",
    "weight" : 0,
    "type" : "integer",
    "value" : "value"
  }, {
    "prefix" : "prefix",
    "weight" : 0,
    "type" : "integer",
    "value" : "value"
  } ],
  "cost" : 0.8008281904610115,
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "currency" : "currency",
  "defaultService" : false,
  "operatorId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceClassApi;

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

public class ServiceClassApiExample {
    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
        ServiceClassApi apiInstance = new ServiceClassApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        ServiceClass serviceClass = ; // ServiceClass | 

        try {
            apiInstance.createServiceClass(uuid, serviceClass);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceClassApi#createServiceClass");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ServiceClassApi;

public class ServiceClassApiExample {
    public static void main(String[] args) {
        ServiceClassApi apiInstance = new ServiceClassApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        ServiceClass serviceClass = ; // ServiceClass | 

        try {
            apiInstance.createServiceClass(uuid, serviceClass);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceClassApi#createServiceClass");
            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
ServiceClassApi *apiInstance = [[ServiceClassApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
ServiceClass *serviceClass = ; //  (optional)

// Create a service class
[apiInstance createServiceClassWith:uuid
    serviceClass:serviceClass
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ServiceClassApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'serviceClass':  // {ServiceClass} 
};

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

namespace Example
{
    public class createServiceClassExample
    {
        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 ServiceClassApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var serviceClass = new ServiceClass(); // ServiceClass |  (optional) 

            try {
                // Create a service class
                apiInstance.createServiceClass(uuid, serviceClass);
            } catch (Exception e) {
                Debug.Print("Exception when calling ServiceClassApi.createServiceClass: " + 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\ServiceClassApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$serviceClass = ; // ServiceClass | 

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

# 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::ServiceClassApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $serviceClass = WWW::OPenAPIClient::Object::ServiceClass->new(); # ServiceClass | 

eval {
    $api_instance->createServiceClass(uuid => $uuid, serviceClass => $serviceClass);
};
if ($@) {
    warn "Exception when calling ServiceClassApi->createServiceClass: $@\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.ServiceClassApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
serviceClass =  # ServiceClass |  (optional)

try:
    # Create a service class
    api_instance.create_service_class(uuid, serviceClass=serviceClass)
except ApiException as e:
    print("Exception when calling ServiceClassApi->createServiceClass: %s\n" % e)
extern crate ServiceClassApi;

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

    let mut context = ServiceClassApi::Context::default();
    let result = client.createServiceClass(uuid, serviceClass, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
serviceClass

Responses


deleteServiceClass

Delete a service class


/serviceClass/{uuid}

Usage and SDK Samples

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

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

public class ServiceClassApiExample {
    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
        ServiceClassApi apiInstance = new ServiceClassApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

        try {
            apiInstance.deleteServiceClass(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceClassApi#deleteServiceClass");
            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
ServiceClassApi *apiInstance = [[ServiceClassApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Delete a service class
[apiInstance deleteServiceClassWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ServiceClassApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class deleteServiceClassExample
    {
        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 ServiceClassApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Delete a service class
                apiInstance.deleteServiceClass(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling ServiceClassApi.deleteServiceClass: " + 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\ServiceClassApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::ServiceClassApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->deleteServiceClass(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling ServiceClassApi->deleteServiceClass: $@\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.ServiceClassApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Delete a service class
    api_instance.delete_service_class(uuid)
except ApiException as e:
    print("Exception when calling ServiceClassApi->deleteServiceClass: %s\n" % e)
extern crate ServiceClassApi;

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

    let mut context = ServiceClassApi::Context::default();
    let result = client.deleteServiceClass(uuid, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


getServiceClass

Retrieve a service class


/serviceClass/{uuid}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16005/api/v1/serviceClass/{uuid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceClassApi;

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

public class ServiceClassApiExample {
    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
        ServiceClassApi apiInstance = new ServiceClassApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

        try {
            apiInstance.getServiceClass(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceClassApi#getServiceClass");
            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
ServiceClassApi *apiInstance = [[ServiceClassApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Retrieve a service class
[apiInstance getServiceClassWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ServiceClassApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class getServiceClassExample
    {
        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 ServiceClassApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Retrieve a service class
                apiInstance.getServiceClass(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling ServiceClassApi.getServiceClass: " + 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\ServiceClassApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::ServiceClassApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->getServiceClass(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling ServiceClassApi->getServiceClass: $@\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.ServiceClassApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Retrieve a service class
    api_instance.get_service_class(uuid)
except ApiException as e:
    print("Exception when calling ServiceClassApi->getServiceClass: %s\n" % e)
extern crate ServiceClassApi;

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

    let mut context = ServiceClassApi::Context::default();
    let result = client.getServiceClass(uuid, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


getServiceClasses

Retrieve the list of currently configured service class


/serviceClass

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/serviceClass?operatorId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&filter=filter_example&select=serial1,serial2,serial3&countOnly=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceClassApi;

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

public class ServiceClassApiExample {
    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
        ServiceClassApi apiInstance = new ServiceClassApi();
        UUID operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The operator
        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
        String select = serial1,serial2,serial3; // String | Supply a list of operators comma separated
        Boolean countOnly = true; // Boolean | return the number of operators

        try {
            getServiceClasses_200_response result = apiInstance.getServiceClasses(operatorId, offset, limit, filter, select, countOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceClassApi#getServiceClasses");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ServiceClassApi;

public class ServiceClassApiExample {
    public static void main(String[] args) {
        ServiceClassApi apiInstance = new ServiceClassApi();
        UUID operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The operator
        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
        String select = serial1,serial2,serial3; // String | Supply a list of operators comma separated
        Boolean countOnly = true; // Boolean | return the number of operators

        try {
            getServiceClasses_200_response result = apiInstance.getServiceClasses(operatorId, offset, limit, filter, select, countOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceClassApi#getServiceClasses");
            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
ServiceClassApi *apiInstance = [[ServiceClassApi alloc] init];
UUID *operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The operator (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 *filter = filter_example; // Filter the results (optional) (default to null)
String *select = serial1,serial2,serial3; // Supply a list of operators comma separated (optional) (default to null)
Boolean *countOnly = true; // return the number of operators (optional) (default to null)

// Retrieve the list of currently configured service class
[apiInstance getServiceClassesWith:operatorId
    offset:offset
    limit:limit
    filter:filter
    select:select
    countOnly:countOnly
              completionHandler: ^(getServiceClasses_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ServiceClassApi()
var operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The operator
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
  'select': serial1,serial2,serial3, // {String} Supply a list of operators comma separated
  'countOnly': true // {Boolean} return the number of operators
};

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

namespace Example
{
    public class getServiceClassesExample
    {
        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 ServiceClassApi();
            var operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The operator (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 filter = filter_example;  // String | Filter the results (optional)  (default to null)
            var select = serial1,serial2,serial3;  // String | Supply a list of operators comma separated (optional)  (default to null)
            var countOnly = true;  // Boolean | return the number of operators (optional)  (default to null)

            try {
                // Retrieve the list of currently configured service class
                getServiceClasses_200_response result = apiInstance.getServiceClasses(operatorId, offset, limit, filter, select, countOnly);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ServiceClassApi.getServiceClasses: " + 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\ServiceClassApi();
$operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The operator
$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
$select = serial1,serial2,serial3; // String | Supply a list of operators comma separated
$countOnly = true; // Boolean | return the number of operators

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

# 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::ServiceClassApi->new();
my $operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The operator
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 $select = serial1,serial2,serial3; # String | Supply a list of operators comma separated
my $countOnly = true; # Boolean | return the number of operators

eval {
    my $result = $api_instance->getServiceClasses(operatorId => $operatorId, offset => $offset, limit => $limit, filter => $filter, select => $select, countOnly => $countOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServiceClassApi->getServiceClasses: $@\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.ServiceClassApi()
operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The operator (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)
filter = filter_example # String | Filter the results (optional) (default to null)
select = serial1,serial2,serial3 # String | Supply a list of operators comma separated (optional) (default to null)
countOnly = true # Boolean | return the number of operators (optional) (default to null)

try:
    # Retrieve the list of currently configured service class
    api_response = api_instance.get_service_classes(operatorId, offset=offset, limit=limit, filter=filter, select=select, countOnly=countOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServiceClassApi->getServiceClasses: %s\n" % e)
extern crate ServiceClassApi;

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

    let mut context = ServiceClassApi::Context::default();
    let result = client.getServiceClasses(operatorId, offset, limit, filter, select, countOnly, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
operatorId*
UUID (uuid)
The operator
Required
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
select
String
Supply a list of operators comma separated
countOnly
Boolean
return the number of operators

Responses


updateServiceClass

Update a service class


/serviceClass/{uuid}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/serviceClass/{uuid}" \
 -d '{
  "billingCode" : "billingCode",
  "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 ]
  },
  "period" : "monthly",
  "variables" : [ {
    "prefix" : "prefix",
    "weight" : 0,
    "type" : "integer",
    "value" : "value"
  }, {
    "prefix" : "prefix",
    "weight" : 0,
    "type" : "integer",
    "value" : "value"
  } ],
  "cost" : 0.8008281904610115,
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "currency" : "currency",
  "defaultService" : false,
  "operatorId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceClassApi;

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

public class ServiceClassApiExample {
    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
        ServiceClassApi apiInstance = new ServiceClassApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        ServiceClass serviceClass = ; // ServiceClass | 

        try {
            apiInstance.updateServiceClass(uuid, serviceClass);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceClassApi#updateServiceClass");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ServiceClassApi;

public class ServiceClassApiExample {
    public static void main(String[] args) {
        ServiceClassApi apiInstance = new ServiceClassApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        ServiceClass serviceClass = ; // ServiceClass | 

        try {
            apiInstance.updateServiceClass(uuid, serviceClass);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceClassApi#updateServiceClass");
            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
ServiceClassApi *apiInstance = [[ServiceClassApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
ServiceClass *serviceClass = ; //  (optional)

// Update a service class
[apiInstance updateServiceClassWith:uuid
    serviceClass:serviceClass
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.ServiceClassApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'serviceClass':  // {ServiceClass} 
};

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

namespace Example
{
    public class updateServiceClassExample
    {
        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 ServiceClassApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var serviceClass = new ServiceClass(); // ServiceClass |  (optional) 

            try {
                // Update a service class
                apiInstance.updateServiceClass(uuid, serviceClass);
            } catch (Exception e) {
                Debug.Print("Exception when calling ServiceClassApi.updateServiceClass: " + 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\ServiceClassApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$serviceClass = ; // ServiceClass | 

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

# 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::ServiceClassApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $serviceClass = WWW::OPenAPIClient::Object::ServiceClass->new(); # ServiceClass | 

eval {
    $api_instance->updateServiceClass(uuid => $uuid, serviceClass => $serviceClass);
};
if ($@) {
    warn "Exception when calling ServiceClassApi->updateServiceClass: $@\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.ServiceClassApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
serviceClass =  # ServiceClass |  (optional)

try:
    # Update a service class
    api_instance.update_service_class(uuid, serviceClass=serviceClass)
except ApiException as e:
    print("Exception when calling ServiceClassApi->updateServiceClass: %s\n" % e)
extern crate ServiceClassApi;

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

    let mut context = ServiceClassApi::Context::default();
    let result = client.updateServiceClass(uuid, serviceClass, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
serviceClass

Responses


SubscriberDevices

createSubscriberDevice

Create a subscriber device


/subscriberDevice/{uuid}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/subscriberDevice/{uuid}" \
 -d '{
  "deviceType" : "deviceType",
  "serialNumber" : "serialNumber",
  "serviceClass" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "configuration" : [ {
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "weight" : 0
  }, {
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "weight" : 0
  } ],
  "realMacAddress" : "realMacAddress",
  "subscriberId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "geoCode" : "geoCode",
  "locale" : "locale",
  "suspended" : false,
  "billingCode" : "billingCode",
  "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 ]
  },
  "deviceRules" : {
    "firmwareUpgrade" : "true",
    "rcOnly" : "true",
    "rrm" : "true"
  },
  "qrCode" : "qrCode",
  "contact" : {
    "firstname" : "firstname",
    "secondaryEmail" : "secondaryEmail",
    "initials" : "initials",
    "mobiles" : [ "mobiles", "mobiles" ],
    "visual" : "visual",
    "phones" : [ "phones", "phones" ],
    "salutation" : "salutation",
    "type" : "SUBSCRIBER",
    "title" : "title",
    "primaryEmail" : "primaryEmail",
    "lastname" : "lastname",
    "accessPIN" : "accessPIN"
  },
  "location" : {
    "buildingName" : "buildingName",
    "country" : "country",
    "city" : "city",
    "mobiles" : [ "mobiles", "mobiles" ],
    "phones" : [ "phones", "phones" ],
    "geoCode" : "geoCode",
    "addressLines" : [ "addressLines", "addressLines" ],
    "state" : "state",
    "postal" : "postal",
    "type" : "SERVICE"
  },
  "state" : "state",
  "operatorId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriberDevicesApi;

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

public class SubscriberDevicesApiExample {
    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
        SubscriberDevicesApi apiInstance = new SubscriberDevicesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        SubscriberDevice subscriberDevice = ; // SubscriberDevice | 

        try {
            apiInstance.createSubscriberDevice(uuid, subscriberDevice);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberDevicesApi#createSubscriberDevice");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriberDevicesApi;

public class SubscriberDevicesApiExample {
    public static void main(String[] args) {
        SubscriberDevicesApi apiInstance = new SubscriberDevicesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        SubscriberDevice subscriberDevice = ; // SubscriberDevice | 

        try {
            apiInstance.createSubscriberDevice(uuid, subscriberDevice);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberDevicesApi#createSubscriberDevice");
            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
SubscriberDevicesApi *apiInstance = [[SubscriberDevicesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
SubscriberDevice *subscriberDevice = ; //  (optional)

// Create a subscriber device
[apiInstance createSubscriberDeviceWith:uuid
    subscriberDevice:subscriberDevice
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.SubscriberDevicesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'subscriberDevice':  // {SubscriberDevice} 
};

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

namespace Example
{
    public class createSubscriberDeviceExample
    {
        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 SubscriberDevicesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var subscriberDevice = new SubscriberDevice(); // SubscriberDevice |  (optional) 

            try {
                // Create a subscriber device
                apiInstance.createSubscriberDevice(uuid, subscriberDevice);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberDevicesApi.createSubscriberDevice: " + 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\SubscriberDevicesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$subscriberDevice = ; // SubscriberDevice | 

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

# 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::SubscriberDevicesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $subscriberDevice = WWW::OPenAPIClient::Object::SubscriberDevice->new(); # SubscriberDevice | 

eval {
    $api_instance->createSubscriberDevice(uuid => $uuid, subscriberDevice => $subscriberDevice);
};
if ($@) {
    warn "Exception when calling SubscriberDevicesApi->createSubscriberDevice: $@\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.SubscriberDevicesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
subscriberDevice =  # SubscriberDevice |  (optional)

try:
    # Create a subscriber device
    api_instance.create_subscriber_device(uuid, subscriberDevice=subscriberDevice)
except ApiException as e:
    print("Exception when calling SubscriberDevicesApi->createSubscriberDevice: %s\n" % e)
extern crate SubscriberDevicesApi;

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

    let mut context = SubscriberDevicesApi::Context::default();
    let result = client.createSubscriberDevice(uuid, subscriberDevice, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
subscriberDevice

Responses


deleteSubscriberDevice

Delete a subscriber device


/subscriberDevice/{uuid}

Usage and SDK Samples

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

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

public class SubscriberDevicesApiExample {
    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
        SubscriberDevicesApi apiInstance = new SubscriberDevicesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

        try {
            apiInstance.deleteSubscriberDevice(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberDevicesApi#deleteSubscriberDevice");
            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
SubscriberDevicesApi *apiInstance = [[SubscriberDevicesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Delete a subscriber device
[apiInstance deleteSubscriberDeviceWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.SubscriberDevicesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class deleteSubscriberDeviceExample
    {
        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 SubscriberDevicesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Delete a subscriber device
                apiInstance.deleteSubscriberDevice(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberDevicesApi.deleteSubscriberDevice: " + 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\SubscriberDevicesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::SubscriberDevicesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->deleteSubscriberDevice(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling SubscriberDevicesApi->deleteSubscriberDevice: $@\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.SubscriberDevicesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Delete a subscriber device
    api_instance.delete_subscriber_device(uuid)
except ApiException as e:
    print("Exception when calling SubscriberDevicesApi->deleteSubscriberDevice: %s\n" % e)
extern crate SubscriberDevicesApi;

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

    let mut context = SubscriberDevicesApi::Context::default();
    let result = client.deleteSubscriberDevice(uuid, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


getSubscriberDevice

Retrieve a subscriber device


/subscriberDevice/{uuid}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16005/api/v1/subscriberDevice/{uuid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriberDevicesApi;

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

public class SubscriberDevicesApiExample {
    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
        SubscriberDevicesApi apiInstance = new SubscriberDevicesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

        try {
            apiInstance.getSubscriberDevice(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberDevicesApi#getSubscriberDevice");
            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
SubscriberDevicesApi *apiInstance = [[SubscriberDevicesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Retrieve a subscriber device
[apiInstance getSubscriberDeviceWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.SubscriberDevicesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class getSubscriberDeviceExample
    {
        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 SubscriberDevicesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Retrieve a subscriber device
                apiInstance.getSubscriberDevice(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberDevicesApi.getSubscriberDevice: " + 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\SubscriberDevicesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::SubscriberDevicesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->getSubscriberDevice(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling SubscriberDevicesApi->getSubscriberDevice: $@\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.SubscriberDevicesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Retrieve a subscriber device
    api_instance.get_subscriber_device(uuid)
except ApiException as e:
    print("Exception when calling SubscriberDevicesApi->getSubscriberDevice: %s\n" % e)
extern crate SubscriberDevicesApi;

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

    let mut context = SubscriberDevicesApi::Context::default();
    let result = client.getSubscriberDevice(uuid, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


getsubscriberDevices

Retrieve the list of subscriber devices


/subscriberDevice

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/subscriberDevice?operatorId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&filter=filter_example&select=serial1,serial2,serial3&countOnly=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriberDevicesApi;

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

public class SubscriberDevicesApiExample {
    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
        SubscriberDevicesApi apiInstance = new SubscriberDevicesApi();
        UUID operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The operator
        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
        String select = serial1,serial2,serial3; // String | Supply a list of operators comma separated
        Boolean countOnly = true; // Boolean | return the number of operators

        try {
            getsubscriberDevices_200_response result = apiInstance.getsubscriberDevices(operatorId, offset, limit, filter, select, countOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberDevicesApi#getsubscriberDevices");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriberDevicesApi;

public class SubscriberDevicesApiExample {
    public static void main(String[] args) {
        SubscriberDevicesApi apiInstance = new SubscriberDevicesApi();
        UUID operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The operator
        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
        String select = serial1,serial2,serial3; // String | Supply a list of operators comma separated
        Boolean countOnly = true; // Boolean | return the number of operators

        try {
            getsubscriberDevices_200_response result = apiInstance.getsubscriberDevices(operatorId, offset, limit, filter, select, countOnly);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberDevicesApi#getsubscriberDevices");
            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
SubscriberDevicesApi *apiInstance = [[SubscriberDevicesApi alloc] init];
UUID *operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The operator (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 *filter = filter_example; // Filter the results (optional) (default to null)
String *select = serial1,serial2,serial3; // Supply a list of operators comma separated (optional) (default to null)
Boolean *countOnly = true; // return the number of operators (optional) (default to null)

// Retrieve the list of subscriber devices
[apiInstance getsubscriberDevicesWith:operatorId
    offset:offset
    limit:limit
    filter:filter
    select:select
    countOnly:countOnly
              completionHandler: ^(getsubscriberDevices_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.SubscriberDevicesApi()
var operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The operator
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
  'select': serial1,serial2,serial3, // {String} Supply a list of operators comma separated
  'countOnly': true // {Boolean} return the number of operators
};

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

namespace Example
{
    public class getsubscriberDevicesExample
    {
        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 SubscriberDevicesApi();
            var operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The operator (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 filter = filter_example;  // String | Filter the results (optional)  (default to null)
            var select = serial1,serial2,serial3;  // String | Supply a list of operators comma separated (optional)  (default to null)
            var countOnly = true;  // Boolean | return the number of operators (optional)  (default to null)

            try {
                // Retrieve the list of subscriber devices
                getsubscriberDevices_200_response result = apiInstance.getsubscriberDevices(operatorId, offset, limit, filter, select, countOnly);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberDevicesApi.getsubscriberDevices: " + 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\SubscriberDevicesApi();
$operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The operator
$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
$select = serial1,serial2,serial3; // String | Supply a list of operators comma separated
$countOnly = true; // Boolean | return the number of operators

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

# 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::SubscriberDevicesApi->new();
my $operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The operator
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 $select = serial1,serial2,serial3; # String | Supply a list of operators comma separated
my $countOnly = true; # Boolean | return the number of operators

eval {
    my $result = $api_instance->getsubscriberDevices(operatorId => $operatorId, offset => $offset, limit => $limit, filter => $filter, select => $select, countOnly => $countOnly);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubscriberDevicesApi->getsubscriberDevices: $@\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.SubscriberDevicesApi()
operatorId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The operator (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)
filter = filter_example # String | Filter the results (optional) (default to null)
select = serial1,serial2,serial3 # String | Supply a list of operators comma separated (optional) (default to null)
countOnly = true # Boolean | return the number of operators (optional) (default to null)

try:
    # Retrieve the list of subscriber devices
    api_response = api_instance.getsubscriber_devices(operatorId, offset=offset, limit=limit, filter=filter, select=select, countOnly=countOnly)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriberDevicesApi->getsubscriberDevices: %s\n" % e)
extern crate SubscriberDevicesApi;

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

    let mut context = SubscriberDevicesApi::Context::default();
    let result = client.getsubscriberDevices(operatorId, offset, limit, filter, select, countOnly, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
operatorId*
UUID (uuid)
The operator
Required
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
select
String
Supply a list of operators comma separated
countOnly
Boolean
return the number of operators

Responses


updateSubscriberDevice

Update a subscriber device


/subscriberDevice/{uuid}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/subscriberDevice/{uuid}" \
 -d '{
  "deviceType" : "deviceType",
  "serialNumber" : "serialNumber",
  "serviceClass" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "configuration" : [ {
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "weight" : 0
  }, {
    "configuration" : "configuration",
    "name" : "name",
    "description" : "description",
    "weight" : 0
  } ],
  "realMacAddress" : "realMacAddress",
  "subscriberId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "geoCode" : "geoCode",
  "locale" : "locale",
  "suspended" : false,
  "billingCode" : "billingCode",
  "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 ]
  },
  "deviceRules" : {
    "firmwareUpgrade" : "true",
    "rcOnly" : "true",
    "rrm" : "true"
  },
  "qrCode" : "qrCode",
  "contact" : {
    "firstname" : "firstname",
    "secondaryEmail" : "secondaryEmail",
    "initials" : "initials",
    "mobiles" : [ "mobiles", "mobiles" ],
    "visual" : "visual",
    "phones" : [ "phones", "phones" ],
    "salutation" : "salutation",
    "type" : "SUBSCRIBER",
    "title" : "title",
    "primaryEmail" : "primaryEmail",
    "lastname" : "lastname",
    "accessPIN" : "accessPIN"
  },
  "location" : {
    "buildingName" : "buildingName",
    "country" : "country",
    "city" : "city",
    "mobiles" : [ "mobiles", "mobiles" ],
    "phones" : [ "phones", "phones" ],
    "geoCode" : "geoCode",
    "addressLines" : [ "addressLines", "addressLines" ],
    "state" : "state",
    "postal" : "postal",
    "type" : "SERVICE"
  },
  "state" : "state",
  "operatorId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriberDevicesApi;

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

public class SubscriberDevicesApiExample {
    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
        SubscriberDevicesApi apiInstance = new SubscriberDevicesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        SubscriberDevice subscriberDevice = ; // SubscriberDevice | 

        try {
            apiInstance.updateSubscriberDevice(uuid, subscriberDevice);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberDevicesApi#updateSubscriberDevice");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriberDevicesApi;

public class SubscriberDevicesApiExample {
    public static void main(String[] args) {
        SubscriberDevicesApi apiInstance = new SubscriberDevicesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        SubscriberDevice subscriberDevice = ; // SubscriberDevice | 

        try {
            apiInstance.updateSubscriberDevice(uuid, subscriberDevice);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberDevicesApi#updateSubscriberDevice");
            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
SubscriberDevicesApi *apiInstance = [[SubscriberDevicesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
SubscriberDevice *subscriberDevice = ; //  (optional)

// Update a subscriber device
[apiInstance updateSubscriberDeviceWith:uuid
    subscriberDevice:subscriberDevice
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.SubscriberDevicesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'subscriberDevice':  // {SubscriberDevice} 
};

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

namespace Example
{
    public class updateSubscriberDeviceExample
    {
        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 SubscriberDevicesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var subscriberDevice = new SubscriberDevice(); // SubscriberDevice |  (optional) 

            try {
                // Update a subscriber device
                apiInstance.updateSubscriberDevice(uuid, subscriberDevice);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberDevicesApi.updateSubscriberDevice: " + 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\SubscriberDevicesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$subscriberDevice = ; // SubscriberDevice | 

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

# 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::SubscriberDevicesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $subscriberDevice = WWW::OPenAPIClient::Object::SubscriberDevice->new(); # SubscriberDevice | 

eval {
    $api_instance->updateSubscriberDevice(uuid => $uuid, subscriberDevice => $subscriberDevice);
};
if ($@) {
    warn "Exception when calling SubscriberDevicesApi->updateSubscriberDevice: $@\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.SubscriberDevicesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
subscriberDevice =  # SubscriberDevice |  (optional)

try:
    # Update a subscriber device
    api_instance.update_subscriber_device(uuid, subscriberDevice=subscriberDevice)
except ApiException as e:
    print("Exception when calling SubscriberDevicesApi->updateSubscriberDevice: %s\n" % e)
extern crate SubscriberDevicesApi;

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

    let mut context = SubscriberDevicesApi::Context::default();
    let result = client.updateSubscriberDevice(uuid, subscriberDevice, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
subscriberDevice

Responses


SubscriberRegistration

deleteSignup

This call allows someone to delete a specific signUp or all signups according to serialNumber of email address


/signup

Usage and SDK Samples

curl -X DELETE \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16005/api/v1/signup?email=email_example&macAddress=macAddress_example&signupUUID=38400000-8cf0-11bd-b23e-10b96e4ef00d&deviceID=deviceID_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriberRegistrationApi;

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

public class SubscriberRegistrationApiExample {
    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
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        String email = email_example; // String | 
        String macAddress = macAddress_example; // String | 
        UUID signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String deviceID = deviceID_example; // String | 

        try {
            apiInstance.deleteSignup(email, macAddress, signupUUID, deviceID);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#deleteSignup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriberRegistrationApi;

public class SubscriberRegistrationApiExample {
    public static void main(String[] args) {
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        String email = email_example; // String | 
        String macAddress = macAddress_example; // String | 
        UUID signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String deviceID = deviceID_example; // String | 

        try {
            apiInstance.deleteSignup(email, macAddress, signupUUID, deviceID);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#deleteSignup");
            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
SubscriberRegistrationApi *apiInstance = [[SubscriberRegistrationApi alloc] init];
String *email = email_example; //  (optional) (default to null)
String *macAddress = macAddress_example; //  (optional) (default to null)
UUID *signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (optional) (default to null)
String *deviceID = deviceID_example; //  (optional) (default to null)

// This call allows someone to delete a specific signUp or all signups according to serialNumber of email address
[apiInstance deleteSignupWith:email
    macAddress:macAddress
    signupUUID:signupUUID
    deviceID:deviceID
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.SubscriberRegistrationApi()
var opts = {
  'email': email_example, // {String} 
  'macAddress': macAddress_example, // {String} 
  'signupUUID': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} 
  'deviceID': deviceID_example // {String} 
};

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

namespace Example
{
    public class deleteSignupExample
    {
        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 SubscriberRegistrationApi();
            var email = email_example;  // String |  (optional)  (default to null)
            var macAddress = macAddress_example;  // String |  (optional)  (default to null)
            var signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (optional)  (default to null)
            var deviceID = deviceID_example;  // String |  (optional)  (default to null)

            try {
                // This call allows someone to delete a specific signUp or all signups according to serialNumber of email address
                apiInstance.deleteSignup(email, macAddress, signupUUID, deviceID);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberRegistrationApi.deleteSignup: " + 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\SubscriberRegistrationApi();
$email = email_example; // String | 
$macAddress = macAddress_example; // String | 
$signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$deviceID = deviceID_example; // String | 

try {
    $api_instance->deleteSignup($email, $macAddress, $signupUUID, $deviceID);
} catch (Exception $e) {
    echo 'Exception when calling SubscriberRegistrationApi->deleteSignup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriberRegistrationApi;

# 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::SubscriberRegistrationApi->new();
my $email = email_example; # String | 
my $macAddress = macAddress_example; # String | 
my $signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $deviceID = deviceID_example; # String | 

eval {
    $api_instance->deleteSignup(email => $email, macAddress => $macAddress, signupUUID => $signupUUID, deviceID => $deviceID);
};
if ($@) {
    warn "Exception when calling SubscriberRegistrationApi->deleteSignup: $@\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.SubscriberRegistrationApi()
email = email_example # String |  (optional) (default to null)
macAddress = macAddress_example # String |  (optional) (default to null)
signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (optional) (default to null)
deviceID = deviceID_example # String |  (optional) (default to null)

try:
    # This call allows someone to delete a specific signUp or all signups according to serialNumber of email address
    api_instance.delete_signup(email=email, macAddress=macAddress, signupUUID=signupUUID, deviceID=deviceID)
except ApiException as e:
    print("Exception when calling SubscriberRegistrationApi->deleteSignup: %s\n" % e)
extern crate SubscriberRegistrationApi;

pub fn main() {
    let email = email_example; // String
    let macAddress = macAddress_example; // String
    let signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let deviceID = deviceID_example; // String

    let mut context = SubscriberRegistrationApi::Context::default();
    let result = client.deleteSignup(email, macAddress, signupUUID, deviceID, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
email
String (email)
macAddress
String
signupUUID
UUID (uuid)
deviceID
String

Responses


getSignup

This call allows someone to get the status of a signup.


/signup

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/signup?email=email_example&macAddress=macAddress_example&signupUUID=38400000-8cf0-11bd-b23e-10b96e4ef00d&dashboard=true&deviceID=deviceID_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriberRegistrationApi;

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

public class SubscriberRegistrationApiExample {
    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
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        String email = email_example; // String | 
        String macAddress = macAddress_example; // String | 
        UUID signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean dashboard = true; // Boolean | 
        String deviceID = deviceID_example; // String | 

        try {
            getSignup_200_response result = apiInstance.getSignup(email, macAddress, signupUUID, dashboard, deviceID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#getSignup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriberRegistrationApi;

public class SubscriberRegistrationApiExample {
    public static void main(String[] args) {
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        String email = email_example; // String | 
        String macAddress = macAddress_example; // String | 
        UUID signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean dashboard = true; // Boolean | 
        String deviceID = deviceID_example; // String | 

        try {
            getSignup_200_response result = apiInstance.getSignup(email, macAddress, signupUUID, dashboard, deviceID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#getSignup");
            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
SubscriberRegistrationApi *apiInstance = [[SubscriberRegistrationApi alloc] init];
String *email = email_example; //  (optional) (default to null)
String *macAddress = macAddress_example; //  (optional) (default to null)
UUID *signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (optional) (default to null)
Boolean *dashboard = true; //  (optional) (default to false)
String *deviceID = deviceID_example; //  (optional) (default to null)

// This call allows someone to get the status of a signup.
[apiInstance getSignupWith:email
    macAddress:macAddress
    signupUUID:signupUUID
    dashboard:dashboard
    deviceID:deviceID
              completionHandler: ^(getSignup_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.SubscriberRegistrationApi()
var opts = {
  'email': email_example, // {String} 
  'macAddress': macAddress_example, // {String} 
  'signupUUID': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} 
  'dashboard': true, // {Boolean} 
  'deviceID': deviceID_example // {String} 
};

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

namespace Example
{
    public class getSignupExample
    {
        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 SubscriberRegistrationApi();
            var email = email_example;  // String |  (optional)  (default to null)
            var macAddress = macAddress_example;  // String |  (optional)  (default to null)
            var signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (optional)  (default to null)
            var dashboard = true;  // Boolean |  (optional)  (default to false)
            var deviceID = deviceID_example;  // String |  (optional)  (default to null)

            try {
                // This call allows someone to get the status of a signup.
                getSignup_200_response result = apiInstance.getSignup(email, macAddress, signupUUID, dashboard, deviceID);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberRegistrationApi.getSignup: " + 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\SubscriberRegistrationApi();
$email = email_example; // String | 
$macAddress = macAddress_example; // String | 
$signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$dashboard = true; // Boolean | 
$deviceID = deviceID_example; // String | 

try {
    $result = $api_instance->getSignup($email, $macAddress, $signupUUID, $dashboard, $deviceID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubscriberRegistrationApi->getSignup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriberRegistrationApi;

# 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::SubscriberRegistrationApi->new();
my $email = email_example; # String | 
my $macAddress = macAddress_example; # String | 
my $signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $dashboard = true; # Boolean | 
my $deviceID = deviceID_example; # String | 

eval {
    my $result = $api_instance->getSignup(email => $email, macAddress => $macAddress, signupUUID => $signupUUID, dashboard => $dashboard, deviceID => $deviceID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubscriberRegistrationApi->getSignup: $@\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.SubscriberRegistrationApi()
email = email_example # String |  (optional) (default to null)
macAddress = macAddress_example # String |  (optional) (default to null)
signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (optional) (default to null)
dashboard = true # Boolean |  (optional) (default to false)
deviceID = deviceID_example # String |  (optional) (default to null)

try:
    # This call allows someone to get the status of a signup.
    api_response = api_instance.get_signup(email=email, macAddress=macAddress, signupUUID=signupUUID, dashboard=dashboard, deviceID=deviceID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriberRegistrationApi->getSignup: %s\n" % e)
extern crate SubscriberRegistrationApi;

pub fn main() {
    let email = email_example; // String
    let macAddress = macAddress_example; // String
    let signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let dashboard = true; // Boolean
    let deviceID = deviceID_example; // String

    let mut context = SubscriberRegistrationApi::Context::default();
    let result = client.getSignup(email, macAddress, signupUUID, dashboard, deviceID, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
email
String (email)
macAddress
String
signupUUID
UUID (uuid)
dashboard
Boolean
deviceID
String

Responses


modifySignup

modify the signup command in play


/signup

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/signup?signupUUID=38400000-8cf0-11bd-b23e-10b96e4ef00d&operation=operation_example" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriberRegistrationApi;

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

public class SubscriberRegistrationApiExample {
    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
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        UUID signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String operation = operation_example; // String | 
        ModifySignupRequest modifySignupRequest = ; // ModifySignupRequest | 

        try {
            apiInstance.modifySignup(signupUUID, operation, modifySignupRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#modifySignup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriberRegistrationApi;

public class SubscriberRegistrationApiExample {
    public static void main(String[] args) {
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        UUID signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String operation = operation_example; // String | 
        ModifySignupRequest modifySignupRequest = ; // ModifySignupRequest | 

        try {
            apiInstance.modifySignup(signupUUID, operation, modifySignupRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#modifySignup");
            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
SubscriberRegistrationApi *apiInstance = [[SubscriberRegistrationApi alloc] init];
UUID *signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
String *operation = operation_example; //  (default to null)
ModifySignupRequest *modifySignupRequest = ; //  (optional)

// modify the signup command in play
[apiInstance modifySignupWith:signupUUID
    operation:operation
    modifySignupRequest:modifySignupRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.SubscriberRegistrationApi()
var signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var operation = operation_example; // {String} 
var opts = {
  'modifySignupRequest':  // {ModifySignupRequest} 
};

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

namespace Example
{
    public class modifySignupExample
    {
        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 SubscriberRegistrationApi();
            var signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var operation = operation_example;  // String |  (default to null)
            var modifySignupRequest = new ModifySignupRequest(); // ModifySignupRequest |  (optional) 

            try {
                // modify the signup command in play
                apiInstance.modifySignup(signupUUID, operation, modifySignupRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberRegistrationApi.modifySignup: " + 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\SubscriberRegistrationApi();
$signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$operation = operation_example; // String | 
$modifySignupRequest = ; // ModifySignupRequest | 

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

# 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::SubscriberRegistrationApi->new();
my $signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $operation = operation_example; # String | 
my $modifySignupRequest = WWW::OPenAPIClient::Object::ModifySignupRequest->new(); # ModifySignupRequest | 

eval {
    $api_instance->modifySignup(signupUUID => $signupUUID, operation => $operation, modifySignupRequest => $modifySignupRequest);
};
if ($@) {
    warn "Exception when calling SubscriberRegistrationApi->modifySignup: $@\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.SubscriberRegistrationApi()
signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
operation = operation_example # String |  (default to null)
modifySignupRequest =  # ModifySignupRequest |  (optional)

try:
    # modify the signup command in play
    api_instance.modify_signup(signupUUID, operation, modifySignupRequest=modifySignupRequest)
except ApiException as e:
    print("Exception when calling SubscriberRegistrationApi->modifySignup: %s\n" % e)
extern crate SubscriberRegistrationApi;

pub fn main() {
    let signupUUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let operation = operation_example; // String
    let modifySignupRequest = ; // ModifySignupRequest

    let mut context = SubscriberRegistrationApi::Context::default();
    let result = client.modifySignup(signupUUID, operation, modifySignupRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
modifySignupRequest

Query parameters
Name Description
signupUUID*
UUID (uuid)
Required
operation*
String
Required

Responses


postSignup

This call allows a new subscriber to register themselves and their devices.


/signup

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16005/api/v1/signup?email=email_example&macAddress=macAddress_example&deviceID=deviceID_example®istrationId=registrationId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriberRegistrationApi;

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

public class SubscriberRegistrationApiExample {
    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
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        String email = email_example; // String | 
        String macAddress = macAddress_example; // String | 
        String registrationId = registrationId_example; // String | 
        String deviceID = deviceID_example; // String | 

        try {
            apiInstance.postSignup(email, macAddress, registrationId, deviceID);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#postSignup");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriberRegistrationApi;

public class SubscriberRegistrationApiExample {
    public static void main(String[] args) {
        SubscriberRegistrationApi apiInstance = new SubscriberRegistrationApi();
        String email = email_example; // String | 
        String macAddress = macAddress_example; // String | 
        String registrationId = registrationId_example; // String | 
        String deviceID = deviceID_example; // String | 

        try {
            apiInstance.postSignup(email, macAddress, registrationId, deviceID);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriberRegistrationApi#postSignup");
            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
SubscriberRegistrationApi *apiInstance = [[SubscriberRegistrationApi alloc] init];
String *email = email_example; //  (default to null)
String *macAddress = macAddress_example; //  (default to null)
String *registrationId = registrationId_example; //  (default to null)
String *deviceID = deviceID_example; //  (optional) (default to null)

// This call allows a new subscriber to register themselves and their devices.
[apiInstance postSignupWith:email
    macAddress:macAddress
    registrationId:registrationId
    deviceID:deviceID
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.SubscriberRegistrationApi()
var email = email_example; // {String} 
var macAddress = macAddress_example; // {String} 
var registrationId = registrationId_example; // {String} 
var opts = {
  'deviceID': deviceID_example // {String} 
};

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

namespace Example
{
    public class postSignupExample
    {
        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 SubscriberRegistrationApi();
            var email = email_example;  // String |  (default to null)
            var macAddress = macAddress_example;  // String |  (default to null)
            var registrationId = registrationId_example;  // String |  (default to null)
            var deviceID = deviceID_example;  // String |  (optional)  (default to null)

            try {
                // This call allows a new subscriber to register themselves and their devices.
                apiInstance.postSignup(email, macAddress, registrationId, deviceID);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriberRegistrationApi.postSignup: " + 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\SubscriberRegistrationApi();
$email = email_example; // String | 
$macAddress = macAddress_example; // String | 
$registrationId = registrationId_example; // String | 
$deviceID = deviceID_example; // String | 

try {
    $api_instance->postSignup($email, $macAddress, $registrationId, $deviceID);
} catch (Exception $e) {
    echo 'Exception when calling SubscriberRegistrationApi->postSignup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriberRegistrationApi;

# 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::SubscriberRegistrationApi->new();
my $email = email_example; # String | 
my $macAddress = macAddress_example; # String | 
my $registrationId = registrationId_example; # String | 
my $deviceID = deviceID_example; # String | 

eval {
    $api_instance->postSignup(email => $email, macAddress => $macAddress, registrationId => $registrationId, deviceID => $deviceID);
};
if ($@) {
    warn "Exception when calling SubscriberRegistrationApi->postSignup: $@\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.SubscriberRegistrationApi()
email = email_example # String |  (default to null)
macAddress = macAddress_example # String |  (default to null)
registrationId = registrationId_example # String |  (default to null)
deviceID = deviceID_example # String |  (optional) (default to null)

try:
    # This call allows a new subscriber to register themselves and their devices.
    api_instance.post_signup(email, macAddress, registrationId, deviceID=deviceID)
except ApiException as e:
    print("Exception when calling SubscriberRegistrationApi->postSignup: %s\n" % e)
extern crate SubscriberRegistrationApi;

pub fn main() {
    let email = email_example; // String
    let macAddress = macAddress_example; // String
    let registrationId = registrationId_example; // String
    let deviceID = deviceID_example; // String

    let mut context = SubscriberRegistrationApi::Context::default();
    let result = client.postSignup(email, macAddress, registrationId, deviceID, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
email*
String (email)
Required
macAddress*
String
Required
deviceID
String
registrationId*
String
Required

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:16005/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 OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.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:16005/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 OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.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:16005/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 OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.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:16005/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 OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.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:16005/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 OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.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


Utility

getIpToCountry

Get the country code for an IP address


/iptocountry

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/iptocountry?iplist=10.2.2.2,10.3.4.3"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UtilityApi;

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

public class UtilityApiExample {
    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
        UtilityApi apiInstance = new UtilityApi();
        String iplist = 10.2.2.2,10.3.4.3; // String | 

        try {
            getIpToCountry_200_response result = apiInstance.getIpToCountry(iplist);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UtilityApi#getIpToCountry");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UtilityApi;

public class UtilityApiExample {
    public static void main(String[] args) {
        UtilityApi apiInstance = new UtilityApi();
        String iplist = 10.2.2.2,10.3.4.3; // String | 

        try {
            getIpToCountry_200_response result = apiInstance.getIpToCountry(iplist);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UtilityApi#getIpToCountry");
            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
UtilityApi *apiInstance = [[UtilityApi alloc] init];
String *iplist = 10.2.2.2,10.3.4.3; //  (default to null)

// Get the country code for an IP address
[apiInstance getIpToCountryWith:iplist
              completionHandler: ^(getIpToCountry_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.UtilityApi()
var iplist = 10.2.2.2,10.3.4.3; // {String} 

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

namespace Example
{
    public class getIpToCountryExample
    {
        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 UtilityApi();
            var iplist = 10.2.2.2,10.3.4.3;  // String |  (default to null)

            try {
                // Get the country code for an IP address
                getIpToCountry_200_response result = apiInstance.getIpToCountry(iplist);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UtilityApi.getIpToCountry: " + 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\UtilityApi();
$iplist = 10.2.2.2,10.3.4.3; // String | 

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

# 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::UtilityApi->new();
my $iplist = 10.2.2.2,10.3.4.3; # String | 

eval {
    my $result = $api_instance->getIpToCountry(iplist => $iplist);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UtilityApi->getIpToCountry: $@\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.UtilityApi()
iplist = 10.2.2.2,10.3.4.3 # String |  (default to null)

try:
    # Get the country code for an IP address
    api_response = api_instance.get_ip_to_country(iplist)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UtilityApi->getIpToCountry: %s\n" % e)
extern crate UtilityApi;

pub fn main() {
    let iplist = 10.2.2.2,10.3.4.3; // String

    let mut context = UtilityApi::Context::default();
    let result = client.getIpToCountry(iplist, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
iplist*
String
Required

Responses


VariableConfigurationBlocks

getVariableList

Retrieve lists of control blocks


/variable

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16005/api/v1/variable?venue=38400000-8cf0-11bd-b23e-10b96e4ef00d&entity=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&filter=filter_example&select=serial1,serial2,serial3&countOnly=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VariableConfigurationBlocksApi;

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

public class VariableConfigurationBlocksApiExample {
    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
        VariableConfigurationBlocksApi apiInstance = new VariableConfigurationBlocksApi();
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UUID entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        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
        String select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
        Boolean countOnly = true; // Boolean | return the number of devices

        try {
            apiInstance.getVariableList(venue, entity, offset, limit, filter, select, countOnly);
        } catch (ApiException e) {
            System.err.println("Exception when calling VariableConfigurationBlocksApi#getVariableList");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VariableConfigurationBlocksApi;

public class VariableConfigurationBlocksApiExample {
    public static void main(String[] args) {
        VariableConfigurationBlocksApi apiInstance = new VariableConfigurationBlocksApi();
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UUID entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        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
        String select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
        Boolean countOnly = true; // Boolean | return the number of devices

        try {
            apiInstance.getVariableList(venue, entity, offset, limit, filter, select, countOnly);
        } catch (ApiException e) {
            System.err.println("Exception when calling VariableConfigurationBlocksApi#getVariableList");
            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
VariableConfigurationBlocksApi *apiInstance = [[VariableConfigurationBlocksApi alloc] init];
UUID *venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (optional) (default to null)
UUID *entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (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 *filter = filter_example; // Filter the results (optional) (default to null)
String *select = serial1,serial2,serial3; // Supply a list of devices comma separated (optional) (default to null)
Boolean *countOnly = true; // return the number of devices (optional) (default to null)

// Retrieve lists of control blocks
[apiInstance getVariableListWith:venue
    entity:entity
    offset:offset
    limit:limit
    filter:filter
    select:select
    countOnly:countOnly
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.VariableConfigurationBlocksApi()
var opts = {
  'venue': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} 
  'entity': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} 
  '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
  'select': serial1,serial2,serial3, // {String} Supply a list of devices comma separated
  'countOnly': true // {Boolean} return the number of devices
};

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

namespace Example
{
    public class getVariableListExample
    {
        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 VariableConfigurationBlocksApi();
            var venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (optional)  (default to null)
            var entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (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 filter = filter_example;  // String | Filter the results (optional)  (default to null)
            var select = serial1,serial2,serial3;  // String | Supply a list of devices comma separated (optional)  (default to null)
            var countOnly = true;  // Boolean | return the number of devices (optional)  (default to null)

            try {
                // Retrieve lists of control blocks
                apiInstance.getVariableList(venue, entity, offset, limit, filter, select, countOnly);
            } catch (Exception e) {
                Debug.Print("Exception when calling VariableConfigurationBlocksApi.getVariableList: " + 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\VariableConfigurationBlocksApi();
$venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$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
$select = serial1,serial2,serial3; // String | Supply a list of devices comma separated
$countOnly = true; // Boolean | return the number of devices

try {
    $api_instance->getVariableList($venue, $entity, $offset, $limit, $filter, $select, $countOnly);
} catch (Exception $e) {
    echo 'Exception when calling VariableConfigurationBlocksApi->getVariableList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VariableConfigurationBlocksApi;

# 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::VariableConfigurationBlocksApi->new();
my $venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
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 $select = serial1,serial2,serial3; # String | Supply a list of devices comma separated
my $countOnly = true; # Boolean | return the number of devices

eval {
    $api_instance->getVariableList(venue => $venue, entity => $entity, offset => $offset, limit => $limit, filter => $filter, select => $select, countOnly => $countOnly);
};
if ($@) {
    warn "Exception when calling VariableConfigurationBlocksApi->getVariableList: $@\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.VariableConfigurationBlocksApi()
venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (optional) (default to null)
entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (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)
filter = filter_example # String | Filter the results (optional) (default to null)
select = serial1,serial2,serial3 # String | Supply a list of devices comma separated (optional) (default to null)
countOnly = true # Boolean | return the number of devices (optional) (default to null)

try:
    # Retrieve lists of control blocks
    api_instance.get_variable_list(venue=venue, entity=entity, offset=offset, limit=limit, filter=filter, select=select, countOnly=countOnly)
except ApiException as e:
    print("Exception when calling VariableConfigurationBlocksApi->getVariableList: %s\n" % e)
extern crate VariableConfigurationBlocksApi;

pub fn main() {
    let venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let filter = filter_example; // String
    let select = serial1,serial2,serial3; // String
    let countOnly = true; // Boolean

    let mut context = VariableConfigurationBlocksApi::Context::default();
    let result = client.getVariableList(venue, entity, offset, limit, filter, select, countOnly, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
venue
UUID (uuid)
entity
UUID (uuid)
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
select
String
Supply a list of devices comma separated
countOnly
Boolean
return the number of devices

Responses


Venues

createVenue

Create a specific venue.


/venue/{uuid}

Usage and SDK Samples

curl -X POST \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/venue/{uuid}?createObjects=" \
 -d '{
  "parent" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "variables" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "maps" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "devices" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "topology" : [ {
    "parent" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "child" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "parent" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "child" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "configurations" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "managementPolicies" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "boards" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "deviceConfiguration" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "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 ]
  },
  "deviceRules" : {
    "firmwareUpgrade" : "true",
    "rcOnly" : "true",
    "rrm" : "true"
  },
  "sourceIP" : {
    "list" : [ "list", "list" ]
  },
  "children" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "design" : "design",
  "location" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "managementRoles" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "contacts" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VenuesApi;

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

public class VenuesApiExample {
    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
        VenuesApi apiInstance = new VenuesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        CreateVenueCreateObjectsParameter createObjects = ; // CreateVenueCreateObjectsParameter | 
        Venue venue = ; // Venue | 

        try {
            apiInstance.createVenue(uuid, createObjects, venue);
        } catch (ApiException e) {
            System.err.println("Exception when calling VenuesApi#createVenue");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VenuesApi;

public class VenuesApiExample {
    public static void main(String[] args) {
        VenuesApi apiInstance = new VenuesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        CreateVenueCreateObjectsParameter createObjects = ; // CreateVenueCreateObjectsParameter | 
        Venue venue = ; // Venue | 

        try {
            apiInstance.createVenue(uuid, createObjects, venue);
        } catch (ApiException e) {
            System.err.println("Exception when calling VenuesApi#createVenue");
            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
VenuesApi *apiInstance = [[VenuesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
CreateVenueCreateObjectsParameter *createObjects = ; //  (optional) (default to null)
Venue *venue = ; //  (optional)

// Create a specific venue.
[apiInstance createVenueWith:uuid
    createObjects:createObjects
    venue:venue
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.VenuesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'createObjects': , // {CreateVenueCreateObjectsParameter} 
  'venue':  // {Venue} 
};

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

namespace Example
{
    public class createVenueExample
    {
        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 VenuesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var createObjects = new CreateVenueCreateObjectsParameter(); // CreateVenueCreateObjectsParameter |  (optional)  (default to null)
            var venue = new Venue(); // Venue |  (optional) 

            try {
                // Create a specific venue.
                apiInstance.createVenue(uuid, createObjects, venue);
            } catch (Exception e) {
                Debug.Print("Exception when calling VenuesApi.createVenue: " + 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\VenuesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$createObjects = ; // CreateVenueCreateObjectsParameter | 
$venue = ; // Venue | 

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

# 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::VenuesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $createObjects = ; # CreateVenueCreateObjectsParameter | 
my $venue = WWW::OPenAPIClient::Object::Venue->new(); # Venue | 

eval {
    $api_instance->createVenue(uuid => $uuid, createObjects => $createObjects, venue => $venue);
};
if ($@) {
    warn "Exception when calling VenuesApi->createVenue: $@\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.VenuesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
createObjects =  # CreateVenueCreateObjectsParameter |  (optional) (default to null)
venue =  # Venue |  (optional)

try:
    # Create a specific venue.
    api_instance.create_venue(uuid, createObjects=createObjects, venue=venue)
except ApiException as e:
    print("Exception when calling VenuesApi->createVenue: %s\n" % e)
extern crate VenuesApi;

pub fn main() {
    let uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let createObjects = ; // CreateVenueCreateObjectsParameter
    let venue = ; // Venue

    let mut context = VenuesApi::Context::default();
    let result = client.createVenue(uuid, createObjects, venue, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
venue

Information used to create the new venue

Query parameters
Name Description
createObjects
CreateVenueCreateObjectsParameter

Responses


deleteVenue

Delete a specific venue.


/venue/{uuid}

Usage and SDK Samples

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

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

public class VenuesApiExample {
    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
        VenuesApi apiInstance = new VenuesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

        try {
            apiInstance.deleteVenue(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling VenuesApi#deleteVenue");
            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
VenuesApi *apiInstance = [[VenuesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Delete a specific venue.
[apiInstance deleteVenueWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.VenuesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class deleteVenueExample
    {
        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 VenuesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Delete a specific venue.
                apiInstance.deleteVenue(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling VenuesApi.deleteVenue: " + 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\VenuesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::VenuesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->deleteVenue(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling VenuesApi->deleteVenue: $@\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.VenuesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Delete a specific venue.
    api_instance.delete_venue(uuid)
except ApiException as e:
    print("Exception when calling VenuesApi->deleteVenue: %s\n" % e)
extern crate VenuesApi;

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

    let mut context = VenuesApi::Context::default();
    let result = client.deleteVenue(uuid, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


getVenue

Retrieve a specific venue.


/venue/{uuid}

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 "https://localhost:16005/api/v1/venue/{uuid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VenuesApi;

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

public class VenuesApiExample {
    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
        VenuesApi apiInstance = new VenuesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

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

        try {
            apiInstance.getVenue(uuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling VenuesApi#getVenue");
            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
VenuesApi *apiInstance = [[VenuesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

// Retrieve a specific venue.
[apiInstance getVenueWith:uuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.VenuesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

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

namespace Example
{
    public class getVenueExample
    {
        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 VenuesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)

            try {
                // Retrieve a specific venue.
                apiInstance.getVenue(uuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling VenuesApi.getVenue: " + 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\VenuesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

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

# 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::VenuesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval {
    $api_instance->getVenue(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling VenuesApi->getVenue: $@\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.VenuesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try:
    # Retrieve a specific venue.
    api_instance.get_venue(uuid)
except ApiException as e:
    print("Exception when calling VenuesApi->getVenue: %s\n" % e)
extern crate VenuesApi;

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

    let mut context = VenuesApi::Context::default();
    let result = client.getVenue(uuid, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required

Responses


getVenues

Retrieve a list of venues.


/venue

Usage and SDK Samples

curl -X GET \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "https://localhost:16005/api/v1/venue?entity=38400000-8cf0-11bd-b23e-10b96e4ef00d&venue=38400000-8cf0-11bd-b23e-10b96e4ef00d&unassigned=true&deviceType=deviceType_example&offset=56&limit=56&filter=filter_example&select=serial1,serial2,serial3&countOnly=true&getDevices=true&getChildren=true&RRMvendor=["this is the shortname of the RRM vendor"]"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VenuesApi;

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

public class VenuesApiExample {
    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
        VenuesApi apiInstance = new VenuesApi();
        UUID entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean unassigned = true; // Boolean | 
        String deviceType = deviceType_example; // String | 
        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
        String select = serial1,serial2,serial3; // String | Supply a list of Venues comma separated
        Boolean countOnly = true; // Boolean | return the number of devices
        Boolean getDevices = true; // Boolean | return the devices under a venue
        Boolean getChildren = true; // Boolean | return the devices under a venue and its children. Must select getDevices=true as well.
        String rRMvendor = ["this is the shortname of the RRM vendor"]; // String | list venues that use a specific RRM vendor

        try {
            getVenues_200_response result = apiInstance.getVenues(entity, venue, unassigned, deviceType, offset, limit, filter, select, countOnly, getDevices, getChildren, rRMvendor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VenuesApi#getVenues");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VenuesApi;

public class VenuesApiExample {
    public static void main(String[] args) {
        VenuesApi apiInstance = new VenuesApi();
        UUID entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        UUID venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean unassigned = true; // Boolean | 
        String deviceType = deviceType_example; // String | 
        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
        String select = serial1,serial2,serial3; // String | Supply a list of Venues comma separated
        Boolean countOnly = true; // Boolean | return the number of devices
        Boolean getDevices = true; // Boolean | return the devices under a venue
        Boolean getChildren = true; // Boolean | return the devices under a venue and its children. Must select getDevices=true as well.
        String rRMvendor = ["this is the shortname of the RRM vendor"]; // String | list venues that use a specific RRM vendor

        try {
            getVenues_200_response result = apiInstance.getVenues(entity, venue, unassigned, deviceType, offset, limit, filter, select, countOnly, getDevices, getChildren, rRMvendor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VenuesApi#getVenues");
            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
VenuesApi *apiInstance = [[VenuesApi alloc] init];
UUID *entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (optional) (default to null)
UUID *venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (optional) (default to null)
Boolean *unassigned = true; //  (optional) (default to null)
String *deviceType = deviceType_example; //  (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 *filter = filter_example; // Filter the results (optional) (default to null)
String *select = serial1,serial2,serial3; // Supply a list of Venues comma separated (optional) (default to null)
Boolean *countOnly = true; // return the number of devices (optional) (default to null)
Boolean *getDevices = true; // return the devices under a venue (optional) (default to false)
Boolean *getChildren = true; // return the devices under a venue and its children. Must select getDevices=true as well. (optional) (default to false)
String *rRMvendor = ["this is the shortname of the RRM vendor"]; // list venues that use a specific RRM vendor (optional) (default to null)

// Retrieve a list of venues.
[apiInstance getVenuesWith:entity
    venue:venue
    unassigned:unassigned
    deviceType:deviceType
    offset:offset
    limit:limit
    filter:filter
    select:select
    countOnly:countOnly
    getDevices:getDevices
    getChildren:getChildren
    rRMvendor:rRMvendor
              completionHandler: ^(getVenues_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.VenuesApi()
var opts = {
  'entity': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} 
  'venue': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} 
  'unassigned': true, // {Boolean} 
  'deviceType': deviceType_example, // {String} 
  '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
  'select': serial1,serial2,serial3, // {String} Supply a list of Venues comma separated
  'countOnly': true, // {Boolean} return the number of devices
  'getDevices': true, // {Boolean} return the devices under a venue
  'getChildren': true, // {Boolean} return the devices under a venue and its children. Must select getDevices=true as well.
  'rRMvendor': ["this is the shortname of the RRM vendor"] // {String} list venues that use a specific RRM vendor
};

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

namespace Example
{
    public class getVenuesExample
    {
        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 VenuesApi();
            var entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (optional)  (default to null)
            var venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (optional)  (default to null)
            var unassigned = true;  // Boolean |  (optional)  (default to null)
            var deviceType = deviceType_example;  // String |  (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 filter = filter_example;  // String | Filter the results (optional)  (default to null)
            var select = serial1,serial2,serial3;  // String | Supply a list of Venues comma separated (optional)  (default to null)
            var countOnly = true;  // Boolean | return the number of devices (optional)  (default to null)
            var getDevices = true;  // Boolean | return the devices under a venue (optional)  (default to false)
            var getChildren = true;  // Boolean | return the devices under a venue and its children. Must select getDevices=true as well. (optional)  (default to false)
            var rRMvendor = ["this is the shortname of the RRM vendor"];  // String | list venues that use a specific RRM vendor (optional)  (default to null)

            try {
                // Retrieve a list of venues.
                getVenues_200_response result = apiInstance.getVenues(entity, venue, unassigned, deviceType, offset, limit, filter, select, countOnly, getDevices, getChildren, rRMvendor);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VenuesApi.getVenues: " + 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\VenuesApi();
$entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$unassigned = true; // Boolean | 
$deviceType = deviceType_example; // String | 
$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
$select = serial1,serial2,serial3; // String | Supply a list of Venues comma separated
$countOnly = true; // Boolean | return the number of devices
$getDevices = true; // Boolean | return the devices under a venue
$getChildren = true; // Boolean | return the devices under a venue and its children. Must select getDevices=true as well.
$rRMvendor = ["this is the shortname of the RRM vendor"]; // String | list venues that use a specific RRM vendor

try {
    $result = $api_instance->getVenues($entity, $venue, $unassigned, $deviceType, $offset, $limit, $filter, $select, $countOnly, $getDevices, $getChildren, $rRMvendor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VenuesApi->getVenues: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VenuesApi;

# 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::VenuesApi->new();
my $entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $unassigned = true; # Boolean | 
my $deviceType = deviceType_example; # String | 
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 $select = serial1,serial2,serial3; # String | Supply a list of Venues comma separated
my $countOnly = true; # Boolean | return the number of devices
my $getDevices = true; # Boolean | return the devices under a venue
my $getChildren = true; # Boolean | return the devices under a venue and its children. Must select getDevices=true as well.
my $rRMvendor = ["this is the shortname of the RRM vendor"]; # String | list venues that use a specific RRM vendor

eval {
    my $result = $api_instance->getVenues(entity => $entity, venue => $venue, unassigned => $unassigned, deviceType => $deviceType, offset => $offset, limit => $limit, filter => $filter, select => $select, countOnly => $countOnly, getDevices => $getDevices, getChildren => $getChildren, rRMvendor => $rRMvendor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VenuesApi->getVenues: $@\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.VenuesApi()
entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (optional) (default to null)
venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (optional) (default to null)
unassigned = true # Boolean |  (optional) (default to null)
deviceType = deviceType_example # String |  (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)
filter = filter_example # String | Filter the results (optional) (default to null)
select = serial1,serial2,serial3 # String | Supply a list of Venues comma separated (optional) (default to null)
countOnly = true # Boolean | return the number of devices (optional) (default to null)
getDevices = true # Boolean | return the devices under a venue (optional) (default to false)
getChildren = true # Boolean | return the devices under a venue and its children. Must select getDevices=true as well. (optional) (default to false)
rRMvendor = ["this is the shortname of the RRM vendor"] # String | list venues that use a specific RRM vendor (optional) (default to null)

try:
    # Retrieve a list of venues.
    api_response = api_instance.get_venues(entity=entity, venue=venue, unassigned=unassigned, deviceType=deviceType, offset=offset, limit=limit, filter=filter, select=select, countOnly=countOnly, getDevices=getDevices, getChildren=getChildren, rRMvendor=rRMvendor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VenuesApi->getVenues: %s\n" % e)
extern crate VenuesApi;

pub fn main() {
    let entity = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let venue = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let unassigned = true; // Boolean
    let deviceType = deviceType_example; // String
    let offset = 56; // Integer
    let limit = 56; // Integer
    let filter = filter_example; // String
    let select = serial1,serial2,serial3; // String
    let countOnly = true; // Boolean
    let getDevices = true; // Boolean
    let getChildren = true; // Boolean
    let rRMvendor = ["this is the shortname of the RRM vendor"]; // String

    let mut context = VenuesApi::Context::default();
    let result = client.getVenues(entity, venue, unassigned, deviceType, offset, limit, filter, select, countOnly, getDevices, getChildren, rRMvendor, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
entity
UUID (uuid)
venue
UUID (uuid)
unassigned
Boolean
deviceType
String
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
select
String
Supply a list of Venues comma separated
countOnly
Boolean
return the number of devices
getDevices
Boolean
return the devices under a venue
getChildren
Boolean
return the devices under a venue and its children. Must select getDevices=true as well.
RRMvendor
String
list venues that use a specific RRM vendor

Responses


modifyVenue

Modify a specific venue.


/venue/{uuid}

Usage and SDK Samples

curl -X PUT \
-H "X-API-KEY: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://localhost:16005/api/v1/venue/{uuid}?updateAllDevices=true&rebootAllDevices=true&testUpdateOnly=true&upgradeAllDevices=true&revisionsAvailable=true&revision=revision_example" \
 -d '{
  "parent" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "variables" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "maps" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "managementPolicy" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "devices" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "topology" : [ {
    "parent" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "child" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "parent" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "child" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "configurations" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "managementPolicies" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "boards" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "deviceConfiguration" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "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 ]
  },
  "deviceRules" : {
    "firmwareUpgrade" : "true",
    "rcOnly" : "true",
    "rrm" : "true"
  },
  "sourceIP" : {
    "list" : [ "list", "list" ]
  },
  "children" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "design" : "design",
  "location" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "managementRoles" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
  "entity" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "contacts" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VenuesApi;

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

public class VenuesApiExample {
    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
        VenuesApi apiInstance = new VenuesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean updateAllDevices = true; // Boolean | 
        Boolean rebootAllDevices = true; // Boolean | 
        Boolean testUpdateOnly = true; // Boolean | 
        Boolean upgradeAllDevices = true; // Boolean | 
        Boolean revisionsAvailable = true; // Boolean | 
        String revision = revision_example; // String | 
        Venue venue = ; // Venue | 

        try {
            modifyVenue_200_response result = apiInstance.modifyVenue(uuid, updateAllDevices, rebootAllDevices, testUpdateOnly, upgradeAllDevices, revisionsAvailable, revision, venue);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VenuesApi#modifyVenue");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VenuesApi;

public class VenuesApiExample {
    public static void main(String[] args) {
        VenuesApi apiInstance = new VenuesApi();
        UUID uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        Boolean updateAllDevices = true; // Boolean | 
        Boolean rebootAllDevices = true; // Boolean | 
        Boolean testUpdateOnly = true; // Boolean | 
        Boolean upgradeAllDevices = true; // Boolean | 
        Boolean revisionsAvailable = true; // Boolean | 
        String revision = revision_example; // String | 
        Venue venue = ; // Venue | 

        try {
            modifyVenue_200_response result = apiInstance.modifyVenue(uuid, updateAllDevices, rebootAllDevices, testUpdateOnly, upgradeAllDevices, revisionsAvailable, revision, venue);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VenuesApi#modifyVenue");
            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
VenuesApi *apiInstance = [[VenuesApi alloc] init];
UUID *uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)
Boolean *updateAllDevices = true; //  (optional) (default to false)
Boolean *rebootAllDevices = true; //  (optional) (default to false)
Boolean *testUpdateOnly = true; //  (optional) (default to false)
Boolean *upgradeAllDevices = true; //  (optional) (default to false)
Boolean *revisionsAvailable = true; //  (optional) (default to false)
String *revision = revision_example; //  (optional) (default to null)
Venue *venue = ; //  (optional)

// Modify a specific venue.
[apiInstance modifyVenueWith:uuid
    updateAllDevices:updateAllDevices
    rebootAllDevices:rebootAllDevices
    testUpdateOnly:testUpdateOnly
    upgradeAllDevices:upgradeAllDevices
    revisionsAvailable:revisionsAvailable
    revision:revision
    venue:venue
              completionHandler: ^(modifyVenue_200_response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OpenWiFiProvisioningModel = require('open_wi_fi_provisioning_model');
var defaultClient = OpenWiFiProvisioningModel.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 OpenWiFiProvisioningModel.VenuesApi()
var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 
var opts = {
  'updateAllDevices': true, // {Boolean} 
  'rebootAllDevices': true, // {Boolean} 
  'testUpdateOnly': true, // {Boolean} 
  'upgradeAllDevices': true, // {Boolean} 
  'revisionsAvailable': true, // {Boolean} 
  'revision': revision_example, // {String} 
  'venue':  // {Venue} 
};

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

namespace Example
{
    public class modifyVenueExample
    {
        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 VenuesApi();
            var uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID |  (default to null)
            var updateAllDevices = true;  // Boolean |  (optional)  (default to false)
            var rebootAllDevices = true;  // Boolean |  (optional)  (default to false)
            var testUpdateOnly = true;  // Boolean |  (optional)  (default to false)
            var upgradeAllDevices = true;  // Boolean |  (optional)  (default to false)
            var revisionsAvailable = true;  // Boolean |  (optional)  (default to false)
            var revision = revision_example;  // String |  (optional)  (default to null)
            var venue = new Venue(); // Venue |  (optional) 

            try {
                // Modify a specific venue.
                modifyVenue_200_response result = apiInstance.modifyVenue(uuid, updateAllDevices, rebootAllDevices, testUpdateOnly, upgradeAllDevices, revisionsAvailable, revision, venue);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VenuesApi.modifyVenue: " + 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\VenuesApi();
$uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$updateAllDevices = true; // Boolean | 
$rebootAllDevices = true; // Boolean | 
$testUpdateOnly = true; // Boolean | 
$upgradeAllDevices = true; // Boolean | 
$revisionsAvailable = true; // Boolean | 
$revision = revision_example; // String | 
$venue = ; // Venue | 

try {
    $result = $api_instance->modifyVenue($uuid, $updateAllDevices, $rebootAllDevices, $testUpdateOnly, $upgradeAllDevices, $revisionsAvailable, $revision, $venue);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VenuesApi->modifyVenue: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VenuesApi;

# 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::VenuesApi->new();
my $uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $updateAllDevices = true; # Boolean | 
my $rebootAllDevices = true; # Boolean | 
my $testUpdateOnly = true; # Boolean | 
my $upgradeAllDevices = true; # Boolean | 
my $revisionsAvailable = true; # Boolean | 
my $revision = revision_example; # String | 
my $venue = WWW::OPenAPIClient::Object::Venue->new(); # Venue | 

eval {
    my $result = $api_instance->modifyVenue(uuid => $uuid, updateAllDevices => $updateAllDevices, rebootAllDevices => $rebootAllDevices, testUpdateOnly => $testUpdateOnly, upgradeAllDevices => $upgradeAllDevices, revisionsAvailable => $revisionsAvailable, revision => $revision, venue => $venue);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VenuesApi->modifyVenue: $@\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.VenuesApi()
uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)
updateAllDevices = true # Boolean |  (optional) (default to false)
rebootAllDevices = true # Boolean |  (optional) (default to false)
testUpdateOnly = true # Boolean |  (optional) (default to false)
upgradeAllDevices = true # Boolean |  (optional) (default to false)
revisionsAvailable = true # Boolean |  (optional) (default to false)
revision = revision_example # String |  (optional) (default to null)
venue =  # Venue |  (optional)

try:
    # Modify a specific venue.
    api_response = api_instance.modify_venue(uuid, updateAllDevices=updateAllDevices, rebootAllDevices=rebootAllDevices, testUpdateOnly=testUpdateOnly, upgradeAllDevices=upgradeAllDevices, revisionsAvailable=revisionsAvailable, revision=revision, venue=venue)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VenuesApi->modifyVenue: %s\n" % e)
extern crate VenuesApi;

pub fn main() {
    let uuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let updateAllDevices = true; // Boolean
    let rebootAllDevices = true; // Boolean
    let testUpdateOnly = true; // Boolean
    let upgradeAllDevices = true; // Boolean
    let revisionsAvailable = true; // Boolean
    let revision = revision_example; // String
    let venue = ; // Venue

    let mut context = VenuesApi::Context::default();
    let result = client.modifyVenue(uuid, updateAllDevices, rebootAllDevices, testUpdateOnly, upgradeAllDevices, revisionsAvailable, revision, venue, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
uuid*
UUID (uuid)
Required
Body parameters
Name Description
venue

Information used to modify the new venue

Query parameters
Name Description
updateAllDevices
Boolean
rebootAllDevices
Boolean
testUpdateOnly
Boolean
upgradeAllDevices
Boolean
revisionsAvailable
Boolean
revision
String

Responses