• CUWB 3.3 (Bernoulli)
CUWB Manager - API Control

Overview

The CUWB Manager API is a REST API that is automatically ran as a systemd unit following the installation of the cuwb-network package. This API configures all of the resource units required to facilitate the creation, configuration, and deletion of CUWB Networks within the CUWB RTLS platform. This is the vessel through which the CUWB Manager’s web-based frontend requests adjustments through HTTP to the CUWB Network’s .cuwb saved state files. Users have the option of creating their own control mechanisms utilizing this API by issuing the following requests over any of the host machine’s network interfaces on port 5000. The expected response formats are also provided for success, failure, and error scenarios.

Version information

Version : 1.1

JSON Format

This information can also be queried through the API itself via GET /api.json

Resources

  • CDP Streams
  • CUWB Networks
  • Calculate Maximum Tags
  • Default Settings
  • Device Commands
  • Device Configurations
  • Device Settings
  • Devices
  • Interface Roles
  • Interfaces
  • Log Messages
  • Magnetometer Calibration
  • Packages
  • Paired Interfaces
  • Position Limits
  • RF Settings
  • Roles
  • Settings

Produces

  • application/json
  • text/html

Resources

CDP Streams

The GET method for a list of all CDP streams.

GET /cuwbnets/{cuwb_name}/cdp-streams

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string

Responses

HTTP Code Description Schema
200 CDP Stream List Response 200

Response 200

Name Schema
cdp-streams
optional		 < object > array

The GET method for a single CDP stream.

GET /cuwbnets/{cuwb_name}/cdp-streams/{id}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path id
required		 The id of the CDP stream to use. integer

Responses

HTTP Code Description Schema
200 CDP Stream Response 200
404 Not found. Response 404

Response 200

Name Schema
cdp-stream
optional		 string

Response 404

Name Schema
message
optional		 string

The PATCH method for a single CDP stream.

PATCH /cuwbnets/{cuwb_name}/cdp-streams/{id}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path id
required		 The id of the CDP stream to use. integer
Body cdp_stream_body
required		 The request body cdp_stream_body

cdp_stream_body

Name Schema
destination_ip
optional		 string
destination_port
optional		 integer
interface
optional		 string
interface_port
optional		 integer
time_to_live
optional		 integer

Responses

HTTP Code Description Schema
200 CDP Stream Response 200
400 Invalid request. Response 400
404 Not found. Response 404
409 Conflict. Response 409
500 Internal error. Response 500

Response 200

Name Schema
cdp-stream
optional		 string

Response 400

Name Schema
message
optional		 string

Response 404

Name Schema
message
optional		 string

Response 409

Name Schema
message
optional		 string

Response 500

Name Schema
message
optional		 string

CUWB Networks

Create a new CUWB Network object.

POST /cuwbnets

Parameters

Type Name Description Schema
Body cuwb_network_body
required		 The request body cuwb_network_body

cuwb_network_body

Name Schema
instance
optional		 string
name
optional		 string

Responses

HTTP Code Description Schema
201 CUWB Network Response 201
400 Invalid request. Response 400
409 Conflict. Response 409

Response 201

Name Schema
cuwbnets
optional		 string

Response 400

Name Schema
message
optional		 string

Response 409

Name Schema
message
optional		 string

Get a list of ALL CUWB Networks on the system.

GET /cuwbnets

Responses

HTTP Code Description Schema
200 CUWB Network List Response 200

Response 200

Name Schema
cuwbnets
optional		 < object > array

Upload a CUWB network.

POST /cuwbnets/upload

Parameters

Type Name Description Schema
FormData cuwb_file
optional		 A CUWB network file to upload file

Responses

HTTP Code Description Schema
201 CUWB Network Response 201
400 Invalid request. Response 400
409 CUWB network already exists. Response 409

Response 201

Name Schema
cuwbnets
optional		 string

Response 400

Name Schema
message
optional		 string

Response 409

Name Schema
message
optional		 string

Consumes

  • multipart/form-data

POST an action to a CUWB Network.

POST /cuwbnets/{cuwb_name}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of a CUWB network string
Body action_body
required		 The request body action_body

action_body

Name Schema
action
optional		 string
name
optional		 string

Responses

HTTP Code Description Schema
200 Action succeeded. Response 200
400 Invalid request. Response 400
404 Not found. Response 404

