Queensaver API

Default

authenticateRegistrationIdPost

authenticate against the internal authentication service with a registrationId.

This can not be called from the API but is an internal call. Please ignore if you consume this API publicly. An authentication call can be either a username or password but also a registrationId. In this call we implement the registrationId.


/v1/authenticateRegistrationId

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.queensaver.com/v1/authenticateRegistrationId" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        RegistrationId registrationId = ; // RegistrationId | 

        try {
            authenticate-post-response result = apiInstance.authenticateRegistrationIdPost(registrationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#authenticateRegistrationIdPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        RegistrationId registrationId = ; // RegistrationId | 

        try {
            authenticate-post-response result = apiInstance.authenticateRegistrationIdPost(registrationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#authenticateRegistrationIdPost");
            e.printStackTrace();
        }
    }
}


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

// authenticate against the internal authentication service with a registrationId.
[apiInstance authenticateRegistrationIdPostWith:registrationId
              completionHandler: ^(authenticate-post-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var registrationId = ; // {RegistrationId} 

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

namespace Example
{
    public class authenticateRegistrationIdPostExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var registrationId = new RegistrationId(); // RegistrationId | 

            try {
                // authenticate against the internal authentication service with a registrationId.
                authenticate-post-response result = apiInstance.authenticateRegistrationIdPost(registrationId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.authenticateRegistrationIdPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$registrationId = ; // RegistrationId | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $registrationId = WWW::OPenAPIClient::Object::RegistrationId->new(); # RegistrationId | 

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

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
registrationId =  # RegistrationId | 

try:
    # authenticate against the internal authentication service with a registrationId.
    api_response = api_instance.authenticate_registration_id_post(registrationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->authenticateRegistrationIdPost: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let registrationId = ; // RegistrationId

    let mut context = DefaultApi::Context::default();
    let result = client.authenticateRegistrationIdPost(registrationId, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
registrationId *

Responses


bboxesGet

Get QBox metadata

This returns QBox metadata for the logged in user. The request needs to present a valid session cookie. There are no query parameters needed here, the request will return all known bboxes.


/v1/bboxes

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.queensaver.com/v1/bboxes"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

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

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

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

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

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


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

// Get QBox metadata
[apiInstance bboxesGetWithCompletionHandler: 
              ^(array[bbox] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

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

namespace Example
{
    public class bboxesGetExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

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

            try {
                // Get QBox metadata
                array[bbox] result = apiInstance.bboxesGet();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.bboxesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

eval {
    my $result = $api_instance->bboxesGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->bboxesGet: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

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

try:
    # Get QBox metadata
    api_response = api_instance.bboxes_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->bboxesGet: %s\n" % e)
extern crate DefaultApi;

pub fn main() {

    let mut context = DefaultApi::Context::default();
    let result = client.bboxesGet(&context).wait();

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

Scopes

Parameters

Responses


configsBboxAssociatePost

associate bbox and its sensors to a logical hive

This connects a bbox with a hive so all telemetry data will be associate with the hive. If the hiveUuid is empty, we disassociate that bhive (it's no longer connected to any hives)


/v1/configs/bbox/associate

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 "https://api.queensaver.com/v1/configs/bbox/associate?userId=1234&configUuid=e157989c-a435-432b-9826-70a06f192fb5&bboxId=829898a53801&hiveUuid=41C0FE2F-EB0C-45B4-8842-C117E47C35E3"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String configUuid = e157989c-a435-432b-9826-70a06f192fb5; // String | The uuid the device.
        String bboxId = 829898a53801; // String | The Mac Address of the bBox. Deprecated. use configUuid instead.
        String hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | Unique Identifier for this hive
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

        try {
            generic-post-response result = apiInstance.configsBboxAssociatePost(configUuid, bboxId, hiveUuid, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#configsBboxAssociatePost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String configUuid = e157989c-a435-432b-9826-70a06f192fb5; // String | The uuid the device.
        String bboxId = 829898a53801; // String | The Mac Address of the bBox. Deprecated. use configUuid instead.
        String hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | Unique Identifier for this hive
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

        try {
            generic-post-response result = apiInstance.configsBboxAssociatePost(configUuid, bboxId, hiveUuid, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#configsBboxAssociatePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *configUuid = e157989c-a435-432b-9826-70a06f192fb5; // The uuid the device. (default to null)
String *bboxId = 829898a53801; // The Mac Address of the bBox. Deprecated. use configUuid instead. (default to null)
String *hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // Unique Identifier for this hive (default to null)
Long *userId = 1234; // The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)

// associate bbox and its sensors to a logical hive
[apiInstance configsBboxAssociatePostWith:configUuid
    bboxId:bboxId
    hiveUuid:hiveUuid
    userId:userId
              completionHandler: ^(generic-post-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var configUuid = e157989c-a435-432b-9826-70a06f192fb5; // {String} The uuid the device.
var bboxId = 829898a53801; // {String} The Mac Address of the bBox. Deprecated. use configUuid instead.
var hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // {String} Unique Identifier for this hive
var opts = {
  'userId': 1234 // {Long} The UserID is set internally and can not set or be overridden with the API request. Please ignore.
};

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

namespace Example
{
    public class configsBboxAssociatePostExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var configUuid = e157989c-a435-432b-9826-70a06f192fb5;  // String | The uuid the device. (default to null)
            var bboxId = 829898a53801;  // String | The Mac Address of the bBox. Deprecated. use configUuid instead. (default to null)
            var hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3;  // String | Unique Identifier for this hive (default to null)
            var userId = 1234;  // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional)  (default to null)

            try {
                // associate bbox and its sensors to a logical hive
                generic-post-response result = apiInstance.configsBboxAssociatePost(configUuid, bboxId, hiveUuid, userId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.configsBboxAssociatePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$configUuid = e157989c-a435-432b-9826-70a06f192fb5; // String | The uuid the device.
$bboxId = 829898a53801; // String | The Mac Address of the bBox. Deprecated. use configUuid instead.
$hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | Unique Identifier for this hive
$userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

try {
    $result = $api_instance->configsBboxAssociatePost($configUuid, $bboxId, $hiveUuid, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->configsBboxAssociatePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $configUuid = e157989c-a435-432b-9826-70a06f192fb5; # String | The uuid the device.
my $bboxId = 829898a53801; # String | The Mac Address of the bBox. Deprecated. use configUuid instead.
my $hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; # String | Unique Identifier for this hive
my $userId = 1234; # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

eval {
    my $result = $api_instance->configsBboxAssociatePost(configUuid => $configUuid, bboxId => $bboxId, hiveUuid => $hiveUuid, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->configsBboxAssociatePost: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
configUuid = e157989c-a435-432b-9826-70a06f192fb5 # String | The uuid the device. (default to null)
bboxId = 829898a53801 # String | The Mac Address of the bBox. Deprecated. use configUuid instead. (default to null)
hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3 # String | Unique Identifier for this hive (default to null)
userId = 1234 # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)

try:
    # associate bbox and its sensors to a logical hive
    api_response = api_instance.configs_bbox_associate_post(configUuid, bboxId, hiveUuid, userId=userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->configsBboxAssociatePost: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let configUuid = e157989c-a435-432b-9826-70a06f192fb5; // String
    let bboxId = 829898a53801; // String
    let hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String
    let userId = 1234; // Long

    let mut context = DefaultApi::Context::default();
    let result = client.configsBboxAssociatePost(configUuid, bboxId, hiveUuid, userId, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
userId
Long (int64)
The UserID is set internally and can not set or be overridden with the API request. Please ignore.
configUuid*
String
The uuid the device.
Required
bboxId*
String
The Mac Address of the bBox. Deprecated. use configUuid instead.
Required
hiveUuid*
String
Unique Identifier for this hive
Required

Responses


configsBboxDelete

Delete a bbox

This deletes a bbox.


/v1/configs/bbox

Usage and SDK Samples

curl -X DELETE \
 \
 "https://api.queensaver.com/v1/configs/bbox?userId=1234&uuid=41C0FE2F-EB0C-45B4-8842-C117E47C35E3"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the bbox.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

        try {
            apiInstance.configsBboxDelete(qToken, uuid, token, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#configsBboxDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the bbox.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

        try {
            apiInstance.configsBboxDelete(qToken, uuid, token, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#configsBboxDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
String *uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // The UUID of the bbox. (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
Long *userId = 1234; // The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)

// Delete a bbox
[apiInstance configsBboxDeleteWith:qToken
    uuid:uuid
    token:token
    userId:userId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // {String} Either the cookie or this Q-Token must be set to be authorized for the API call.
var uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // {String} The UUID of the bbox.
var opts = {
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either this cookie or the Q-Token must be set to be authorized for the API call.
  'userId': 1234 // {Long} The UserID is set internally and can not set or be overridden with the API request. Please ignore.
};

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

namespace Example
{
    public class configsBboxDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
            var uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3;  // String | The UUID of the bbox. (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var userId = 1234;  // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional)  (default to null)

            try {
                // Delete a bbox
                apiInstance.configsBboxDelete(qToken, uuid, token, userId);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.configsBboxDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
$uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the bbox.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
$userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie or this Q-Token must be set to be authorized for the API call.
my $uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; # String | The UUID of the bbox.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie or the Q-Token must be set to be authorized for the API call.
my $userId = 1234; # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

eval {
    $api_instance->configsBboxDelete(qToken => $qToken, uuid => $uuid, token => $token, userId => $userId);
};
if ($@) {
    warn "Exception when calling DefaultApi->configsBboxDelete: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3 # String | The UUID of the bbox. (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
userId = 1234 # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)

try:
    # Delete a bbox
    api_instance.configs_bbox_delete(qToken, uuid, token=token, userId=userId)
except ApiException as e:
    print("Exception when calling DefaultApi->configsBboxDelete: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let userId = 1234; // Long

    let mut context = DefaultApi::Context::default();
    let result = client.configsBboxDelete(qToken, uuid, token, userId, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Q-Token*
String
Either the cookie or this Q-Token must be set to be authorized for the API call.
Required
Query parameters
Name Description
userId
Long (int64)
The UserID is set internally and can not set or be overridden with the API request. Please ignore.
uuid*
String
The UUID of the bbox.
Required

Responses


configsBboxGet

Get Config metadata of bboxes

This returns all bboxes of a user


/v1/configs/bbox

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.queensaver.com/v1/configs/bbox?uuid=41C0FE2F-EB0C-45B4-8842-C117E47C35E3&userId=1234"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        String uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the bbox. If not set, the request will return all bboxes.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

        try {
            get-bbox-response result = apiInstance.configsBboxGet(qToken, token, uuid, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#configsBboxGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        String uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the bbox. If not set, the request will return all bboxes.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

        try {
            get-bbox-response result = apiInstance.configsBboxGet(qToken, token, uuid, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#configsBboxGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
String *uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // The UUID of the bbox. If not set, the request will return all bboxes. (optional) (default to null)
Long *userId = 1234; // The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)

// Get Config metadata of bboxes
[apiInstance configsBboxGetWith:qToken
    token:token
    uuid:uuid
    userId:userId
              completionHandler: ^(get-bbox-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // {String} Either the cookie or this Q-Token must be set to be authorized for the API call.
var opts = {
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either this cookie or the Q-Token must be set to be authorized for the API call.
  'uuid': 41C0FE2F-EB0C-45B4-8842-C117E47C35E3, // {String} The UUID of the bbox. If not set, the request will return all bboxes.
  'userId': 1234 // {Long} The UserID is set internally and can not set or be overridden with the API request. Please ignore.
};

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

namespace Example
{
    public class configsBboxGetExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3;  // String | The UUID of the bbox. If not set, the request will return all bboxes. (optional)  (default to null)
            var userId = 1234;  // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional)  (default to null)

            try {
                // Get Config metadata of bboxes
                get-bbox-response result = apiInstance.configsBboxGet(qToken, token, uuid, userId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.configsBboxGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
$uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the bbox. If not set, the request will return all bboxes.
$userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie or this Q-Token must be set to be authorized for the API call.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie or the Q-Token must be set to be authorized for the API call.
my $uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; # String | The UUID of the bbox. If not set, the request will return all bboxes.
my $userId = 1234; # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

eval {
    my $result = $api_instance->configsBboxGet(qToken => $qToken, token => $token, uuid => $uuid, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->configsBboxGet: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3 # String | The UUID of the bbox. If not set, the request will return all bboxes. (optional) (default to null)
userId = 1234 # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)

try:
    # Get Config metadata of bboxes
    api_response = api_instance.configs_bbox_get(qToken, token=token, uuid=uuid, userId=userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->configsBboxGet: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String
    let userId = 1234; // Long

    let mut context = DefaultApi::Context::default();
    let result = client.configsBboxGet(qToken, token, uuid, userId, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Q-Token*
String
Either the cookie or this Q-Token must be set to be authorized for the API call.
Required
Query parameters
Name Description
uuid
String
The UUID of the bbox. If not set, the request will return all bboxes.
userId
Long (int64)
The UserID is set internally and can not set or be overridden with the API request. Please ignore.

Responses


configsBboxPost

Create bbox

This creates a new bbox. A bbox is a physical hardware component that needs to be associated with a hive.


/v1/configs/bbox

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.queensaver.com/v1/configs/bbox?userId=1234" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
        Bbox bbox = ; // Bbox | 

        try {
            post-bbox-response result = apiInstance.configsBboxPost(qToken, token, userId, bbox);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#configsBboxPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
        Bbox bbox = ; // Bbox | 

        try {
            post-bbox-response result = apiInstance.configsBboxPost(qToken, token, userId, bbox);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#configsBboxPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
Long *userId = 1234; // The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)
Bbox *bbox = ; //  (optional)

// Create bbox
[apiInstance configsBboxPostWith:qToken
    token:token
    userId:userId
    bbox:bbox
              completionHandler: ^(post-bbox-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // {String} Either the cookie or this Q-Token must be set to be authorized for the API call.
var opts = {
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either this cookie or the Q-Token must be set to be authorized for the API call.
  'userId': 1234, // {Long} The UserID is set internally and can not set or be overridden with the API request. Please ignore.
  'bbox':  // {Bbox} 
};

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

namespace Example
{
    public class configsBboxPostExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var userId = 1234;  // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional)  (default to null)
            var bbox = new Bbox(); // Bbox |  (optional) 

            try {
                // Create bbox
                post-bbox-response result = apiInstance.configsBboxPost(qToken, token, userId, bbox);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.configsBboxPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
$userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
$bbox = ; // Bbox | 

try {
    $result = $api_instance->configsBboxPost($qToken, $token, $userId, $bbox);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->configsBboxPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie or this Q-Token must be set to be authorized for the API call.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie or the Q-Token must be set to be authorized for the API call.
my $userId = 1234; # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
my $bbox = WWW::OPenAPIClient::Object::Bbox->new(); # Bbox | 

eval {
    my $result = $api_instance->configsBboxPost(qToken => $qToken, token => $token, userId => $userId, bbox => $bbox);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->configsBboxPost: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
userId = 1234 # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)
bbox =  # Bbox |  (optional)

try:
    # Create bbox
    api_response = api_instance.configs_bbox_post(qToken, token=token, userId=userId, bbox=bbox)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->configsBboxPost: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let userId = 1234; // Long
    let bbox = ; // Bbox

    let mut context = DefaultApi::Context::default();
    let result = client.configsBboxPost(qToken, token, userId, bbox, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Q-Token*
String
Either the cookie or this Q-Token must be set to be authorized for the API call.
Required
Body parameters
Name Description
bbox

Query parameters
Name Description
userId
Long (int64)
The UserID is set internally and can not set or be overridden with the API request. Please ignore.

Responses


configsBboxPut

Update bbox metadata

This call updates bbox metadata


/v1/configs/bbox

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.queensaver.com/v1/configs/bbox?uuid=41C0FE2F-EB0C-45B4-8842-C117E47C35E3&userId=1234" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the bbox. Required. You can only update one bbox at a time.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
        Bbox bbox = ; // Bbox | 

        try {
            put-bbox-response result = apiInstance.configsBboxPut(qToken, uuid, token, userId, bbox);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#configsBboxPut");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the bbox. Required. You can only update one bbox at a time.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
        Bbox bbox = ; // Bbox | 

        try {
            put-bbox-response result = apiInstance.configsBboxPut(qToken, uuid, token, userId, bbox);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#configsBboxPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
String *uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // The UUID of the bbox. Required. You can only update one bbox at a time. (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
Long *userId = 1234; // The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)
Bbox *bbox = ; //  (optional)

// Update bbox metadata
[apiInstance configsBboxPutWith:qToken
    uuid:uuid
    token:token
    userId:userId
    bbox:bbox
              completionHandler: ^(put-bbox-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // {String} Either the cookie or this Q-Token must be set to be authorized for the API call.
var uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // {String} The UUID of the bbox. Required. You can only update one bbox at a time.
var opts = {
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either this cookie or the Q-Token must be set to be authorized for the API call.
  'userId': 1234, // {Long} The UserID is set internally and can not set or be overridden with the API request. Please ignore.
  'bbox':  // {Bbox} 
};

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

namespace Example
{
    public class configsBboxPutExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
            var uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3;  // String | The UUID of the bbox. Required. You can only update one bbox at a time. (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var userId = 1234;  // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional)  (default to null)
            var bbox = new Bbox(); // Bbox |  (optional) 

            try {
                // Update bbox metadata
                put-bbox-response result = apiInstance.configsBboxPut(qToken, uuid, token, userId, bbox);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.configsBboxPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
$uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the bbox. Required. You can only update one bbox at a time.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
$userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
$bbox = ; // Bbox | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie or this Q-Token must be set to be authorized for the API call.
my $uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; # String | The UUID of the bbox. Required. You can only update one bbox at a time.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie or the Q-Token must be set to be authorized for the API call.
my $userId = 1234; # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
my $bbox = WWW::OPenAPIClient::Object::Bbox->new(); # Bbox | 

eval {
    my $result = $api_instance->configsBboxPut(qToken => $qToken, uuid => $uuid, token => $token, userId => $userId, bbox => $bbox);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->configsBboxPut: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3 # String | The UUID of the bbox. Required. You can only update one bbox at a time. (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
userId = 1234 # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)
bbox =  # Bbox |  (optional)

try:
    # Update bbox metadata
    api_response = api_instance.configs_bbox_put(qToken, uuid, token=token, userId=userId, bbox=bbox)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->configsBboxPut: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let userId = 1234; // Long
    let bbox = ; // Bbox

    let mut context = DefaultApi::Context::default();
    let result = client.configsBboxPut(qToken, uuid, token, userId, bbox, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Q-Token*
String
Either the cookie or this Q-Token must be set to be authorized for the API call.
Required
Body parameters
Name Description
bbox

Query parameters
Name Description
uuid*
String
The UUID of the bbox. Required. You can only update one bbox at a time.
Required
userId
Long (int64)
The UserID is set internally and can not set or be overridden with the API request. Please ignore.

Responses


configsBboxRegisterPost

register bbox

This registers a new bbox. A bbox is a physical hardware component that needs to be associated with a hive. The bbox sends a registrationId that a user needs to know and put in the system before the registration. The bbox proto is used as a convenience, the only field that is accepted is the bboxId and the registrationId, the hardwareType and that hardwareRevision.


/v1/configs/bbox/register

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.queensaver.com/v1/configs/bbox/register?userId=1234" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
        Bbox bbox = ; // Bbox | 

        try {
            bbox-config-response result = apiInstance.configsBboxRegisterPost(registrationId, userId, bbox);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#configsBboxRegisterPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
        Bbox bbox = ; // Bbox | 

        try {
            bbox-config-response result = apiInstance.configsBboxRegisterPost(registrationId, userId, bbox);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#configsBboxRegisterPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data. (default to null)
Long *userId = 1234; // The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)
Bbox *bbox = ; //  (optional)

// register bbox
[apiInstance configsBboxRegisterPostWith:registrationId
    userId:userId
    bbox:bbox
              completionHandler: ^(bbox-config-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // {String} The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
var opts = {
  'userId': 1234, // {Long} The UserID is set internally and can not set or be overridden with the API request. Please ignore.
  'bbox':  // {Bbox} 
};

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

namespace Example
{
    public class configsBboxRegisterPostExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var registrationId = 8B0FE5CFC0964B3E874827906B4A9449;  // String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data. (default to null)
            var userId = 1234;  // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional)  (default to null)
            var bbox = new Bbox(); // Bbox |  (optional) 

            try {
                // register bbox
                bbox-config-response result = apiInstance.configsBboxRegisterPost(registrationId, userId, bbox);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.configsBboxRegisterPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
$userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
$bbox = ; // Bbox | 

try {
    $result = $api_instance->configsBboxRegisterPost($registrationId, $userId, $bbox);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->configsBboxRegisterPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $registrationId = 8B0FE5CFC0964B3E874827906B4A9449; # String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
my $userId = 1234; # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
my $bbox = WWW::OPenAPIClient::Object::Bbox->new(); # Bbox | 

eval {
    my $result = $api_instance->configsBboxRegisterPost(registrationId => $registrationId, userId => $userId, bbox => $bbox);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->configsBboxRegisterPost: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
registrationId = 8B0FE5CFC0964B3E874827906B4A9449 # String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data. (default to null)
userId = 1234 # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)
bbox =  # Bbox |  (optional)

try:
    # register bbox
    api_response = api_instance.configs_bbox_register_post(registrationId, userId=userId, bbox=bbox)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->configsBboxRegisterPost: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // String
    let userId = 1234; // Long
    let bbox = ; // Bbox

    let mut context = DefaultApi::Context::default();
    let result = client.configsBboxRegisterPost(registrationId, userId, bbox, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
registrationId*
String
The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
Required
Body parameters
Name Description
bbox

Query parameters
Name Description
userId
Long (int64)
The UserID is set internally and can not set or be overridden with the API request. Please ignore.

Responses


hivesDelete

Delete a Hive

This deletes a hive.


/v1/hives

Usage and SDK Samples

curl -X DELETE \
 \
 "https://api.queensaver.com/v1/hives?userId=1234&uuid=41C0FE2F-EB0C-45B4-8842-C117E47C35E3"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the hive.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

        try {
            apiInstance.hivesDelete(qToken, uuid, token, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#hivesDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the hive.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

        try {
            apiInstance.hivesDelete(qToken, uuid, token, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#hivesDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
String *uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // The UUID of the hive. (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
Long *userId = 1234; // The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)

// Delete a Hive
[apiInstance hivesDeleteWith:qToken
    uuid:uuid
    token:token
    userId:userId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // {String} Either the cookie or this Q-Token must be set to be authorized for the API call.
var uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // {String} The UUID of the hive.
var opts = {
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either this cookie or the Q-Token must be set to be authorized for the API call.
  'userId': 1234 // {Long} The UserID is set internally and can not set or be overridden with the API request. Please ignore.
};

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

namespace Example
{
    public class hivesDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
            var uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3;  // String | The UUID of the hive. (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var userId = 1234;  // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional)  (default to null)

            try {
                // Delete a Hive
                apiInstance.hivesDelete(qToken, uuid, token, userId);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.hivesDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
$uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the hive.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
$userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie or this Q-Token must be set to be authorized for the API call.
my $uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; # String | The UUID of the hive.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie or the Q-Token must be set to be authorized for the API call.
my $userId = 1234; # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

eval {
    $api_instance->hivesDelete(qToken => $qToken, uuid => $uuid, token => $token, userId => $userId);
};
if ($@) {
    warn "Exception when calling DefaultApi->hivesDelete: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3 # String | The UUID of the hive. (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
userId = 1234 # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)

try:
    # Delete a Hive
    api_instance.hives_delete(qToken, uuid, token=token, userId=userId)
except ApiException as e:
    print("Exception when calling DefaultApi->hivesDelete: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let userId = 1234; // Long

    let mut context = DefaultApi::Context::default();
    let result = client.hivesDelete(qToken, uuid, token, userId, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Q-Token*
String
Either the cookie or this Q-Token must be set to be authorized for the API call.
Required
Query parameters
Name Description
userId
Long (int64)
The UserID is set internally and can not set or be overridden with the API request. Please ignore.
uuid*
String
The UUID of the hive.
Required

Responses


hivesGet

Get Hive metadata

This returns all hive metadata for the currently logged in user. Important to understand is that a user can go back into the past at any point in time (how did my bee hive look like a month or a year ago), so the cloud stores multiple versions of hive metadata. Any PUT request will create a new version. W


/v1/hives

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.queensaver.com/v1/hives?uuid=41C0FE2F-EB0C-45B4-8842-C117E47C35E3&epoch=1639170002&secondsInThePast=7200&userId=1234"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        Long epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW()
        Long secondsInThePast = 7200; // Long | How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version.
        String uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the hive. If not set, the request will return all hives.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

        try {
            get-hives-response result = apiInstance.hivesGet(epoch, secondsInThePast, uuid, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#hivesGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Long epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW()
        Long secondsInThePast = 7200; // Long | How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version.
        String uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the hive. If not set, the request will return all hives.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

        try {
            get-hives-response result = apiInstance.hivesGet(epoch, secondsInThePast, uuid, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#hivesGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
Long *epoch = 1639170002; // The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW() (default to null)
Long *secondsInThePast = 7200; // How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version. (default to null)
String *uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // The UUID of the hive. If not set, the request will return all hives. (optional) (default to null)
Long *userId = 1234; // The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)

// Get Hive metadata
[apiInstance hivesGetWith:epoch
    secondsInThePast:secondsInThePast
    uuid:uuid
    userId:userId
              completionHandler: ^(get-hives-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var epoch = 1639170002; // {Long} The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW()
var secondsInThePast = 7200; // {Long} How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version.
var opts = {
  'uuid': 41C0FE2F-EB0C-45B4-8842-C117E47C35E3, // {String} The UUID of the hive. If not set, the request will return all hives.
  'userId': 1234 // {Long} The UserID is set internally and can not set or be overridden with the API request. Please ignore.
};

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

namespace Example
{
    public class hivesGetExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var epoch = 1639170002;  // Long | The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW() (default to null)
            var secondsInThePast = 7200;  // Long | How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version. (default to null)
            var uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3;  // String | The UUID of the hive. If not set, the request will return all hives. (optional)  (default to null)
            var userId = 1234;  // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional)  (default to null)

            try {
                // Get Hive metadata
                get-hives-response result = apiInstance.hivesGet(epoch, secondsInThePast, uuid, userId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.hivesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW()
$secondsInThePast = 7200; // Long | How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version.
$uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the hive. If not set, the request will return all hives.
$userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $epoch = 1639170002; # Long | The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW()
my $secondsInThePast = 7200; # Long | How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version.
my $uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; # String | The UUID of the hive. If not set, the request will return all hives.
my $userId = 1234; # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

eval {
    my $result = $api_instance->hivesGet(epoch => $epoch, secondsInThePast => $secondsInThePast, uuid => $uuid, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->hivesGet: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
epoch = 1639170002 # Long | The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW() (default to null)
secondsInThePast = 7200 # Long | How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version. (default to null)
uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3 # String | The UUID of the hive. If not set, the request will return all hives. (optional) (default to null)
userId = 1234 # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)

try:
    # Get Hive metadata
    api_response = api_instance.hives_get(epoch, secondsInThePast, uuid=uuid, userId=userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->hivesGet: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let epoch = 1639170002; // Long
    let secondsInThePast = 7200; // Long
    let uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String
    let userId = 1234; // Long

    let mut context = DefaultApi::Context::default();
    let result = client.hivesGet(epoch, secondsInThePast, uuid, userId, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
uuid
String
The UUID of the hive. If not set, the request will return all hives.
epoch*
Long (int64)
The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW()
Required
secondsInThePast*
Long (int64)
How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version.
Required
userId
Long (int64)
The UserID is set internally and can not set or be overridden with the API request. Please ignore.

Responses


hivesPost

Create Hive metadata

This creates a new hive. A hive is a logical representation of a bee hive that can be connected to hardware.


/v1/hives

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.queensaver.com/v1/hives?userId=1234" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
        Hive hive = ; // Hive | 

        try {
            post-hives-response result = apiInstance.hivesPost(qToken, token, userId, hive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#hivesPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
        Hive hive = ; // Hive | 

        try {
            post-hives-response result = apiInstance.hivesPost(qToken, token, userId, hive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#hivesPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
Long *userId = 1234; // The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)
Hive *hive = ; //  (optional)

// Create Hive metadata
[apiInstance hivesPostWith:qToken
    token:token
    userId:userId
    hive:hive
              completionHandler: ^(post-hives-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // {String} Either the cookie or this Q-Token must be set to be authorized for the API call.
var opts = {
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either this cookie or the Q-Token must be set to be authorized for the API call.
  'userId': 1234, // {Long} The UserID is set internally and can not set or be overridden with the API request. Please ignore.
  'hive':  // {Hive} 
};

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

namespace Example
{
    public class hivesPostExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var userId = 1234;  // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional)  (default to null)
            var hive = new Hive(); // Hive |  (optional) 

            try {
                // Create Hive metadata
                post-hives-response result = apiInstance.hivesPost(qToken, token, userId, hive);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.hivesPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
$userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
$hive = ; // Hive | 

try {
    $result = $api_instance->hivesPost($qToken, $token, $userId, $hive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->hivesPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie or this Q-Token must be set to be authorized for the API call.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie or the Q-Token must be set to be authorized for the API call.
my $userId = 1234; # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
my $hive = WWW::OPenAPIClient::Object::Hive->new(); # Hive | 

eval {
    my $result = $api_instance->hivesPost(qToken => $qToken, token => $token, userId => $userId, hive => $hive);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->hivesPost: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
userId = 1234 # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)
hive =  # Hive |  (optional)

try:
    # Create Hive metadata
    api_response = api_instance.hives_post(qToken, token=token, userId=userId, hive=hive)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->hivesPost: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let userId = 1234; // Long
    let hive = ; // Hive

    let mut context = DefaultApi::Context::default();
    let result = client.hivesPost(qToken, token, userId, hive, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Q-Token*
String
Either the cookie or this Q-Token must be set to be authorized for the API call.
Required
Body parameters
Name Description
hive

Query parameters
Name Description
userId
Long (int64)
The UserID is set internally and can not set or be overridden with the API request. Please ignore.

Responses


hivesPut

Update Hive metadata

This updates hive metadata. Note that internaly we will actally create a new version of the data.


/v1/hives

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.queensaver.com/v1/hives?userId=1234" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
        Hive hive = ; // Hive | 

        try {
            put-hive-response result = apiInstance.hivesPut(qToken, token, userId, hive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#hivesPut");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
        Hive hive = ; // Hive | 

        try {
            put-hive-response result = apiInstance.hivesPut(qToken, token, userId, hive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#hivesPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
Long *userId = 1234; // The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)
Hive *hive = ; //  (optional)

// Update Hive metadata
[apiInstance hivesPutWith:qToken
    token:token
    userId:userId
    hive:hive
              completionHandler: ^(put-hive-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // {String} Either the cookie or this Q-Token must be set to be authorized for the API call.
var opts = {
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either this cookie or the Q-Token must be set to be authorized for the API call.
  'userId': 1234, // {Long} The UserID is set internally and can not set or be overridden with the API request. Please ignore.
  'hive':  // {Hive} 
};

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

namespace Example
{
    public class hivesPutExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var userId = 1234;  // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional)  (default to null)
            var hive = new Hive(); // Hive |  (optional) 

            try {
                // Update Hive metadata
                put-hive-response result = apiInstance.hivesPut(qToken, token, userId, hive);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.hivesPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
$userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
$hive = ; // Hive | 

try {
    $result = $api_instance->hivesPut($qToken, $token, $userId, $hive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->hivesPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie or this Q-Token must be set to be authorized for the API call.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie or the Q-Token must be set to be authorized for the API call.
my $userId = 1234; # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
my $hive = WWW::OPenAPIClient::Object::Hive->new(); # Hive | 

eval {
    my $result = $api_instance->hivesPut(qToken => $qToken, token => $token, userId => $userId, hive => $hive);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->hivesPut: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
userId = 1234 # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)
hive =  # Hive |  (optional)

try:
    # Update Hive metadata
    api_response = api_instance.hives_put(qToken, token=token, userId=userId, hive=hive)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->hivesPut: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let userId = 1234; // Long
    let hive = ; // Hive

    let mut context = DefaultApi::Context::default();
    let result = client.hivesPut(qToken, token, userId, hive, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Q-Token*
String
Either the cookie or this Q-Token must be set to be authorized for the API call.
Required
Body parameters
Name Description
hive

Query parameters
Name Description
userId
Long (int64)
The UserID is set internally and can not set or be overridden with the API request. Please ignore.

Responses


loginPost

Authenticate a user against the system.

This call is meant for interactive web applications. Be aware that the server returns a cookie with a 24 hour lifetime.


/v1/login

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 "https://api.queensaver.com/v1/login"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username, must be unique to the queensaver system. We encourage using email-addresses here.
        String password = password_example; // String | Password

        try {
            login-post-response result = apiInstance.loginPost(username, password);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#loginPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username, must be unique to the queensaver system. We encourage using email-addresses here.
        String password = password_example; // String | Password

        try {
            login-post-response result = apiInstance.loginPost(username, password);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#loginPost");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *username = username_example; // Username, must be unique to the queensaver system. We encourage using email-addresses here. (default to null)
String *password = password_example; // Password (default to null)

// Authenticate a user against the system.
[apiInstance loginPostWith:username
    password:password
              completionHandler: ^(login-post-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var username = username_example; // {String} Username, must be unique to the queensaver system. We encourage using email-addresses here.
var password = password_example; // {String} Password

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

namespace Example
{
    public class loginPostExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var username = username_example;  // String | Username, must be unique to the queensaver system. We encourage using email-addresses here. (default to null)
            var password = password_example;  // String | Password (default to null)

            try {
                // Authenticate a user against the system.
                login-post-response result = apiInstance.loginPost(username, password);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.loginPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$username = username_example; // String | Username, must be unique to the queensaver system. We encourage using email-addresses here.
$password = password_example; // String | Password

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $username = username_example; # String | Username, must be unique to the queensaver system. We encourage using email-addresses here.
my $password = password_example; # String | Password

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

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
username = username_example # String | Username, must be unique to the queensaver system. We encourage using email-addresses here. (default to null)
password = password_example # String | Password (default to null)

try:
    # Authenticate a user against the system.
    api_response = api_instance.login_post(username, password)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->loginPost: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let username = username_example; // String
    let password = password_example; // String

    let mut context = DefaultApi::Context::default();
    let result = client.loginPost(username, password, &context).wait();

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

Scopes

Parameters

Form parameters
Name Description
username*
String
Username, must be unique to the queensaver system. We encourage using email-addresses here.
Required
password*
String (password)
Password
Required

Responses

Name Type Format Description
SetCookie String


scaleGet

Get Scale values

This returns scale values for a certain, defineable date range. The request needs to send a cookie along with the request. The cookie is stored under the key called "token". Note that this returns the scale data for a QBox Client (independent of the beeHive), the API call for an actual beeHive is different.


/v1/scale

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.queensaver.com/v1/scale?bhiveId=829898a53801&epoch=1639170002&secondsInThePast=7200"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String bhiveId = 829898a53801; // String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
        Long epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
        Long secondsInThePast = 7200; // Long | How many seconds we go to the past to get the data measurements.
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call.

        try {
            array[weight] result = apiInstance.scaleGet(bhiveId, epoch, secondsInThePast, qToken, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#scaleGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String bhiveId = 829898a53801; // String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
        Long epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
        Long secondsInThePast = 7200; // Long | How many seconds we go to the past to get the data measurements.
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call.

        try {
            array[weight] result = apiInstance.scaleGet(bhiveId, epoch, secondsInThePast, qToken, token);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#scaleGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *bhiveId = 829898a53801; // The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. (default to null)
Long *epoch = 1639170002; // The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter. (default to null)
Long *secondsInThePast = 7200; // How many seconds we go to the past to get the data measurements. (default to null)
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call. (optional) (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call. (optional) (default to null)

// Get Scale values
[apiInstance scaleGetWith:bhiveId
    epoch:epoch
    secondsInThePast:secondsInThePast
    qToken:qToken
    token:token
              completionHandler: ^(array[weight] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var bhiveId = 829898a53801; // {String} The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
var epoch = 1639170002; // {Long} The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
var secondsInThePast = 7200; // {Long} How many seconds we go to the past to get the data measurements.
var opts = {
  'qToken': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449 // {String} Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call.
};

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

namespace Example
{
    public class scaleGetExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var bhiveId = 829898a53801;  // String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. (default to null)
            var epoch = 1639170002;  // Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter. (default to null)
            var secondsInThePast = 7200;  // Long | How many seconds we go to the past to get the data measurements. (default to null)
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)

            try {
                // Get Scale values
                array[weight] result = apiInstance.scaleGet(bhiveId, epoch, secondsInThePast, qToken, token);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.scaleGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$bhiveId = 829898a53801; // String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
$epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
$secondsInThePast = 7200; // Long | How many seconds we go to the past to get the data measurements.
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call.

try {
    $result = $api_instance->scaleGet($bhiveId, $epoch, $secondsInThePast, $qToken, $token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->scaleGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $bhiveId = 829898a53801; # String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
my $epoch = 1639170002; # Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
my $secondsInThePast = 7200; # Long | How many seconds we go to the past to get the data measurements.
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call.

eval {
    my $result = $api_instance->scaleGet(bhiveId => $bhiveId, epoch => $epoch, secondsInThePast => $secondsInThePast, qToken => $qToken, token => $token);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->scaleGet: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
bhiveId = 829898a53801 # String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. (default to null)
epoch = 1639170002 # Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter. (default to null)
secondsInThePast = 7200 # Long | How many seconds we go to the past to get the data measurements. (default to null)
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call. (optional) (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call. (optional) (default to null)

try:
    # Get Scale values
    api_response = api_instance.scale_get(bhiveId, epoch, secondsInThePast, qToken=qToken, token=token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->scaleGet: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let bhiveId = 829898a53801; // String
    let epoch = 1639170002; // Long
    let secondsInThePast = 7200; // Long
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String

    let mut context = DefaultApi::Context::default();
    let result = client.scaleGet(bhiveId, epoch, secondsInThePast, qToken, token, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Q-Token
String
Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
Query parameters
Name Description
bhiveId*
String
The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
Required
epoch*
Long (int64)
The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
Required
secondsInThePast*
Long (int64)
How many seconds we go to the past to get the data measurements.
Required

Responses


scaleGetV2

Get Scale values

This returns scale values for a certain, defineable date range. The request needs to send a token in the header or a cookie. Note that this returns the scale data for a scale (independent of the beeHive), the API call for an actual beeHive is different.


/v2/scale

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.queensaver.com/v2/scale?hiveUuid=8B0FE5CF-C096-4B3E-8748-27906B4A9449&macAddress=829898a53801&epoch=1639170002&secondsInThePast=7200&userId=123"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        Long epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
        Long secondsInThePast = 7200; // Long | How many seconds we go to the past to get the data measurements.
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call.
        String hiveUuid = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required.
        String macAddress = 829898a53801; // String | The Mac Address of the scale. You can omit this if you use query the hiveUuid.
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

        try {
            scaleV2Response result = apiInstance.scaleGetV2(epoch, secondsInThePast, qToken, token, hiveUuid, macAddress, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#scaleGetV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Long epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
        Long secondsInThePast = 7200; // Long | How many seconds we go to the past to get the data measurements.
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call.
        String hiveUuid = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required.
        String macAddress = 829898a53801; // String | The Mac Address of the scale. You can omit this if you use query the hiveUuid.
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

        try {
            scaleV2Response result = apiInstance.scaleGetV2(epoch, secondsInThePast, qToken, token, hiveUuid, macAddress, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#scaleGetV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
Long *epoch = 1639170002; // The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter. (default to null)
Long *secondsInThePast = 7200; // How many seconds we go to the past to get the data measurements. (default to null)
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call. (optional) (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
String *hiveUuid = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required. (optional) (default to null)
String *macAddress = 829898a53801; // The Mac Address of the scale. You can omit this if you use query the hiveUuid. (optional) (default to null)
Long *userId = 123; // The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)

// Get Scale values
[apiInstance scaleGetV2With:epoch
    secondsInThePast:secondsInThePast
    qToken:qToken
    token:token
    hiveUuid:hiveUuid
    macAddress:macAddress
    userId:userId
              completionHandler: ^(scaleV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var epoch = 1639170002; // {Long} The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
var secondsInThePast = 7200; // {Long} How many seconds we go to the past to get the data measurements.
var opts = {
  'qToken': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call.
  'hiveUuid': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required.
  'macAddress': 829898a53801, // {String} The Mac Address of the scale. You can omit this if you use query the hiveUuid.
  'userId': 123 // {Long} The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
};

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

namespace Example
{
    public class scaleGetV2Example
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var epoch = 1639170002;  // Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter. (default to null)
            var secondsInThePast = 7200;  // Long | How many seconds we go to the past to get the data measurements. (default to null)
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var hiveUuid = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required. (optional)  (default to null)
            var macAddress = 829898a53801;  // String | The Mac Address of the scale. You can omit this if you use query the hiveUuid. (optional)  (default to null)
            var userId = 123;  // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional)  (default to null)

            try {
                // Get Scale values
                scaleV2Response result = apiInstance.scaleGetV2(epoch, secondsInThePast, qToken, token, hiveUuid, macAddress, userId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.scaleGetV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
$secondsInThePast = 7200; // Long | How many seconds we go to the past to get the data measurements.
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call.
$hiveUuid = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required.
$macAddress = 829898a53801; // String | The Mac Address of the scale. You can omit this if you use query the hiveUuid.
$userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

try {
    $result = $api_instance->scaleGetV2($epoch, $secondsInThePast, $qToken, $token, $hiveUuid, $macAddress, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->scaleGetV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $epoch = 1639170002; # Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
my $secondsInThePast = 7200; # Long | How many seconds we go to the past to get the data measurements.
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call.
my $hiveUuid = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required.
my $macAddress = 829898a53801; # String | The Mac Address of the scale. You can omit this if you use query the hiveUuid.
my $userId = 123; # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

eval {
    my $result = $api_instance->scaleGetV2(epoch => $epoch, secondsInThePast => $secondsInThePast, qToken => $qToken, token => $token, hiveUuid => $hiveUuid, macAddress => $macAddress, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->scaleGetV2: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
epoch = 1639170002 # Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter. (default to null)
secondsInThePast = 7200 # Long | How many seconds we go to the past to get the data measurements. (default to null)
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call. (optional) (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
hiveUuid = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required. (optional) (default to null)
macAddress = 829898a53801 # String | The Mac Address of the scale. You can omit this if you use query the hiveUuid. (optional) (default to null)
userId = 123 # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)

try:
    # Get Scale values
    api_response = api_instance.scale_get_v2(epoch, secondsInThePast, qToken=qToken, token=token, hiveUuid=hiveUuid, macAddress=macAddress, userId=userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->scaleGetV2: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let epoch = 1639170002; // Long
    let secondsInThePast = 7200; // Long
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let hiveUuid = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let macAddress = 829898a53801; // String
    let userId = 123; // Long

    let mut context = DefaultApi::Context::default();
    let result = client.scaleGetV2(epoch, secondsInThePast, qToken, token, hiveUuid, macAddress, userId, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Q-Token
String
Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
Query parameters
Name Description
hiveUuid
String
The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required.
macAddress
String
The Mac Address of the scale. You can omit this if you use query the hiveUuid.
epoch*
Long (int64)
The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
Required
secondsInThePast*
Long (int64)
How many seconds we go to the past to get the data measurements.
Required
userId
Long (int64)
The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

Responses


scalePost

Post Scale values

Sends a weight from a hive to the queensaver system. The request needs to send a cookie along with the request. The cookie is stored under the key called "token". Note that this returns the scale data for a QBox Client (independent of the beeHive), the API call for an actual beeHive is different.


/v1/scale

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.queensaver.com/v1/scale?userId=123" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String registrationId = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call.
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
        Weight weight = ; // Weight | 

        try {
            generic-post-response result = apiInstance.scalePost(registrationId, qToken, token, userId, weight);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#scalePost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String registrationId = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call.
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
        Weight weight = ; // Weight | 

        try {
            generic-post-response result = apiInstance.scalePost(registrationId, qToken, token, userId, weight);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#scalePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *registrationId = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call. (optional) (default to null)
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call. (optional) (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
Long *userId = 123; // The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)
Weight *weight = ; //  (optional)

// Post Scale values
[apiInstance scalePostWith:registrationId
    qToken:qToken
    token:token
    userId:userId
    weight:weight
              completionHandler: ^(generic-post-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var opts = {
  'registrationId': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call.
  'qToken': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call.
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either this cookie or the Q-Token must be set to be authorized for the API call.
  'userId': 123, // {Long} The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
  'weight':  // {Weight} 
};

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

namespace Example
{
    public class scalePostExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var registrationId = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var userId = 123;  // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional)  (default to null)
            var weight = new Weight(); // Weight |  (optional) 

            try {
                // Post Scale values
                generic-post-response result = apiInstance.scalePost(registrationId, qToken, token, userId, weight);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.scalePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$registrationId = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call.
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
$userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
$weight = ; // Weight | 

try {
    $result = $api_instance->scalePost($registrationId, $qToken, $token, $userId, $weight);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->scalePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $registrationId = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call.
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie or the Q-Token must be set to be authorized for the API call.
my $userId = 123; # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
my $weight = WWW::OPenAPIClient::Object::Weight->new(); # Weight | 

eval {
    my $result = $api_instance->scalePost(registrationId => $registrationId, qToken => $qToken, token => $token, userId => $userId, weight => $weight);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->scalePost: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
registrationId = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call. (optional) (default to null)
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call. (optional) (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
userId = 123 # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)
weight =  # Weight |  (optional)

try:
    # Post Scale values
    api_response = api_instance.scale_post(registrationId=registrationId, qToken=qToken, token=token, userId=userId, weight=weight)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->scalePost: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let registrationId = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let userId = 123; // Long
    let weight = ; // Weight

    let mut context = DefaultApi::Context::default();
    let result = client.scalePost(registrationId, qToken, token, userId, weight, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
registrationId
String
Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call.
Q-Token
String
Either the cookie, the registrationId or this Q-Token must be set to be authorized for the API call.
Body parameters
Name Description
weight

Query parameters
Name Description
userId
Long (int64)
The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

Responses


scalePostV2

Post Scale values

Sends a weight from a scale to the queensaver system. The request needs to send the registrationId along with the request.


/v2/scale

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.queensaver.com/v2/scale?userId=123" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
        ScaleV2 scaleV2 = ; // ScaleV2 | 

        try {
            generic-post-response result = apiInstance.scalePostV2(registrationId, userId, scaleV2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#scalePostV2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
        ScaleV2 scaleV2 = ; // ScaleV2 | 

        try {
            generic-post-response result = apiInstance.scalePostV2(registrationId, userId, scaleV2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#scalePostV2");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data. (default to null)
Long *userId = 123; // The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)
ScaleV2 *scaleV2 = ; //  (optional)

// Post Scale values
[apiInstance scalePostV2With:registrationId
    userId:userId
    scaleV2:scaleV2
              completionHandler: ^(generic-post-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // {String} The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
var opts = {
  'userId': 123, // {Long} The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
  'scaleV2':  // {ScaleV2} 
};

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

namespace Example
{
    public class scalePostV2Example
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var registrationId = 8B0FE5CFC0964B3E874827906B4A9449;  // String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data. (default to null)
            var userId = 123;  // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional)  (default to null)
            var scaleV2 = new ScaleV2(); // ScaleV2 |  (optional) 

            try {
                // Post Scale values
                generic-post-response result = apiInstance.scalePostV2(registrationId, userId, scaleV2);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.scalePostV2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
$userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
$scaleV2 = ; // ScaleV2 | 

try {
    $result = $api_instance->scalePostV2($registrationId, $userId, $scaleV2);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->scalePostV2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $registrationId = 8B0FE5CFC0964B3E874827906B4A9449; # String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
my $userId = 123; # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
my $scaleV2 = WWW::OPenAPIClient::Object::ScaleV2->new(); # ScaleV2 | 

eval {
    my $result = $api_instance->scalePostV2(registrationId => $registrationId, userId => $userId, scaleV2 => $scaleV2);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->scalePostV2: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
registrationId = 8B0FE5CFC0964B3E874827906B4A9449 # String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data. (default to null)
userId = 123 # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)
scaleV2 =  # ScaleV2 |  (optional)

try:
    # Post Scale values
    api_response = api_instance.scale_post_v2(registrationId, userId=userId, scaleV2=scaleV2)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->scalePostV2: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // String
    let userId = 123; // Long
    let scaleV2 = ; // ScaleV2

    let mut context = DefaultApi::Context::default();
    let result = client.scalePostV2(registrationId, userId, scaleV2, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
registrationId*
String
The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
Required
Body parameters
Name Description
scaleV2

Query parameters
Name Description
userId
Long (int64)
The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

Responses


standsDelete

Delete a stand

This deletes a stand. If a stand is deleted, it will only get its deleted field set to true. It will not actually be deleted, because we need to always be able to go back in time.


/v1/stands

Usage and SDK Samples

curl -X DELETE \
 \
 "https://api.queensaver.com/v1/stands?userId=1234&uuid=41C0FE2F-EB0C-45B4-8842-C117E47C35E3"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the stand.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

        try {
            apiInstance.standsDelete(qToken, uuid, token, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#standsDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the stand.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

        try {
            apiInstance.standsDelete(qToken, uuid, token, userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#standsDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
String *uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // The UUID of the stand. (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
Long *userId = 1234; // The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)

// Delete a stand
[apiInstance standsDeleteWith:qToken
    uuid:uuid
    token:token
    userId:userId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // {String} Either the cookie or this Q-Token must be set to be authorized for the API call.
var uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // {String} The UUID of the stand.
var opts = {
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either this cookie or the Q-Token must be set to be authorized for the API call.
  'userId': 1234 // {Long} The UserID is set internally and can not set or be overridden with the API request. Please ignore.
};

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

namespace Example
{
    public class standsDeleteExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
            var uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3;  // String | The UUID of the stand. (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var userId = 1234;  // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional)  (default to null)

            try {
                // Delete a stand
                apiInstance.standsDelete(qToken, uuid, token, userId);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.standsDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
$uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the stand.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
$userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie or this Q-Token must be set to be authorized for the API call.
my $uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; # String | The UUID of the stand.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie or the Q-Token must be set to be authorized for the API call.
my $userId = 1234; # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

eval {
    $api_instance->standsDelete(qToken => $qToken, uuid => $uuid, token => $token, userId => $userId);
};
if ($@) {
    warn "Exception when calling DefaultApi->standsDelete: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3 # String | The UUID of the stand. (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
userId = 1234 # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)

try:
    # Delete a stand
    api_instance.stands_delete(qToken, uuid, token=token, userId=userId)
except ApiException as e:
    print("Exception when calling DefaultApi->standsDelete: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let userId = 1234; // Long

    let mut context = DefaultApi::Context::default();
    let result = client.standsDelete(qToken, uuid, token, userId, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Q-Token*
String
Either the cookie or this Q-Token must be set to be authorized for the API call.
Required
Query parameters
Name Description
userId
Long (int64)
The UserID is set internally and can not set or be overridden with the API request. Please ignore.
uuid*
String
The UUID of the stand.
Required

Responses


standsGet

Get Stand metadata

This returns all hive stand for the currently logged in user. Important to understand is that a user can go back into the past at any point in time (how did my stand look like a month or a year ago), so the cloud stores multiple versions of stand metadata. Any PUT request will create a new version.


/v1/stands

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.queensaver.com/v1/stands?uuid=41C0FE2F-EB0C-45B4-8842-C117E47C35E3&epoch=1639170002&secondsInThePast=7200&userId=1234"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        Long epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW()
        Long secondsInThePast = 7200; // Long | How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version. If set to non-zero, we will return all results from the past as well, up to 100 values.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        String uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the stand. If not set, the request will return all stands.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

        try {
            get-stands-response result = apiInstance.standsGet(qToken, epoch, secondsInThePast, token, uuid, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#standsGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        Long epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW()
        Long secondsInThePast = 7200; // Long | How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version. If set to non-zero, we will return all results from the past as well, up to 100 values.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        String uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the stand. If not set, the request will return all stands.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

        try {
            get-stands-response result = apiInstance.standsGet(qToken, epoch, secondsInThePast, token, uuid, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#standsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
Long *epoch = 1639170002; // The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW() (default to null)
Long *secondsInThePast = 7200; // How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version. If set to non-zero, we will return all results from the past as well, up to 100 values. (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
String *uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // The UUID of the stand. If not set, the request will return all stands. (optional) (default to null)
Long *userId = 1234; // The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)

// Get Stand metadata
[apiInstance standsGetWith:qToken
    epoch:epoch
    secondsInThePast:secondsInThePast
    token:token
    uuid:uuid
    userId:userId
              completionHandler: ^(get-stands-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // {String} Either the cookie or this Q-Token must be set to be authorized for the API call.
var epoch = 1639170002; // {Long} The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW()
var secondsInThePast = 7200; // {Long} How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version. If set to non-zero, we will return all results from the past as well, up to 100 values.
var opts = {
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either this cookie or the Q-Token must be set to be authorized for the API call.
  'uuid': 41C0FE2F-EB0C-45B4-8842-C117E47C35E3, // {String} The UUID of the stand. If not set, the request will return all stands.
  'userId': 1234 // {Long} The UserID is set internally and can not set or be overridden with the API request. Please ignore.
};

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

namespace Example
{
    public class standsGetExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
            var epoch = 1639170002;  // Long | The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW() (default to null)
            var secondsInThePast = 7200;  // Long | How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version. If set to non-zero, we will return all results from the past as well, up to 100 values. (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3;  // String | The UUID of the stand. If not set, the request will return all stands. (optional)  (default to null)
            var userId = 1234;  // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional)  (default to null)

            try {
                // Get Stand metadata
                get-stands-response result = apiInstance.standsGet(qToken, epoch, secondsInThePast, token, uuid, userId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.standsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
$epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW()
$secondsInThePast = 7200; // Long | How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version. If set to non-zero, we will return all results from the past as well, up to 100 values.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
$uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the stand. If not set, the request will return all stands.
$userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

try {
    $result = $api_instance->standsGet($qToken, $epoch, $secondsInThePast, $token, $uuid, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->standsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie or this Q-Token must be set to be authorized for the API call.
my $epoch = 1639170002; # Long | The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW()
my $secondsInThePast = 7200; # Long | How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version. If set to non-zero, we will return all results from the past as well, up to 100 values.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie or the Q-Token must be set to be authorized for the API call.
my $uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; # String | The UUID of the stand. If not set, the request will return all stands.
my $userId = 1234; # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.

eval {
    my $result = $api_instance->standsGet(qToken => $qToken, epoch => $epoch, secondsInThePast => $secondsInThePast, token => $token, uuid => $uuid, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->standsGet: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
epoch = 1639170002 # Long | The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW() (default to null)
secondsInThePast = 7200 # Long | How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version. If set to non-zero, we will return all results from the past as well, up to 100 values. (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3 # String | The UUID of the stand. If not set, the request will return all stands. (optional) (default to null)
userId = 1234 # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)

try:
    # Get Stand metadata
    api_response = api_instance.stands_get(qToken, epoch, secondsInThePast, token=token, uuid=uuid, userId=userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->standsGet: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let epoch = 1639170002; // Long
    let secondsInThePast = 7200; // Long
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String
    let userId = 1234; // Long

    let mut context = DefaultApi::Context::default();
    let result = client.standsGet(qToken, epoch, secondsInThePast, token, uuid, userId, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Q-Token*
String
Either the cookie or this Q-Token must be set to be authorized for the API call.
Required
Query parameters
Name Description
uuid
String
The UUID of the stand. If not set, the request will return all stands.
epoch*
Long (int64)
The Unix Time (epoch) that defines the end time of the query. The beginning is defined by the secondsInThePast parameter. If unset, the epoch will be set to NOW()
Required
secondsInThePast*
Long (int64)
How many seconds we go to the past to return data versions. If set to zero, we will return exactly one version. If set to non-zero, we will return all results from the past as well, up to 100 values.
Required
userId
Long (int64)
The UserID is set internally and can not set or be overridden with the API request. Please ignore.

Responses


standsPost

Create stand metadata

This creates a new stand. A stand is a logical representation of a location of bee hives.


/v1/stands

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.queensaver.com/v1/stands?userId=1234" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
        Stand stand = ; // Stand | 

        try {
            post-stands-response result = apiInstance.standsPost(qToken, token, userId, stand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#standsPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
        Stand stand = ; // Stand | 

        try {
            post-stands-response result = apiInstance.standsPost(qToken, token, userId, stand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#standsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
Long *userId = 1234; // The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)
Stand *stand = ; //  (optional)

// Create stand metadata
[apiInstance standsPostWith:qToken
    token:token
    userId:userId
    stand:stand
              completionHandler: ^(post-stands-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // {String} Either the cookie or this Q-Token must be set to be authorized for the API call.
var opts = {
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either this cookie or the Q-Token must be set to be authorized for the API call.
  'userId': 1234, // {Long} The UserID is set internally and can not set or be overridden with the API request. Please ignore.
  'stand':  // {Stand} 
};

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

namespace Example
{
    public class standsPostExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var userId = 1234;  // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional)  (default to null)
            var stand = new Stand(); // Stand |  (optional) 

            try {
                // Create stand metadata
                post-stands-response result = apiInstance.standsPost(qToken, token, userId, stand);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.standsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
$userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
$stand = ; // Stand | 

try {
    $result = $api_instance->standsPost($qToken, $token, $userId, $stand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->standsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie or this Q-Token must be set to be authorized for the API call.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie or the Q-Token must be set to be authorized for the API call.
my $userId = 1234; # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
my $stand = WWW::OPenAPIClient::Object::Stand->new(); # Stand | 

eval {
    my $result = $api_instance->standsPost(qToken => $qToken, token => $token, userId => $userId, stand => $stand);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->standsPost: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
userId = 1234 # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)
stand =  # Stand |  (optional)

try:
    # Create stand metadata
    api_response = api_instance.stands_post(qToken, token=token, userId=userId, stand=stand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->standsPost: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let userId = 1234; // Long
    let stand = ; // Stand

    let mut context = DefaultApi::Context::default();
    let result = client.standsPost(qToken, token, userId, stand, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Q-Token*
String
Either the cookie or this Q-Token must be set to be authorized for the API call.
Required
Body parameters
Name Description
stand

Query parameters
Name Description
userId
Long (int64)
The UserID is set internally and can not set or be overridden with the API request. Please ignore.

Responses


standsPut

Update stand metadata

This updates stand metadata. Note that internaly we will actally create a new version of the stand (not the hives). When you issue this call you will have to provide the UUID, otherwise we don't know which stand to update. Also any hives attached to the stand will be ignored, you can only update a single stand at any time.


/v1/stands

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.queensaver.com/v1/stands?userId=1234" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
        Stand stand = ; // Stand | 

        try {
            put-stand-response result = apiInstance.standsPut(qToken, token, userId, stand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#standsPut");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
        Stand stand = ; // Stand | 

        try {
            put-stand-response result = apiInstance.standsPut(qToken, token, userId, stand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#standsPut");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
Long *userId = 1234; // The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)
Stand *stand = ; //  (optional)

// Update stand metadata
[apiInstance standsPutWith:qToken
    token:token
    userId:userId
    stand:stand
              completionHandler: ^(put-stand-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // {String} Either the cookie or this Q-Token must be set to be authorized for the API call.
var opts = {
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either this cookie or the Q-Token must be set to be authorized for the API call.
  'userId': 1234, // {Long} The UserID is set internally and can not set or be overridden with the API request. Please ignore.
  'stand':  // {Stand} 
};

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

namespace Example
{
    public class standsPutExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var userId = 1234;  // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional)  (default to null)
            var stand = new Stand(); // Stand |  (optional) 

            try {
                // Update stand metadata
                put-stand-response result = apiInstance.standsPut(qToken, token, userId, stand);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.standsPut: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
$userId = 1234; // Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
$stand = ; // Stand | 

try {
    $result = $api_instance->standsPut($qToken, $token, $userId, $stand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->standsPut: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie or this Q-Token must be set to be authorized for the API call.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie or the Q-Token must be set to be authorized for the API call.
my $userId = 1234; # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore.
my $stand = WWW::OPenAPIClient::Object::Stand->new(); # Stand | 

eval {
    my $result = $api_instance->standsPut(qToken => $qToken, token => $token, userId => $userId, stand => $stand);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->standsPut: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
userId = 1234 # Long | The UserID is set internally and can not set or be overridden with the API request. Please ignore. (optional) (default to null)
stand =  # Stand |  (optional)

try:
    # Update stand metadata
    api_response = api_instance.stands_put(qToken, token=token, userId=userId, stand=stand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->standsPut: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let userId = 1234; // Long
    let stand = ; // Stand

    let mut context = DefaultApi::Context::default();
    let result = client.standsPut(qToken, token, userId, stand, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Q-Token*
String
Either the cookie or this Q-Token must be set to be authorized for the API call.
Required
Body parameters
Name Description
stand

Query parameters
Name Description
userId
Long (int64)
The UserID is set internally and can not set or be overridden with the API request. Please ignore.

Responses


telemetryGet

Get telemetry values

This returns telemetry values for a certain, defineable date range. The request needs to send a token in the header or a cookie. Note that this returns the telemetry data for a scale, the API call for an actual beeHive is different.


/v1/telemetry

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.queensaver.com/v1/telemetry?hiveUuid=8B0FE5CF-C096-4B3E-8748-27906B4A9449&macAddress=829898a53801&epoch=1639170002&secondsInThePast=7200&userId=123"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        Long epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the telemetry measurements. The beginning is defined by the secondsInThePast parameter.
        Long secondsInThePast = 7200; // Long | How many seconds we go to the past to get the data measurements.
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call.
        String hiveUuid = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required.
        String macAddress = 829898a53801; // String | The Mac Address of the scale. You can omit this if you use query the hiveUuid.
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

        try {
            telemetryResponse result = apiInstance.telemetryGet(epoch, secondsInThePast, qToken, token, hiveUuid, macAddress, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#telemetryGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Long epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the telemetry measurements. The beginning is defined by the secondsInThePast parameter.
        Long secondsInThePast = 7200; // Long | How many seconds we go to the past to get the data measurements.
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call.
        String hiveUuid = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required.
        String macAddress = 829898a53801; // String | The Mac Address of the scale. You can omit this if you use query the hiveUuid.
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

        try {
            telemetryResponse result = apiInstance.telemetryGet(epoch, secondsInThePast, qToken, token, hiveUuid, macAddress, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#telemetryGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
Long *epoch = 1639170002; // The Unix Time (epoch) that defines the end time of the telemetry measurements. The beginning is defined by the secondsInThePast parameter. (default to null)
Long *secondsInThePast = 7200; // How many seconds we go to the past to get the data measurements. (default to null)
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call. (optional) (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
String *hiveUuid = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required. (optional) (default to null)
String *macAddress = 829898a53801; // The Mac Address of the scale. You can omit this if you use query the hiveUuid. (optional) (default to null)
Long *userId = 123; // The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)

// Get telemetry values
[apiInstance telemetryGetWith:epoch
    secondsInThePast:secondsInThePast
    qToken:qToken
    token:token
    hiveUuid:hiveUuid
    macAddress:macAddress
    userId:userId
              completionHandler: ^(telemetryResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var epoch = 1639170002; // {Long} The Unix Time (epoch) that defines the end time of the telemetry measurements. The beginning is defined by the secondsInThePast parameter.
var secondsInThePast = 7200; // {Long} How many seconds we go to the past to get the data measurements.
var opts = {
  'qToken': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call.
  'hiveUuid': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required.
  'macAddress': 829898a53801, // {String} The Mac Address of the scale. You can omit this if you use query the hiveUuid.
  'userId': 123 // {Long} The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
};

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

namespace Example
{
    public class telemetryGetExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var epoch = 1639170002;  // Long | The Unix Time (epoch) that defines the end time of the telemetry measurements. The beginning is defined by the secondsInThePast parameter. (default to null)
            var secondsInThePast = 7200;  // Long | How many seconds we go to the past to get the data measurements. (default to null)
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var hiveUuid = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required. (optional)  (default to null)
            var macAddress = 829898a53801;  // String | The Mac Address of the scale. You can omit this if you use query the hiveUuid. (optional)  (default to null)
            var userId = 123;  // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional)  (default to null)

            try {
                // Get telemetry values
                telemetryResponse result = apiInstance.telemetryGet(epoch, secondsInThePast, qToken, token, hiveUuid, macAddress, userId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.telemetryGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the telemetry measurements. The beginning is defined by the secondsInThePast parameter.
$secondsInThePast = 7200; // Long | How many seconds we go to the past to get the data measurements.
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call.
$hiveUuid = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required.
$macAddress = 829898a53801; // String | The Mac Address of the scale. You can omit this if you use query the hiveUuid.
$userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

try {
    $result = $api_instance->telemetryGet($epoch, $secondsInThePast, $qToken, $token, $hiveUuid, $macAddress, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->telemetryGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $epoch = 1639170002; # Long | The Unix Time (epoch) that defines the end time of the telemetry measurements. The beginning is defined by the secondsInThePast parameter.
my $secondsInThePast = 7200; # Long | How many seconds we go to the past to get the data measurements.
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call.
my $hiveUuid = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required.
my $macAddress = 829898a53801; # String | The Mac Address of the scale. You can omit this if you use query the hiveUuid.
my $userId = 123; # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

eval {
    my $result = $api_instance->telemetryGet(epoch => $epoch, secondsInThePast => $secondsInThePast, qToken => $qToken, token => $token, hiveUuid => $hiveUuid, macAddress => $macAddress, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->telemetryGet: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
epoch = 1639170002 # Long | The Unix Time (epoch) that defines the end time of the telemetry measurements. The beginning is defined by the secondsInThePast parameter. (default to null)
secondsInThePast = 7200 # Long | How many seconds we go to the past to get the data measurements. (default to null)
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call. (optional) (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie, registrationId or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
hiveUuid = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required. (optional) (default to null)
macAddress = 829898a53801 # String | The Mac Address of the scale. You can omit this if you use query the hiveUuid. (optional) (default to null)
userId = 123 # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)

try:
    # Get telemetry values
    api_response = api_instance.telemetry_get(epoch, secondsInThePast, qToken=qToken, token=token, hiveUuid=hiveUuid, macAddress=macAddress, userId=userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->telemetryGet: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let epoch = 1639170002; // Long
    let secondsInThePast = 7200; // Long
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let hiveUuid = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let macAddress = 829898a53801; // String
    let userId = 123; // Long

    let mut context = DefaultApi::Context::default();
    let result = client.telemetryGet(epoch, secondsInThePast, qToken, token, hiveUuid, macAddress, userId, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Q-Token
String
Either the cookie, registrationId or this Q-Token must be set to be authorized for the API call.
Query parameters
Name Description
hiveUuid
String
The Hive UUID - can be used instead of the Mac Adress if you want to query an associated hive. Either this field or the macAddress are required.
macAddress
String
The Mac Address of the scale. You can omit this if you use query the hiveUuid.
epoch*
Long (int64)
The Unix Time (epoch) that defines the end time of the telemetry measurements. The beginning is defined by the secondsInThePast parameter.
Required
secondsInThePast*
Long (int64)
How many seconds we go to the past to get the data measurements.
Required
userId
Long (int64)
The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

Responses


telemetryPost

Post Scale values and other telemetry

Sends a weight and other telemetry from a scale to the queensaver system. The request needs to send the registrationId along with the request.


/v1/telemetry

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.queensaver.com/v1/telemetry?userId=123" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
        TelemetryValues telemetryValues = ; // TelemetryValues | 

        try {
            bbox-config-response result = apiInstance.telemetryPost(registrationId, userId, telemetryValues);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#telemetryPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
        TelemetryValues telemetryValues = ; // TelemetryValues | 

        try {
            bbox-config-response result = apiInstance.telemetryPost(registrationId, userId, telemetryValues);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#telemetryPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data. (default to null)
Long *userId = 123; // The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)
TelemetryValues *telemetryValues = ; //  (optional)

// Post Scale values and other telemetry
[apiInstance telemetryPostWith:registrationId
    userId:userId
    telemetryValues:telemetryValues
              completionHandler: ^(bbox-config-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // {String} The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
var opts = {
  'userId': 123, // {Long} The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
  'telemetryValues':  // {TelemetryValues} 
};

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

namespace Example
{
    public class telemetryPostExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var registrationId = 8B0FE5CFC0964B3E874827906B4A9449;  // String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data. (default to null)
            var userId = 123;  // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional)  (default to null)
            var telemetryValues = new TelemetryValues(); // TelemetryValues |  (optional) 

            try {
                // Post Scale values and other telemetry
                bbox-config-response result = apiInstance.telemetryPost(registrationId, userId, telemetryValues);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.telemetryPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
$userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
$telemetryValues = ; // TelemetryValues | 

try {
    $result = $api_instance->telemetryPost($registrationId, $userId, $telemetryValues);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->telemetryPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $registrationId = 8B0FE5CFC0964B3E874827906B4A9449; # String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
my $userId = 123; # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
my $telemetryValues = WWW::OPenAPIClient::Object::TelemetryValues->new(); # TelemetryValues | 

eval {
    my $result = $api_instance->telemetryPost(registrationId => $registrationId, userId => $userId, telemetryValues => $telemetryValues);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->telemetryPost: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
registrationId = 8B0FE5CFC0964B3E874827906B4A9449 # String | The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data. (default to null)
userId = 123 # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)
telemetryValues =  # TelemetryValues |  (optional)

try:
    # Post Scale values and other telemetry
    api_response = api_instance.telemetry_post(registrationId, userId=userId, telemetryValues=telemetryValues)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->telemetryPost: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let registrationId = 8B0FE5CFC0964B3E874827906B4A9449; // String
    let userId = 123; // Long
    let telemetryValues = ; // TelemetryValues

    let mut context = DefaultApi::Context::default();
    let result = client.telemetryPost(registrationId, userId, telemetryValues, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
registrationId*
String
The unique registration Id for that scale. The user needs to register it first in the cloud, otherwise we will not accept the data.
Required
Body parameters
Name Description
telemetryValues

Query parameters
Name Description
userId
Long (int64)
The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

Responses


temperatureGet

Get Temperature values

This returns temperate values for a certain, defineable date range. The request needs to send a cookie along with the request. The cookie is stored under the key called "token". Note that this returns the temperature data for a QBox Client (independent of the beeHive), the API call for an actual beeHive is different.


/v1/temperature

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.queensaver.com/v1/temperature?bhiveId=829898a53801&epoch=1639170002&secondsInThePast=7200&userId=123"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String bhiveId = 829898a53801; // String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
        Long epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
        Long secondsInThePast = 7200; // Long | How many seconds we go to the past to get the data measurements.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

        try {
            get-temperature-response result = apiInstance.temperatureGet(qToken, bhiveId, epoch, secondsInThePast, token, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#temperatureGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String bhiveId = 829898a53801; // String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
        Long epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
        Long secondsInThePast = 7200; // Long | How many seconds we go to the past to get the data measurements.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

        try {
            get-temperature-response result = apiInstance.temperatureGet(qToken, bhiveId, epoch, secondsInThePast, token, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#temperatureGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
String *bhiveId = 829898a53801; // The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. (default to null)
Long *epoch = 1639170002; // The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter. (default to null)
Long *secondsInThePast = 7200; // How many seconds we go to the past to get the data measurements. (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
Long *userId = 123; // The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)

// Get Temperature values
[apiInstance temperatureGetWith:qToken
    bhiveId:bhiveId
    epoch:epoch
    secondsInThePast:secondsInThePast
    token:token
    userId:userId
              completionHandler: ^(get-temperature-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // {String} Either the cookie or this Q-Token must be set to be authorized for the API call.
var bhiveId = 829898a53801; // {String} The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
var epoch = 1639170002; // {Long} The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
var secondsInThePast = 7200; // {Long} How many seconds we go to the past to get the data measurements.
var opts = {
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either this cookie or the Q-Token must be set to be authorized for the API call.
  'userId': 123 // {Long} The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
};

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

namespace Example
{
    public class temperatureGetExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
            var bhiveId = 829898a53801;  // String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. (default to null)
            var epoch = 1639170002;  // Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter. (default to null)
            var secondsInThePast = 7200;  // Long | How many seconds we go to the past to get the data measurements. (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var userId = 123;  // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional)  (default to null)

            try {
                // Get Temperature values
                get-temperature-response result = apiInstance.temperatureGet(qToken, bhiveId, epoch, secondsInThePast, token, userId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.temperatureGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
$bhiveId = 829898a53801; // String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
$epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
$secondsInThePast = 7200; // Long | How many seconds we go to the past to get the data measurements.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
$userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

try {
    $result = $api_instance->temperatureGet($qToken, $bhiveId, $epoch, $secondsInThePast, $token, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->temperatureGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie or this Q-Token must be set to be authorized for the API call.
my $bhiveId = 829898a53801; # String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
my $epoch = 1639170002; # Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
my $secondsInThePast = 7200; # Long | How many seconds we go to the past to get the data measurements.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie or the Q-Token must be set to be authorized for the API call.
my $userId = 123; # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

eval {
    my $result = $api_instance->temperatureGet(qToken => $qToken, bhiveId => $bhiveId, epoch => $epoch, secondsInThePast => $secondsInThePast, token => $token, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->temperatureGet: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
bhiveId = 829898a53801 # String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. (default to null)
epoch = 1639170002 # Long | The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter. (default to null)
secondsInThePast = 7200 # Long | How many seconds we go to the past to get the data measurements. (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
userId = 123 # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)

try:
    # Get Temperature values
    api_response = api_instance.temperature_get(qToken, bhiveId, epoch, secondsInThePast, token=token, userId=userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->temperatureGet: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let bhiveId = 829898a53801; // String
    let epoch = 1639170002; // Long
    let secondsInThePast = 7200; // Long
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let userId = 123; // Long

    let mut context = DefaultApi::Context::default();
    let result = client.temperatureGet(qToken, bhiveId, epoch, secondsInThePast, token, userId, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Q-Token*
String
Either the cookie or this Q-Token must be set to be authorized for the API call.
Required
Query parameters
Name Description
bhiveId*
String
The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
Required
epoch*
Long (int64)
The Unix Time (epoch) that defines the end time of the scale measurements. The beginning is defined by the secondsInThePast parameter.
Required
secondsInThePast*
Long (int64)
How many seconds we go to the past to get the data measurements.
Required
userId
Long (int64)
The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

Responses


temperaturePost

Save a new temperature measurement

This stores a new temperature measurement in the database. Must be authorized wit ha cookie or a token.


/v1/temperature

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.queensaver.com/v1/temperature?userId=123" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
        Temperature temperature = ; // Temperature | 

        try {
            generic-post-response result = apiInstance.temperaturePost(userId, temperature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#temperaturePost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
        Temperature temperature = ; // Temperature | 

        try {
            generic-post-response result = apiInstance.temperaturePost(userId, temperature);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#temperaturePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
Long *userId = 123; // The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)
Temperature *temperature = ; //  (optional)

// Save a new temperature measurement
[apiInstance temperaturePostWith:userId
    temperature:temperature
              completionHandler: ^(generic-post-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var opts = {
  'userId': 123, // {Long} The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
  'temperature':  // {Temperature} 
};

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

namespace Example
{
    public class temperaturePostExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var userId = 123;  // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional)  (default to null)
            var temperature = new Temperature(); // Temperature |  (optional) 

            try {
                // Save a new temperature measurement
                generic-post-response result = apiInstance.temperaturePost(userId, temperature);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.temperaturePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
$temperature = ; // Temperature | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $userId = 123; # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
my $temperature = WWW::OPenAPIClient::Object::Temperature->new(); # Temperature | 

eval {
    my $result = $api_instance->temperaturePost(userId => $userId, temperature => $temperature);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->temperaturePost: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
userId = 123 # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)
temperature =  # Temperature |  (optional)

try:
    # Save a new temperature measurement
    api_response = api_instance.temperature_post(userId=userId, temperature=temperature)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->temperaturePost: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let userId = 123; // Long
    let temperature = ; // Temperature

    let mut context = DefaultApi::Context::default();
    let result = client.temperaturePost(userId, temperature, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
temperature

Query parameters
Name Description
userId
Long (int64)
The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

Responses


userPost

Create a user

This call creates a user in the queensaver system.


/v1/user

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.queensaver.com/v1/user" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        User user = ; // User | 

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

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        User user = ; // User | 

        try {
            apiInstance.userPost(user);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#userPost");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
User *user = ; //  (optional)

// Create a user
[apiInstance userPostWith:user
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var opts = {
  'user':  // {User} 
};

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

namespace Example
{
    public class userPostExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var user = new User(); // User |  (optional) 

            try {
                // Create a user
                apiInstance.userPost(user);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.userPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$user = ; // User | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $user = WWW::OPenAPIClient::Object::User->new(); # User | 

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

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
user =  # User |  (optional)

try:
    # Create a user
    api_instance.user_post(user=user)
except ApiException as e:
    print("Exception when calling DefaultApi->userPost: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let user = ; // User

    let mut context = DefaultApi::Context::default();
    let result = client.userPost(user, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
user

Responses


varroaScanGet

Get Varroa Scan images and metadata

This returns varroa scan metadata. You can search for varroa scans for a certain, defineable date range. The request needs to send a cookie along with the request. The cookie is stored under the key called "token". Note that this returns the image for a QBox Client (independent of the beeHive), the API call for an actual beeHive is different.


/v1/varroa-scan

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json" \
 "https://api.queensaver.com/v1/varroa-scan?bhiveId=829898a53801&epoch=1639170002&uuid=41C0FE2F-EB0C-45B4-8842-C117E47C35E3&hiveUuid=41C0FE2F-EB0C-45B4-8842-C117E47C35E3&userId=123&secondsInThePast=7200"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        String bhiveId = 829898a53801; // String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. You can't use this in combination with hiveUuid or uuid.
        Long epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter.
        String uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the varra-scan. If not set, the request will return scans in the given time range. If you leave out the UUID we will not return any additional data to the varroa-scans (like positions of mites).
        String hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | Return a summary of all scans according to the UUID of an assigned hive. This parameter is optional. You can't use this in combination with the bhiveId or uuid parameters.
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
        Long secondsInThePast = 7200; // Long | How many seconds we go to the past to get the data measurements.

        try {
            varroa-scan-response result = apiInstance.varroaScanGet(qToken, token, bhiveId, epoch, uuid, hiveUuid, userId, secondsInThePast);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#varroaScanGet");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        String bhiveId = 829898a53801; // String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. You can't use this in combination with hiveUuid or uuid.
        Long epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter.
        String uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the varra-scan. If not set, the request will return scans in the given time range. If you leave out the UUID we will not return any additional data to the varroa-scans (like positions of mites).
        String hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | Return a summary of all scans according to the UUID of an assigned hive. This parameter is optional. You can't use this in combination with the bhiveId or uuid parameters.
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
        Long secondsInThePast = 7200; // Long | How many seconds we go to the past to get the data measurements.

        try {
            varroa-scan-response result = apiInstance.varroaScanGet(qToken, token, bhiveId, epoch, uuid, hiveUuid, userId, secondsInThePast);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#varroaScanGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
String *bhiveId = 829898a53801; // The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. You can't use this in combination with hiveUuid or uuid. (optional) (default to null)
Long *epoch = 1639170002; // The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter. (optional) (default to null)
String *uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // The UUID of the varra-scan. If not set, the request will return scans in the given time range. If you leave out the UUID we will not return any additional data to the varroa-scans (like positions of mites). (optional) (default to null)
String *hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // Return a summary of all scans according to the UUID of an assigned hive. This parameter is optional. You can't use this in combination with the bhiveId or uuid parameters. (optional) (default to null)
Long *userId = 123; // The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)
Long *secondsInThePast = 7200; // How many seconds we go to the past to get the data measurements. (optional) (default to null)

// Get Varroa Scan images and metadata
[apiInstance varroaScanGetWith:qToken
    token:token
    bhiveId:bhiveId
    epoch:epoch
    uuid:uuid
    hiveUuid:hiveUuid
    userId:userId
    secondsInThePast:secondsInThePast
              completionHandler: ^(varroa-scan-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // {String} Either the cookie or this Q-Token must be set to be authorized for the API call.
var opts = {
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either this cookie or the Q-Token must be set to be authorized for the API call.
  'bhiveId': 829898a53801, // {String} The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. You can't use this in combination with hiveUuid or uuid.
  'epoch': 1639170002, // {Long} The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter.
  'uuid': 41C0FE2F-EB0C-45B4-8842-C117E47C35E3, // {String} The UUID of the varra-scan. If not set, the request will return scans in the given time range. If you leave out the UUID we will not return any additional data to the varroa-scans (like positions of mites).
  'hiveUuid': 41C0FE2F-EB0C-45B4-8842-C117E47C35E3, // {String} Return a summary of all scans according to the UUID of an assigned hive. This parameter is optional. You can't use this in combination with the bhiveId or uuid parameters.
  'userId': 123, // {Long} The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
  'secondsInThePast': 7200 // {Long} How many seconds we go to the past to get the data measurements.
};

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

namespace Example
{
    public class varroaScanGetExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var bhiveId = 829898a53801;  // String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. You can't use this in combination with hiveUuid or uuid. (optional)  (default to null)
            var epoch = 1639170002;  // Long | The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter. (optional)  (default to null)
            var uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3;  // String | The UUID of the varra-scan. If not set, the request will return scans in the given time range. If you leave out the UUID we will not return any additional data to the varroa-scans (like positions of mites). (optional)  (default to null)
            var hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3;  // String | Return a summary of all scans according to the UUID of an assigned hive. This parameter is optional. You can't use this in combination with the bhiveId or uuid parameters. (optional)  (default to null)
            var userId = 123;  // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional)  (default to null)
            var secondsInThePast = 7200;  // Long | How many seconds we go to the past to get the data measurements. (optional)  (default to null)

            try {
                // Get Varroa Scan images and metadata
                varroa-scan-response result = apiInstance.varroaScanGet(qToken, token, bhiveId, epoch, uuid, hiveUuid, userId, secondsInThePast);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.varroaScanGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
$bhiveId = 829898a53801; // String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. You can't use this in combination with hiveUuid or uuid.
$epoch = 1639170002; // Long | The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter.
$uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the varra-scan. If not set, the request will return scans in the given time range. If you leave out the UUID we will not return any additional data to the varroa-scans (like positions of mites).
$hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | Return a summary of all scans according to the UUID of an assigned hive. This parameter is optional. You can't use this in combination with the bhiveId or uuid parameters.
$userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
$secondsInThePast = 7200; // Long | How many seconds we go to the past to get the data measurements.

try {
    $result = $api_instance->varroaScanGet($qToken, $token, $bhiveId, $epoch, $uuid, $hiveUuid, $userId, $secondsInThePast);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->varroaScanGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie or this Q-Token must be set to be authorized for the API call.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie or the Q-Token must be set to be authorized for the API call.
my $bhiveId = 829898a53801; # String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. You can't use this in combination with hiveUuid or uuid.
my $epoch = 1639170002; # Long | The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter.
my $uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; # String | The UUID of the varra-scan. If not set, the request will return scans in the given time range. If you leave out the UUID we will not return any additional data to the varroa-scans (like positions of mites).
my $hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; # String | Return a summary of all scans according to the UUID of an assigned hive. This parameter is optional. You can't use this in combination with the bhiveId or uuid parameters.
my $userId = 123; # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
my $secondsInThePast = 7200; # Long | How many seconds we go to the past to get the data measurements.

eval {
    my $result = $api_instance->varroaScanGet(qToken => $qToken, token => $token, bhiveId => $bhiveId, epoch => $epoch, uuid => $uuid, hiveUuid => $hiveUuid, userId => $userId, secondsInThePast => $secondsInThePast);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->varroaScanGet: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
bhiveId = 829898a53801 # String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. You can't use this in combination with hiveUuid or uuid. (optional) (default to null)
epoch = 1639170002 # Long | The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter. (optional) (default to null)
uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3 # String | The UUID of the varra-scan. If not set, the request will return scans in the given time range. If you leave out the UUID we will not return any additional data to the varroa-scans (like positions of mites). (optional) (default to null)
hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3 # String | Return a summary of all scans according to the UUID of an assigned hive. This parameter is optional. You can't use this in combination with the bhiveId or uuid parameters. (optional) (default to null)
userId = 123 # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)
secondsInThePast = 7200 # Long | How many seconds we go to the past to get the data measurements. (optional) (default to null)

try:
    # Get Varroa Scan images and metadata
    api_response = api_instance.varroa_scan_get(qToken, token=token, bhiveId=bhiveId, epoch=epoch, uuid=uuid, hiveUuid=hiveUuid, userId=userId, secondsInThePast=secondsInThePast)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->varroaScanGet: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let bhiveId = 829898a53801; // String
    let epoch = 1639170002; // Long
    let uuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String
    let hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String
    let userId = 123; // Long
    let secondsInThePast = 7200; // Long

    let mut context = DefaultApi::Context::default();
    let result = client.varroaScanGet(qToken, token, bhiveId, epoch, uuid, hiveUuid, userId, secondsInThePast, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Q-Token*
String
Either the cookie or this Q-Token must be set to be authorized for the API call.
Required
Query parameters
Name Description
bhiveId
String
The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. You can't use this in combination with hiveUuid or uuid.
epoch
Long (int64)
The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter.
uuid
String
The UUID of the varra-scan. If not set, the request will return scans in the given time range. If you leave out the UUID we will not return any additional data to the varroa-scans (like positions of mites).
hiveUuid
String
Return a summary of all scans according to the UUID of an assigned hive. This parameter is optional. You can't use this in combination with the bhiveId or uuid parameters.
userId
Long (int64)
The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
secondsInThePast
Long (int64)
How many seconds we go to the past to get the data measurements.

Responses


varroaScanImageAssociate

Associate a varroa scan with a bee hive

This connects a scan with a hive.


/v1/varroa-scan

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/json" \
 "https://api.queensaver.com/v1/varroa-scan?userId=123&varroaScanImageUuid=41C0FE2F-EB0C-45B4-8842-C117E47C35E3&hiveUuid=41C0FE2F-EB0C-45B4-8842-C117E47C35E3"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String varroaScanImageUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the varroa scan.
        String hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the varroa bee hive (see the /v1/hives call).
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

        try {
            generic-post-response result = apiInstance.varroaScanImageAssociate(varroaScanImageUuid, hiveUuid, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#varroaScanImageAssociate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String varroaScanImageUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the varroa scan.
        String hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the varroa bee hive (see the /v1/hives call).
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

        try {
            generic-post-response result = apiInstance.varroaScanImageAssociate(varroaScanImageUuid, hiveUuid, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#varroaScanImageAssociate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *varroaScanImageUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // The UUID of the varroa scan. (default to null)
String *hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // The UUID of the varroa bee hive (see the /v1/hives call). (default to null)
Long *userId = 123; // The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)

// Associate a varroa scan with a bee hive
[apiInstance varroaScanImageAssociateWith:varroaScanImageUuid
    hiveUuid:hiveUuid
    userId:userId
              completionHandler: ^(generic-post-response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var varroaScanImageUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // {String} The UUID of the varroa scan.
var hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // {String} The UUID of the varroa bee hive (see the /v1/hives call).
var opts = {
  'userId': 123 // {Long} The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
};

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

namespace Example
{
    public class varroaScanImageAssociateExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var varroaScanImageUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3;  // String | The UUID of the varroa scan. (default to null)
            var hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3;  // String | The UUID of the varroa bee hive (see the /v1/hives call). (default to null)
            var userId = 123;  // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional)  (default to null)

            try {
                // Associate a varroa scan with a bee hive
                generic-post-response result = apiInstance.varroaScanImageAssociate(varroaScanImageUuid, hiveUuid, userId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.varroaScanImageAssociate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$varroaScanImageUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the varroa scan.
$hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String | The UUID of the varroa bee hive (see the /v1/hives call).
$userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

try {
    $result = $api_instance->varroaScanImageAssociate($varroaScanImageUuid, $hiveUuid, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->varroaScanImageAssociate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $varroaScanImageUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; # String | The UUID of the varroa scan.
my $hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; # String | The UUID of the varroa bee hive (see the /v1/hives call).
my $userId = 123; # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

eval {
    my $result = $api_instance->varroaScanImageAssociate(varroaScanImageUuid => $varroaScanImageUuid, hiveUuid => $hiveUuid, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->varroaScanImageAssociate: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
varroaScanImageUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3 # String | The UUID of the varroa scan. (default to null)
hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3 # String | The UUID of the varroa bee hive (see the /v1/hives call). (default to null)
userId = 123 # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)

try:
    # Associate a varroa scan with a bee hive
    api_response = api_instance.varroa_scan_image_associate(varroaScanImageUuid, hiveUuid, userId=userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->varroaScanImageAssociate: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let varroaScanImageUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String
    let hiveUuid = 41C0FE2F-EB0C-45B4-8842-C117E47C35E3; // String
    let userId = 123; // Long

    let mut context = DefaultApi::Context::default();
    let result = client.varroaScanImageAssociate(varroaScanImageUuid, hiveUuid, userId, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
userId
Long (int64)
The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
varroaScanImageUuid*
String
The UUID of the varroa scan.
Required
hiveUuid*
String
The UUID of the varroa bee hive (see the /v1/hives call).
Required

Responses


varroaScanImagePost

Save Varroa Scan image

Upload a varroa scan image here. The file is attached via multipart/form-data.


/v1/varroa-scan-image

Usage and SDK Samples

curl -X POST \
 \
 -H "Content-Type: multipart/form-data" \
 "https://api.queensaver.com/v1/varroa-scan-image"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 789; // Long | the internal user id of the authenticated user. Will be set internally in the cloud system and does not have an effect if set via the API call as it will be overridden. Don't set this value.
        String bhiveId = bhiveId_example; // String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
        String hiveUuid = hiveUuid_example; // String | The UUID of a hive. This is used for a photobox. Leave empty if you don't know the associated hive yet.
        Long epoch = 789; // Long | The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter.
        byte[] scan = BYTE_ARRAY_DATA_HERE; // byte[] | 

        try {
            apiInstance.varroaScanImagePost(qToken, token, userId, bhiveId, hiveUuid, epoch, scan);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#varroaScanImagePost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
        String token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
        Long userId = 789; // Long | the internal user id of the authenticated user. Will be set internally in the cloud system and does not have an effect if set via the API call as it will be overridden. Don't set this value.
        String bhiveId = bhiveId_example; // String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
        String hiveUuid = hiveUuid_example; // String | The UUID of a hive. This is used for a photobox. Leave empty if you don't know the associated hive yet.
        Long epoch = 789; // Long | The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter.
        byte[] scan = BYTE_ARRAY_DATA_HERE; // byte[] | 

        try {
            apiInstance.varroaScanImagePost(qToken, token, userId, bhiveId, hiveUuid, epoch, scan);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#varroaScanImagePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
String *token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
Long *userId = 789; // the internal user id of the authenticated user. Will be set internally in the cloud system and does not have an effect if set via the API call as it will be overridden. Don't set this value. (optional) (default to null)
String *bhiveId = bhiveId_example; // The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. (optional) (default to null)
String *hiveUuid = hiveUuid_example; // The UUID of a hive. This is used for a photobox. Leave empty if you don't know the associated hive yet. (optional) (default to null)
Long *epoch = 789; // The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter. (optional) (default to null)
byte[] *scan = BYTE_ARRAY_DATA_HERE; //  (optional) (default to null)

// Save Varroa Scan image
[apiInstance varroaScanImagePostWith:qToken
    token:token
    userId:userId
    bhiveId:bhiveId
    hiveUuid:hiveUuid
    epoch:epoch
    scan:scan
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // {String} Either the cookie or this Q-Token must be set to be authorized for the API call.
var opts = {
  'token': 8B0FE5CF-C096-4B3E-8748-27906B4A9449, // {String} Either this cookie or the Q-Token must be set to be authorized for the API call.
  'userId': 789, // {Long} the internal user id of the authenticated user. Will be set internally in the cloud system and does not have an effect if set via the API call as it will be overridden. Don't set this value.
  'bhiveId': bhiveId_example, // {String} The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
  'hiveUuid': hiveUuid_example, // {String} The UUID of a hive. This is used for a photobox. Leave empty if you don't know the associated hive yet.
  'epoch': 789, // {Long} The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter.
  'scan': BYTE_ARRAY_DATA_HERE // {byte[]} 
};

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

namespace Example
{
    public class varroaScanImagePostExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
            var token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449;  // String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional)  (default to null)
            var userId = 789;  // Long | the internal user id of the authenticated user. Will be set internally in the cloud system and does not have an effect if set via the API call as it will be overridden. Don't set this value. (optional)  (default to null)
            var bhiveId = bhiveId_example;  // String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. (optional)  (default to null)
            var hiveUuid = hiveUuid_example;  // String | The UUID of a hive. This is used for a photobox. Leave empty if you don't know the associated hive yet. (optional)  (default to null)
            var epoch = 789;  // Long | The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter. (optional)  (default to null)
            var scan = BYTE_ARRAY_DATA_HERE;  // byte[] |  (optional)  (default to null)

            try {
                // Save Varroa Scan image
                apiInstance.varroaScanImagePost(qToken, token, userId, bhiveId, hiveUuid, epoch, scan);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.varroaScanImagePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either the cookie or this Q-Token must be set to be authorized for the API call.
$token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String | Either this cookie or the Q-Token must be set to be authorized for the API call.
$userId = 789; // Long | the internal user id of the authenticated user. Will be set internally in the cloud system and does not have an effect if set via the API call as it will be overridden. Don't set this value.
$bhiveId = bhiveId_example; // String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
$hiveUuid = hiveUuid_example; // String | The UUID of a hive. This is used for a photobox. Leave empty if you don't know the associated hive yet.
$epoch = 789; // Long | The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter.
$scan = BYTE_ARRAY_DATA_HERE; // byte[] | 

try {
    $api_instance->varroaScanImagePost($qToken, $token, $userId, $bhiveId, $hiveUuid, $epoch, $scan);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->varroaScanImagePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either the cookie or this Q-Token must be set to be authorized for the API call.
my $token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; # String | Either this cookie or the Q-Token must be set to be authorized for the API call.
my $userId = 789; # Long | the internal user id of the authenticated user. Will be set internally in the cloud system and does not have an effect if set via the API call as it will be overridden. Don't set this value.
my $bhiveId = bhiveId_example; # String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
my $hiveUuid = hiveUuid_example; # String | The UUID of a hive. This is used for a photobox. Leave empty if you don't know the associated hive yet.
my $epoch = 789; # Long | The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter.
my $scan = BYTE_ARRAY_DATA_HERE; # byte[] | 

eval {
    $api_instance->varroaScanImagePost(qToken => $qToken, token => $token, userId => $userId, bhiveId => $bhiveId, hiveUuid => $hiveUuid, epoch => $epoch, scan => $scan);
};
if ($@) {
    warn "Exception when calling DefaultApi->varroaScanImagePost: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either the cookie or this Q-Token must be set to be authorized for the API call. (default to null)
token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449 # String | Either this cookie or the Q-Token must be set to be authorized for the API call. (optional) (default to null)
userId = 789 # Long | the internal user id of the authenticated user. Will be set internally in the cloud system and does not have an effect if set via the API call as it will be overridden. Don't set this value. (optional) (default to null)
bhiveId = bhiveId_example # String | The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call. (optional) (default to null)
hiveUuid = hiveUuid_example # String | The UUID of a hive. This is used for a photobox. Leave empty if you don't know the associated hive yet. (optional) (default to null)
epoch = 789 # Long | The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter. (optional) (default to null)
scan = BYTE_ARRAY_DATA_HERE # byte[] |  (optional) (default to null)

try:
    # Save Varroa Scan image
    api_instance.varroa_scan_image_post(qToken, token=token, userId=userId, bhiveId=bhiveId, hiveUuid=hiveUuid, epoch=epoch, scan=scan)
except ApiException as e:
    print("Exception when calling DefaultApi->varroaScanImagePost: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let qToken = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let token = 8B0FE5CF-C096-4B3E-8748-27906B4A9449; // String
    let userId = 789; // Long
    let bhiveId = bhiveId_example; // String
    let hiveUuid = hiveUuid_example; // String
    let epoch = 789; // Long
    let scan = BYTE_ARRAY_DATA_HERE; // byte[]

    let mut context = DefaultApi::Context::default();
    let result = client.varroaScanImagePost(qToken, token, userId, bhiveId, hiveUuid, epoch, scan, &context).wait();

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

Scopes

Parameters

Header parameters
Name Description
Q-Token*
String
Either the cookie or this Q-Token must be set to be authorized for the API call.
Required
Form parameters
Name Description
userId
Long (int64)
the internal user id of the authenticated user. Will be set internally in the cloud system and does not have an effect if set via the API call as it will be overridden. Don't set this value.
bhiveId
String
The Mac Address of the QBox client. You can get all QBox IDs and clients with the /config API call.
hiveUuid
String
The UUID of a hive. This is used for a photobox. Leave empty if you don't know the associated hive yet.
epoch
Long (int64)
The Unix Time (epoch) that defines the end time of the varroa images. The beginning is defined by the secondsInThePast parameter.
scan
byte[] (byte)

Responses


varroaScanPost

Save Varroa Scan metadata

This saves varroa scan metadata. This is not callable from an external API.


/v1/varroa-scan

Usage and SDK Samples

curl -X POST \
 \
 -H "Content-Type: application/json" \
 "https://api.queensaver.com/v1/varroa-scan?userId=123" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;

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

public class DefaultApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: cookieAuth
        ApiKeyAuth cookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("cookieAuth");
        cookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //cookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DefaultApi apiInstance = new DefaultApi();
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
        VarroaScan varroaScan = ; // VarroaScan | 

        try {
            apiInstance.varroaScanPost(userId, varroaScan);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#varroaScanPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DefaultApi;

public class DefaultApiExample {
    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Long userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
        VarroaScan varroaScan = ; // VarroaScan | 

        try {
            apiInstance.varroaScanPost(userId, varroaScan);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#varroaScanPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
Long *userId = 123; // The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)
VarroaScan *varroaScan = ; //  (optional)

// Save Varroa Scan metadata
[apiInstance varroaScanPostWith:userId
    varroaScan:varroaScan
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var QueensaverApi = require('queensaver_api');
var defaultClient = QueensaverApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new QueensaverApi.DefaultApi()
var opts = {
  'userId': 123, // {Long} The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
  'varroaScan':  // {VarroaScan} 
};

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

namespace Example
{
    public class varroaScanPostExample
    {
        public void main()
        {
            // Configure API key authorization: cookieAuth
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DefaultApi();
            var userId = 123;  // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional)  (default to null)
            var varroaScan = new VarroaScan(); // VarroaScan |  (optional) 

            try {
                // Save Varroa Scan metadata
                apiInstance.varroaScanPost(userId, varroaScan);
            } catch (Exception e) {
                Debug.Print("Exception when calling DefaultApi.varroaScanPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$userId = 123; // Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
$varroaScan = ; // VarroaScan | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $userId = 123; # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.
my $varroaScan = WWW::OPenAPIClient::Object::VarroaScan->new(); # VarroaScan | 

eval {
    $api_instance->varroaScanPost(userId => $userId, varroaScan => $varroaScan);
};
if ($@) {
    warn "Exception when calling DefaultApi->varroaScanPost: $@\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: cookieAuth
openapi_client.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['token'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
userId = 123 # Long | The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore. (optional) (default to null)
varroaScan =  # VarroaScan |  (optional)

try:
    # Save Varroa Scan metadata
    api_instance.varroa_scan_post(userId=userId, varroaScan=varroaScan)
except ApiException as e:
    print("Exception when calling DefaultApi->varroaScanPost: %s\n" % e)
extern crate DefaultApi;

pub fn main() {
    let userId = 123; // Long
    let varroaScan = ; // VarroaScan

    let mut context = DefaultApi::Context::default();
    let result = client.varroaScanPost(userId, varroaScan, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
varroaScan

Query parameters
Name Description
userId
Long (int64)
The User ID. This is used internally and will be overwritten if you send it to the api server. Ignore.

Responses