Skip to main content

FASva Data Management System API

Project description

Python FASva-DMS Client API

This is the client API to access the FASva Data Manage System with integrated and enriched data collected during real world tests drives conducted at the Hochschule Emden/Leer.

This Python package is automatically generated by the Swagger Codegen project:

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

You can find the latest release version on PyPi. So simply use pip with

The python package is hosted on

pip install fasvadms-client

(you may need to run pip with root permission: sudo pip install fasvadms-client)

Then import the package:

import fasvadms_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import fasvadms_client

Getting Started

Please follow the installation procedure and then run the following:

import fasvadms_client
from fasvadms_client.rest import ApiException

# create an instance of the API class
api_instance = fasvadms_client.DriveApi()

try:
    # get all drives
    api_instance.get_drive_list()
except ApiException as e:
    print("Exception when calling DriveApi-get_drive_list: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to the host on which fasvadms is running.

Class Method HTTP request Description
DriveApi delete_drive_by_name DELETE /drive/{name}/ Remove a drive by its name
DriveApi get_drive_by_id GET /drive/{iddrive} Get a drive by its id
DriveApi get_drive_by_name GET /drive/{name}/ Get a drive by its name
DriveApi get_drive_list GET /drive/ Get all drives
DriveApi post_drive_by_name POST /drive/{name}/ Add a new drive with name `name`
DriveApi post_drive_list POST /drive/ Add new drives
SceneApi get_scene_by_id GET /scene/{idscene}/ Get a scene by its id
SceneApi get_scene_by_time_and_drive GET /scene/time/{timestamp}/drive/{iddrive} Get a scene by its id
SceneApi get_scene_by_time_interval GET /scene/start/{start_time}/end/{end_time} Get all scenes of the drive with the `iddrive` within the interval defined by `start_time` and `end_time`
SceneApi get_scene_by_time_interval_and_drive GET /scene/start/{start_time}/end/{end_time}/drive/{iddrive} Get all scenes within the interval defined by `start_time` and `end_time`
SceneApi get_scene_info GET /scene/{idscene}/signal/{idsignal} Get the signal information (identified by `idsignal`) of the scene with the `idscene`
SceneApi get_scene_list GET /scene/ Get all scenes
SceneApi post_scene_info POST /scene/{idscene}/signal/{idsignal} Add new signal values for the scene identified by `idscene` for the signal identified by `idsignal`
SceneApi post_scene_list POST /scene/ Add new scenes to the database
SceneApi put_scene_by_id PUT /scene/{idscene}/ Updates the scene with the `idscene`
SensorApi delete_sensor_by_name DELETE /sensor/{name}/ Remove a sensor by its name
SensorApi get_sensor_by_id GET /sensor/{idsensor} Get a sensor by its id
SensorApi get_sensor_by_name GET /sensor/{name}/ Get a sensor by its name
SensorApi get_sensor_list GET /sensor/ Get all sensors
SensorApi post_sensor_by_name POST /sensor/{name}/ Add a new sensor with name `name`
SensorApi post_sensor_list POST /sensor/ Add new sensors
SignalApi get_signal_by_name GET /signal/{name}/ Get a signal by its name
SignalApi get_signal_list GET /signal/ Get all signals
SignalApi post_signal_by_name POST /signal/{name}/ Insert a signal by its name
SignalApi post_signal_list POST /signal/ Add new signals
SignalTypeApi get_valuetype_by_id GET /type/{idvaluetype} Get a value type by its id
SignalTypeApi get_valuetype_by_name GET /type/{name}/ Get a sensor by its name
SignalTypeApi get_valuetype_list GET /type/ Get all signal types
SignalTypeApi post_valuetype_by_name POST /type/{name}/ Add a new value type with `name`
SignalTypeApi post_valuetype_list POST /type/ Add new value types to the database
VehicleApi delete_vehicle_by_name DELETE /vehicle/{name}/ Remove a vehicle by its name
VehicleApi get_vehicle_by_id GET /vehicle/{idvehicle} Get a vehicle by its id
VehicleApi get_vehicle_by_name GET /vehicle/{name}/ Get a vehicle by its name
VehicleApi get_vehicle_list GET /vehicle/ Get all vehicles
VehicleApi post_vehicle_by_name POST /vehicle/{name}/ Add a new vehicle with name `name`
VehicleApi post_vehicle_list POST /vehicle/ Add new vehicles

Documentation For Models

Documentation For Authorization

All endpoints do (currently) not require authorization.

Author

Lars Klitzke

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
fasvadms_client-1.0.7-py3-none-any.whl (47.3 kB) Copy SHA256 hash SHA256 Wheel py3 Aug 10, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page