Response 200

Name Schema
status
optional		 string

Response 400

Name Schema
message
optional		 string

Response 404

Name Schema
message
optional		 string

Get details about ONE CUWB Network.

GET /cuwbnets/{cuwb_name}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of a CUWB network string

Responses

HTTP Code Description Schema
200 CUWB Network Response 200
404 Not found. Response 404

Response 200

Name Schema
cuwbnets
optional		 string

Response 404

Name Schema
message
optional		 string

Delete ONE CUWB Network record.

DELETE /cuwbnets/{cuwb_name}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of a CUWB network string

Responses

HTTP Code Description Schema
204 Item deleted. Response 204

Response 204

Name Schema
message
optional		 string

Update ONE CUWB Network record.

PATCH /cuwbnets/{cuwb_name}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of a CUWB network string
Body cuwb_network_body
required		 The request body cuwb_network_body

cuwb_network_body

Name Schema
instance
optional		 string
name
optional		 string

Responses

HTTP Code Description Schema
200 CUWB Network Response 200
400 Invalid request. Response 400
404 Not found. Response 404

Response 200

Name Schema
cuwbnets
optional		 string

Response 400

Name Schema
message
optional		 string

Response 404

Name Schema
message
optional		 string

Download a CUWB network.

GET /cuwbnets/{cuwb_name}/download

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of a CUWB network string

Responses

HTTP Code Description Schema
200 CUWB Network File Response 200
404 Not found. Response 404

Response 200

Name Schema
file
optional		 string

Response 404

Name Schema
message
optional		 string

Calculate Maximum Tags

Run a maximum tags calculation with parameters.

POST /calculate_maximum_tags

Parameters

Type Name Description Schema
Body calculate_maximum_tags_parameterized_body
required		 The request body calculate_maximum_tags_parameterized_body

calculate_maximum_tags_parameterized_body

Name Schema
device_configuration
optional		 string
maximum_tag_period
optional		 integer
number_of_seeders
optional		 integer
seeder_period
optional		 integer
tag_period
optional		 integer

Responses

HTTP Code Description Schema
200 Calculate maximum tags Response 200
400 Invalid request. Response 400
404 Not found. Response 404
409 Conflict. Response 409
500 Internal error. Response 500

Response 200

Name Schema
maximum_tags_calculation
optional		 string

Response 400

Name Schema
message
optional		 string

Response 404

Name Schema
message
optional		 string

Response 409

Name Schema
message
optional		 string

Response 500

Name Schema
maximum_tags_calculation
optional		 string

Run a maximum tags calculation.

POST /cuwbnets/{cuwb_name}/calculate_maximum_tags

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Body calculate_maximum_tags_body
required		 The request body calculate_maximum_tags_body

calculate_maximum_tags_body

Name Schema
device_configuration_id
optional		 integer
role_id
optional		 integer

Responses

HTTP Code Description Schema
200 Calculate maximum tags Response 200
400 Invalid request. Response 400
404 Not found. Response 404
409 Conflict. Response 409
500 Internal error. Response 500

Response 200

Name Schema
maximum_tags_calculation
optional		 string

Response 400

Name Schema
message
optional		 string

Response 404

Name Schema
message
optional		 string

Response 409

Name Schema
message
optional		 string

Response 500

Name Schema
maximum_tags_calculation
optional		 string

Default Settings

The GET method for a list of all settings.

GET /default-settings

Responses

HTTP Code Description Schema
200 Setting List Response 200

Response 200

Name Schema
default_settings
optional		 string

The GET method for a single setting.

GET /default-settings/{key}

Parameters

Type Name Description Schema
Path key
required		 The key of the setting to use. string

Responses

HTTP Code Description Schema
200 Setting Response 200
404 Not found. Response 404

Response 200

Name Schema
default_setting
optional		 string

Response 404

Name Schema
message
optional		 string

Device Commands

The POST method for a device command.

POST /cuwbnets/{cuwb_name}/devices/{device_key}/action

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_key
required		 Either a Ciholas serial number or an integer ID. string
Body device_command_body
required		 The request body device_command_body

device_command_body

Name Schema
action
optional		 string
color
optional		 string
mode
optional		 string

Responses

HTTP Code Description Schema
200 Device Command Response 200
400 Invalid request. Response 400
404 Not found. Response 404

