getClients
Get clients list.
/admin/clients
Usage and SDK Samples
curl -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "http://localhost/admin/clients?name=&active=&limit=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;
import java.io.File;
import java.util.*;
public class AdminApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AdminApi apiInstance = new AdminApi();
String name = name_example; // String | Filter clients list by name
Boolean active = true; // Boolean | Filter clients list by active
Integer limit = 56; // Integer | Max number of clients in list.
Integer offset = 56; // Integer | Number of results to offset.
try {
ClientsResponse result = apiInstance.getClients(name, active, limit, offset);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AdminApi#getClients");
e.printStackTrace();
}
}
}
import io.swagger.client.api.AdminApi;
public class AdminApiExample {
public static void main(String[] args) {
AdminApi apiInstance = new AdminApi();
String name = name_example; // String | Filter clients list by name
Boolean active = true; // Boolean | Filter clients list by active
Integer limit = 56; // Integer | Max number of clients in list.
Integer offset = 56; // Integer | Number of results to offset.
try {
ClientsResponse result = apiInstance.getClients(name, active, limit, offset);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AdminApi#getClients");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *name = name_example; // Filter clients list by name (optional)
Boolean *active = true; // Filter clients list by active (optional)
Integer *limit = 56; // Max number of clients in list. (optional)
Integer *offset = 56; // Number of results to offset. (optional)
AdminApi *apiInstance = [[AdminApi alloc] init];
// Get clients list.
[apiInstance getClientsWith:name
active:active
limit:limit
offset:offset
completionHandler: ^(ClientsResponse output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var ReservationApi = require('reservation_api');
var defaultClient = ReservationApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'
var api = new ReservationApi.AdminApi()
var opts = {
'name': name_example, // {String} Filter clients list by name
'active': true, // {Boolean} Filter clients list by active
'limit': 56, // {Integer} Max number of clients in list.
'offset': 56 // {Integer} Number of results to offset.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getClients(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getClientsExample
{
public void main()
{
// Configure HTTP basic authorization: basicAuth
Configuration.Default.Username = "YOUR_USERNAME";
Configuration.Default.Password = "YOUR_PASSWORD";
var apiInstance = new AdminApi();
var name = name_example; // String | Filter clients list by name (optional)
var active = true; // Boolean | Filter clients list by active (optional)
var limit = 56; // Integer | Max number of clients in list. (optional)
var offset = 56; // Integer | Number of results to offset. (optional)
try
{
// Get clients list.
ClientsResponse result = apiInstance.getClients(name, active, limit, offset);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AdminApi.getClients: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
$api_instance = new Swagger\Client\Api\AdminApi();
$name = name_example; // String | Filter clients list by name
$active = true; // Boolean | Filter clients list by active
$limit = 56; // Integer | Max number of clients in list.
$offset = 56; // Integer | Number of results to offset.
try {
$result = $api_instance->getClients($name, $active, $limit, $offset);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AdminApi->getClients: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AdminApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';
my $api_instance = WWW::SwaggerClient::AdminApi->new();
my $name = name_example; # String | Filter clients list by name
my $active = true; # Boolean | Filter clients list by active
my $limit = 56; # Integer | Max number of clients in list.
my $offset = 56; # Integer | Number of results to offset.
eval {
my $result = $api_instance->getClients(name => $name, active => $active, limit => $limit, offset => $offset);
print Dumper($result);
};
if ($@) {
warn "Exception when calling AdminApi->getClients: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = swagger_client.AdminApi()
name = name_example # String | Filter clients list by name (optional)
active = true # Boolean | Filter clients list by active (optional)
limit = 56 # Integer | Max number of clients in list. (optional)
offset = 56 # Integer | Number of results to offset. (optional)
try:
# Get clients list.
api_response = api_instance.get_clients(name=name, active=active, limit=limit, offset=offset)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->getClients: %s\n" % e)
Parameters
Query parameters
Name | Description |
---|---|
name |
String
Filter clients list by name
|
active |
Boolean
Filter clients list by active
|
limit |
Integer
Max number of clients in list.
|
offset |
Integer
Number of results to offset.
|