Response 200

Name Schema
status
optional		 string

Response 400

Name Schema
message
optional		 string

Response 404

Name Schema
message
optional		 string

Device Configurations

The POST method for adding a new device configuration.

POST /cuwbnets/{cuwb_name}/device_configurations

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the cuwbnet to use. string
Body device_configuration_body
required		 The request body device_configuration_body

device_configuration_body

Name Schema
accelerometer_period
optional		 integer
gyroscope_period
optional		 integer
led_brightness
optional		 string
magnetometer_period
optional		 integer
name
optional		 string
position_period
optional		 integer
pressure_period
optional		 integer
quaternion_period
optional		 integer
temperature_period
optional		 integer

Responses

HTTP Code Description Schema
201 Device Configuration Response 201
400 Invalid request. Response 400
409 Conflict. Response 409
500 Internal error. Response 500

Response 201

Name Schema
device_configuration
optional		 string

Response 400

Name Schema
message
optional		 string

Response 409

Name Schema
message
optional		 string

Response 500

Name Schema
message
optional		 string

The GET method for a list of all device configurations.

GET /cuwbnets/{cuwb_name}/device_configurations

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the cuwbnet to use. string

Responses

HTTP Code Description Schema
200 Device Configuration List Response 200

Response 200

Name Schema
device_configurations
optional		 string

The GET method for a single device configuration.

GET /cuwbnets/{cuwb_name}/device_configurations/{device_configuration_id}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the cuwbnet to use. string
Path device_configuration_id
required		 The ID of the device configuration integer

Responses

HTTP Code Description Schema
200 Device Configuration Response 200
404 Not found. Response 404

Response 200

Name Schema
device_configuration
optional		 string

Response 404

Name Schema
message
optional		 string

The DELETE method for a single device_configuration.

DELETE /cuwbnets/{cuwb_name}/device_configurations/{device_configuration_id}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the cuwbnet to use. string
Path device_configuration_id
required		 The ID of the device configuration integer

Responses

HTTP Code Description Schema
204 Item deleted. Response 204
409 Conflict. Response 409

Response 204

Name Schema
message
optional		 string

Response 409

Name Schema
message
optional		 string

The PATCH method for a device configuration.

PATCH /cuwbnets/{cuwb_name}/device_configurations/{device_configuration_id}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the cuwbnet to use. string
Path device_configuration_id
required		 The ID of the device configuration integer
Body device_configuration_body
required		 The request body device_configuration_body

device_configuration_body

Name Schema
accelerometer_period
optional		 integer
gyroscope_period
optional		 integer
led_brightness
optional		 string
magnetometer_period
optional		 integer
name
optional		 string
position_period
optional		 integer
pressure_period
optional		 integer
quaternion_period
optional		 integer
temperature_period
optional		 integer

Responses

HTTP Code Description Schema
200 Device Configuration Response 200
400 Invalid request. Response 400
404 Not found. Response 404
409 Conflict. Response 409
500 Internal error. Response 500

Response 200

Name Schema
device_configuration
optional		 string

Response 400

Name Schema
message
optional		 string

Response 404

Name Schema
message
optional		 string

Response 409

Name Schema
message
optional		 string

Response 500

Name Schema
message
optional		 string

Device Settings

The POST method to create a new device setting.

POST /cuwbnets/{cuwb_name}/device-settings

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Body device_settings_post_body
required		 The request body device_settings_post_body

device_settings_post_body

Name Schema
device_id
optional		 integer

Responses

HTTP Code Description Schema
200 Device Setting Response 200
400 Invalid request. Response 400
409 Conflict. Response 409
500 Internal error. Response 500

Response 200

Name Schema
device_setting
optional		 string

Response 400

Name Schema
message
optional		 string

Response 409

Name Schema
message
optional		 string

Response 500

Name Schema
message
optional		 string

The GET method for a list of all device settings.

GET /cuwbnets/{cuwb_name}/device-settings

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string

Responses

HTTP Code Description Schema
200 Device Setting List Response 200

Response 200

Name Schema
device_settings
optional		 string

The GET method for a list of all device settings for a Device ID.

GET /cuwbnets/{cuwb_name}/devices/{device_id}/settings

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_id
required		 The Device ID the setting is used for. string

Responses

HTTP Code Description Schema
200 Device Settings List Response 200
404 Not found. Response 404

Response 200

Name Schema
device_settings
optional		 string

Response 404

Name Schema
message
optional		 string

The GET method for a single device setting.

GET /cuwbnets/{cuwb_name}/devices/{device_id}/settings/{key}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_id
required		 The Device ID the setting is used for. string
Path key
required		 The key of the setting to use. string

Responses

HTTP Code Description Schema
200 Device Setting Response 200
404 Not found. Response 404

Response 200

Name Schema
device_setting
optional		 string

Response 404

Name Schema
message
optional		 string

The PUT method for a single device setting.

PUT /cuwbnets/{cuwb_name}/devices/{device_id}/settings/{key}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_id
required		 The Device ID the setting is used for. string
Path key
required		 The key of the setting to use. string
Body device_settings_put_body
required		 The request body object

Responses

HTTP Code Description Schema
200 Device Setting Response 200
500 Internal error. Response 500

Response 200

Name Schema
device_setting
optional		 string

Response 500

Name Schema
message
optional		 string

The DELETE method for a device setting.

DELETE /cuwbnets/{cuwb_name}/devices/{device_id}/settings/{key}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_id
required		 The Device ID the setting is used for. string
Path key
required		 The key of the setting to use. string

Responses

HTTP Code Description Schema
204 Item deleted. Response 204

Response 204

Name Schema
message
optional		 string

The PATCH method for a single device setting.

PATCH /cuwbnets/{cuwb_name}/devices/{device_id}/settings/{key}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_id
required		 The Device ID the setting is used for. string
Path key
required		 The key of the setting to use. string
Body device_settings_put_body
required		 The request body object

Responses

HTTP Code Description Schema
200 Device Setting Response 200
404 Not found. Response 404
500 Internal error. Response 500

Response 200

Name Schema
device_setting
optional		 string

Response 404

Name Schema
message
optional		 string

Response 500

Name Schema
message
optional		 string

Devices

The POST method for adding a new device.

POST /cuwbnets/{cuwb_name}/devices

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Body device_body
required		 The request body device_body

device_body

Name Schema
disabled
optional		 boolean
interfaces
optional		 string
serial_number
optional		 string

Responses

HTTP Code Description Schema
201 Device Response 201
400 Invalid request. Response 400
409 Conflict. Response 409
500 Internal errror. Response 500

Response 201

Name Schema
device
optional		 string

Response 400

Name Schema
message
optional		 string

Response 409

Name Schema
message
optional		 string

Response 500

Name Schema
message
optional		 string

The GET method for a list of all devices.

GET /cuwbnets/{cuwb_name}/devices

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string

Responses

HTTP Code Description Schema
200 Device List Response 200

Response 200

Name Schema
devices
optional		 string

The GET method for a single device.

GET /cuwbnets/{cuwb_name}/devices/{device_key}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_key
required		 Either a Ciholas serial number or an integer ID. string

Responses

HTTP Code Description Schema
200 Device Response 200
404 Not found. Response 404

Response 200

Name Schema
device
optional		 string

Response 404

Name Schema
message
optional		 string

The DELETE method for a single device.

DELETE /cuwbnets/{cuwb_name}/devices/{device_key}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_key
required		 Either a Ciholas serial number or an integer ID. string

Responses

HTTP Code Description Schema
204 Item deleted. Response 204

Response 204

Name Schema
message
optional		 string

The PATCH method for a single device.

PATCH /cuwbnets/{cuwb_name}/devices/{device_key}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_key
required		 Either a Ciholas serial number or an integer ID. string
Body device_body
required		 The request body device_body

device_body

Name Schema
disabled
optional		 boolean
interfaces
optional		 string
serial_number
optional		 string

Responses

HTTP Code Description Schema
200 Device Response 200
400 Invalid request. Response 400
404 Not found. Response 404
500 Internal error. Response 500

Response 200

Name Schema
device
optional		 string

Response 400

Name Schema
message
optional		 string

Response 404

Name Schema
message
optional		 string

Response 500

Name Schema
message
optional		 string

The DELETE method for multiple devices

DELETE /cuwbnets/{cuwb_name}/devices

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Body multiple_device_delete_body
required		 The request body multiple_device_delete_body

multiple_device_delete_body

Name Schema
delete
optional		 < string > array

Responses

HTTP Code Description Schema
204 Devices deleted. Response 204

Response 204

Name Schema
message
optional		 string

The PATCH method for multiple devices

PATCH /cuwbnets/{cuwb_name}/devices

Parameters

Type Name Description Schema
Path cuwb_name
*required		 The name of the database to use. string
Body multiple_device_patch_body
*required		 The request body object

Responses

HTTP Code Description Schema
200 Device Patch Statuses object
400 Invalid request. object
404 Not found. object
500 Internal error. object

Interface Roles

The GET method for a list of all roles.

GET /cuwbnets/{cuwb_name}/devices/{device_key}-{interface_identifier}/roles

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_key
required		 Either a Ciholas serial number or an integer ID. string
Path interface_identifier
required		 An identifier for interfaces. integer

Responses

HTTP Code Description Schema
200 Device Roles Response 200
404 Not found. Response 404

Response 200

Name Schema
roles
optional		 string

Response 404

Name Schema
message
optional		 string

The GET method for a single role.

GET /cuwbnets/{cuwb_name}/devices/{device_key}-{interface_identifier}/roles/{role_id}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_key
required		 Either a Ciholas serial number or an integer ID. string
Path interface_identifier
required		 An identifier for interfaces. integer
Path role_id
required		 An id for roles. integer

Responses

HTTP Code Description Schema
200 Device Role Response 200
404 Not found. Response 404

Response 200

Name Schema
role
optional		 string

Response 404

Name Schema
message
optional		 string

The DELETE method for a single role.

DELETE /cuwbnets/{cuwb_name}/devices/{device_key}-{interface_identifier}/roles/{role_id}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_key
required		 Either a Ciholas serial number or an integer ID. string
Path interface_identifier
required		 An identifier for interfaces. integer
Path role_id
required		 An id for roles. integer

Responses

HTTP Code Description Schema
204 Item deleted. Response 204

Response 204

Name Schema
message
optional		 string

The GET method for a list of all roles.

GET /cuwbnets/{cuwb_name}/devices/{device_key}/interfaces/{interface_identifier}/roles

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_key
required		 Either a Ciholas serial number or an integer ID. string
Path interface_identifier
required		 An identifier for interfaces. integer

Responses

HTTP Code Description Schema
200 Device Roles Response 200
404 Not found. Response 404

Response 200

Name Schema
roles
optional		 string

Response 404

Name Schema
message
optional		 string

The GET method for a single role.

GET /cuwbnets/{cuwb_name}/devices/{device_key}/interfaces/{interface_identifier}/roles/{role_id}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_key
required		 Either a Ciholas serial number or an integer ID. string
Path interface_identifier
required		 An identifier for interfaces. integer
Path role_id
required		 An id for roles. integer

Responses

HTTP Code Description Schema
200 Device Role Response 200
404 Not found. Response 404

Response 200

Name Schema
role
optional		 string

Response 404

Name Schema
message
optional		 string

The DELETE method for a single role.

DELETE /cuwbnets/{cuwb_name}/devices/{device_key}/interfaces/{interface_identifier}/roles/{role_id}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_key
required		 Either a Ciholas serial number or an integer ID. string
Path interface_identifier
required		 An identifier for interfaces. integer
Path role_id
required		 An id for roles. integer

Responses

HTTP Code Description Schema
204 Item deleted. Response 204

Response 204

Name Schema
message
optional		 string

Interfaces

The GET method for a single interface.

GET /cuwbnets/{cuwb_name}/devices/{device_key}-{interface_identifier}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_key
required		 Either a Ciholas serial number or an integer ID. string
Path interface_identifier
required		 An identifier for interfaces. integer

Responses

HTTP Code Description Schema
200 Device Interface Response 200
404 Not found. Response 404

Response 200

Name Schema
interface
optional		 string

Response 404

Name Schema
message
optional		 string

The DELETE method for a single interface.

DELETE /cuwbnets/{cuwb_name}/devices/{device_key}-{interface_identifier}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_key
required		 Either a Ciholas serial number or an integer ID. string
Path interface_identifier
required		 An identifier for interfaces. integer

Responses

HTTP Code Description Schema
204 Item deleted. Response 204

Response 204

Name Schema
message
optional		 string

The GET method for a list of all interfaces.

GET /cuwbnets/{cuwb_name}/devices/{device_key}/interfaces

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_key
required		 Either a Ciholas serial number or an integer ID. string

Responses

HTTP Code Description Schema
200 Device Interface Response 200
404 Not found. Response 404

Response 200

Name Schema
interfaces
optional		 string

Response 404

Name Schema
message
optional		 string

The GET method for a single interface.

GET /cuwbnets/{cuwb_name}/devices/{device_key}/interfaces/{interface_identifier}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_key
required		 Either a Ciholas serial number or an integer ID. string
Path interface_identifier
required		 An identifier for interfaces. integer

Responses

HTTP Code Description Schema
200 Device Interface Response 200
404 Not found. Response 404

Response 200

Name Schema
interface
optional		 string

Response 404

Name Schema
message
optional		 string

The DELETE method for a single interface.

DELETE /cuwbnets/{cuwb_name}/devices/{device_key}/interfaces/{interface_identifier}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_key
required		 Either a Ciholas serial number or an integer ID. string
Path interface_identifier
required		 An identifier for interfaces. integer

Responses

HTTP Code Description Schema
204 Item deleted. Response 204

Response 204

Name Schema
message
optional		 string

Log Messages

The GET method for a list of all log messages.

GET /cuwbnets/{cuwb_name}/log_messages

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string

Responses

HTTP Code Description Schema
200 Log Message List Response 200

Response 200

Name Schema
log_messages
optional		 < string > array

Magnetometer Calibration

Create a new mangetometer calibration.

POST /cuwbnets/{cuwb_name}/devices/{device_key}/set_magnetometer_calibration

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path device_key
required		 Either a Ciholas serial number or an integer ID. string
Body mangetometer_calibration_body
required		 The request body mangetometer_calibration_body

mangetometer_calibration_body

Name Schema
x_offset
optional		 integer
y_offset
optional		 integer
z_offset
optional		 integer

Responses

HTTP Code Description Schema
201 Magnetometer Calibration Response 201
400 Invalid request. Response 400
404 Not found. Response 404
409 Conflict. Response 409
500 Internal error. Response 500

Response 201

Name Schema
magnetometer_calibration
optional		 string

Response 400

Name Schema
message
optional		 string

Response 404

Name Schema
message
optional		 string

Response 409

Name Schema
message
optional		 string

Response 500

Name Schema
message
optional		 string

Packages

The GET method for PPA packages.

GET /packages

Responses

HTTP Code Description Schema
200 Packages Response 200
404 Not found. Response 404

Response 200

Name Schema
ppa_status
optional		 string

Response 404

Name Schema
ppa_status
optional		 string

Paired Interfaces

The PUT method for adding a new paired interface

PUT /cuwbnets/{cuwb_name}/devices/{device_key}/{interface_identifier}/{_type}_interfaces

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the cuwbnet to use. string
Path device_key
required		 A Ciholas serial number. string
Path interface_identifier
required		 An identifier for interfaces. string
Path _type
required		 A type of paired interfaces. string

Responses

HTTP Code Description Schema
201 Paired Interface Response 201
400 Invalid Request. Response 400
409 Conflict. Response 409
500 Internal error. Response 500

Response 201

Name Schema
paired_interface
optional		 string

Response 400

Name Schema
message
optional		 string

Response 409

Name Schema
message
optional		 string

Response 500

Name Schema
message
optional		 string

The DELETE method for a single paired_interface.

DELETE /cuwbnets/{cuwb_name}/devices/{device_key}/{interface_identifier}/{_type}_interfaces/{interface}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the cuwbnet to use. string
Path device_key
required		 A Ciholas serial number. string
Path interface_identifier
required		 An identifier for interfaces. string
Path _type
required		 A type of paired interfaces. string
Path interface
required		 The paired interface to interact with. string

Responses

HTTP Code Description Schema
204 Item deleted. Response 204
409 Conflict. Response 409

Response 204

Name Schema
message
optional		 string

Response 409

Name Schema
message
optional		 string

Position Limits

Create a new Position Limit object.

POST /cuwbnets/{cuwb_name}/position_limits

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Body position_limits_post_body
required		 The POST body - must include all fields. position_limits_post_body

position_limits_post_body

Name Schema
max_x
optional		 integer
max_y
optional		 integer
max_z
optional		 integer
min_x
optional		 integer
min_y
optional		 integer
min_z
optional		 integer
name
optional		 string

Responses

HTTP Code Description Schema
200 Position Limit Response 200
400 Invalid request. Response 400
409 Conflict. Response 409

Response 200

Name Schema
position_limits
optional		 string

Response 400

Name Schema
message
optional		 string

Response 409

Name Schema
message
optional		 string

The GET method for a list of all position limits.

GET /cuwbnets/{cuwb_name}/position_limits

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string

Responses

HTTP Code Description Schema
200 Position Limits List Response 200

Response 200

Name Schema
position_limits
optional		 string

The GET method for a single position limit.

GET /cuwbnets/{cuwb_name}/position_limits/{name}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path name
required		 The name of the position limit to use. string

Responses

HTTP Code Description Schema
200 Position Limits Response 200
404 Not found. Response 404

Response 200

Name Schema
position_limits
optional		 string

Response 404

Name Schema
message
optional		 string

The DELETE method for a single position limit.

DELETE /cuwbnets/{cuwb_name}/position_limits/{name}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path name
required		 The name of the position limit to use. string

Responses

HTTP Code Description Schema
204 Item deleted. Response 204

Response 204

Name Schema
message
optional		 string

The PATCH method for a single position limit.

PATCH /cuwbnets/{cuwb_name}/position_limits/{name}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path name
required		 The name of the position limit to use. string
Body position_limits_patch_body
required		 The PATCH body - must include at least one field. position_limits_patch_body

position_limits_patch_body

Name Schema
max_x
optional		 integer
max_y
optional		 integer
max_z
optional		 integer
min_x
optional		 integer
min_y
optional		 integer
min_z
optional		 integer

Responses

HTTP Code Description Schema
200 Position Limits Response 200
404 Not found. Response 404
500 Internal error. Response 500

Response 200

Name Schema
position_limits
optional		 string

Response 404

Name Schema
message
optional		 string

Response 500

Name Schema
message
optional		 string

RF Settings

Create a new RF Settings object.

POST /cuwbnets/{cuwb_name}/rf_settings

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Body rf_settings_post_body
required		 The POST body - must include all fields. rf_settings_post_body

rf_settings_post_body

Name Schema
bit_rate
optional		 integer
channel
optional		 integer
name
optional		 string
preamble_code
optional		 integer
preamble_length
optional		 integer
prf
optional		 integer

Responses

HTTP Code Description Schema
200 RF Setting Response 200
400 Invalid request. Response 400
409 Conflict. Response 409

Response 200

Name Schema
rf_settings
optional		 string

Response 400

Name Schema
message
optional		 string

Response 409

Name Schema
message
optional		 string

The GET method for a list of all RF Settings.

GET /cuwbnets/{cuwb_name}/rf_settings

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string

Responses

HTTP Code Description Schema
200 RF Settings List Response 200

Response 200

Name Schema
rf_settings
optional		 string

The GET method for a single RF Settings.

GET /cuwbnets/{cuwb_name}/rf_settings/{name}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path name
required		 The name of the RF Settings to use. string

Responses

HTTP Code Description Schema
200 RF Setting Response 200
404 Not found. Response 404

Response 200

Name Schema
rf_settings
optional		 string

Response 404

Name Schema
message
optional		 string

The DELETE method for a single RF Settings.

DELETE /cuwbnets/{cuwb_name}/rf_settings/{name}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path name
required		 The name of the RF Settings to use. string

Responses

HTTP Code Description Schema
204 Item deleted. Response 204

Response 204

Name Schema
message
optional		 string

The PATCH method for a single RF Settings.

PATCH /cuwbnets/{cuwb_name}/rf_settings/{name}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path name
required		 The name of the RF Settings to use. string
Body rf_settings_patch_body
required		 The PATCH body - must include at least one field. rf_settings_patch_body

rf_settings_patch_body

Name Schema
bit_rate
optional		 integer
channel
optional		 integer
preamble_code
optional		 integer
preamble_length
optional		 integer
prf
optional		 integer

Responses

HTTP Code Description Schema
200 RF Setting Response 200
404 Not found. Response 404
500 Internal error. Response 500

Response 200

Name Schema
rf_settings
optional		 string

Response 404

Name Schema
message
optional		 string

Response 500

Name Schema
message
optional		 string

Roles

The POST method for adding a new role.

POST /cuwbnets/{cuwb_name}/roles

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Body role_body
required		 The request body role_body

role_body

Name Schema
name
optional		 string
network_period
optional		 integer
window_duration
optional		 integer

Responses

HTTP Code Description Schema
201 Device Role Response 201
400 Invalid request. Response 400
409 Conflict. Response 409
500 Internal errror. Response 500

Response 201

Name Schema
role
optional		 string

Response 400

Name Schema
message
optional		 string

Response 409

Name Schema
message
optional		 string

Response 500

Name Schema
message
optional		 string

The GET method for a list of all roles.

GET /cuwbnets/{cuwb_name}/roles

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string

Responses

HTTP Code Description Schema
200 Device Roles Response 200
404 Not found. Response 404

Response 200

Name Schema
roles
optional		 string

Response 404

Name Schema
message
optional		 string

The GET method for a single role.

GET /cuwbnets/{cuwb_name}/roles/{role_id}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path role_id
required		 An id for roles. integer

Responses

HTTP Code Description Schema
200 Device Role Response 200
404 Not found. Response 404

Response 200

Name Schema
role
optional		 string

Response 404

Name Schema
message
optional		 string

The DELETE method for a single role.

DELETE /cuwbnets/{cuwb_name}/roles/{role_id}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path role_id
required		 An id for roles. integer

Responses

HTTP Code Description Schema
204 Item deleted. Response 204

Response 204

Name Schema
message
optional		 string

The PATCH method for a single role.

PATCH /cuwbnets/{cuwb_name}/roles/{role_id}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path role_id
required		 An id for roles. integer
Body role_body
required		 The request body role_body

role_body

Name Schema
name
optional		 string
network_period
optional		 integer
window_duration
optional		 integer

Responses

HTTP Code Description Schema
200 Role Response 200
400 Invalid request. Response 400
404 Not found. Response 404
500 Internal error. Response 500

Response 200

Name Schema
role
optional		 string

Response 400

Name Schema
message
optional		 string

Response 404

Name Schema
message
optional		 string

Response 500

Name Schema
message
optional		 string

Settings

The POST method to create a new setting.

POST /cuwbnets/{cuwb_name}/settings

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Body settings_body
required		 The request body object

Responses

HTTP Code Description Schema
200 Setting Response 200
409 Conflict. Response 409
500 Internal error. Response 500

Response 200

Name Schema
setting
optional		 string

Response 409

Name Schema
message
optional		 string

Response 500

Name Schema
message
optional		 string

The GET method for a list of all settings.

GET /cuwbnets/{cuwb_name}/settings

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string

Responses

HTTP Code Description Schema
200 Setting List Response 200

Response 200

Name Schema
settings_list
optional		 string

The PUT method for a single setting.

PUT /cuwbnets/{cuwb_name}/settings

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Body settings_body
required		 The request body object

Responses

HTTP Code Description Schema
200 Setting Response 200
500 Internal erorr. Response 500

Response 200

Name Schema
setting
optional		 string

Response 500

Name Schema
message
optional		 string

The PATCH method for a single setting.

PATCH /cuwbnets/{cuwb_name}/settings

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Body settings_body
required		 The request body object

Responses

HTTP Code Description Schema
200 Setting Response 200
404 Not found. Response 404
500 Internal error. Response 500

Response 200

Name Schema
setting
optional		 string

Response 404

Name Schema
message
optional		 string

Response 500

Name Schema
message
optional		 string

The GET method for a single setting.

GET /cuwbnets/{cuwb_name}/settings/{key}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path key
required		 The key of the setting to use. string

Responses

HTTP Code Description Schema
200 Setting Response 200
404 Not found. Response 404

Response 200

Name Schema
setting
optional		 string

Response 404

Name Schema
message
optional		 string

The DELETE method for a single setting.

DELETE /cuwbnets/{cuwb_name}/settings/{key}

Parameters

Type Name Description Schema
Path cuwb_name
required		 The name of the database to use. string
Path key
required		 The key of the setting to use. string

Responses

HTTP Code Description Schema
204 Item deleted. Response 204

Response 204

Name Schema
message
optional		 string