fasvadms-client 1.1.0

FASva Data Management System Client API

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 Open API Generator 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_by_name	DELETE /drive/{name}/	Remove a entity by its name
DriveApi	get_by_id	GET /drive/{iddrive}	Get a entity by its id
DriveApi	get_by_name	GET /drive/{name}/	Get a entity by its name
DriveApi	get_drive_list	GET /drive/	Get all 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_list	GET /scene/	Get all scenes
SceneApi	get_scene_signal_by_id	GET /scene/{idscene}/signal/{idsignal}	Get the signal information (identified by `name`) of the scene with the `idscene`
SceneApi	get_scene_signal_by_name	GET /scene/{idscene}/signal/{name}	Get the signal information (identified by `idsignal`) of 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
SignalApi	get_signal_by_name	GET /signal/{name}/	Get a signal by its name
SignalApi	get_signal_list	GET /signal/	Get all 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
ThumbnailApi	get_by_time_and_vehicle	GET /thumbnail/time/{time}/serialnumber/{serialnumber}	Get a thumbnail of `timestamp` of the vehicle with the `serialnumber`
ThumbnailApi	get_interval	GET /thumbnail/start/{start}/end/{end}/serialnumber/{serialnumber}	Get thumbnail of the interval defined by `start` and `end` of the vehicle with the `serialnumber`
UnitApi	get_by_id	GET /unit/{idunit}	Get a entity by its id
UnitApi	get_by_name	GET /unit/{name}/	Get a entity by its name
UnitApi	get_list	GET /unit/	Get all entities
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

Documentation For Models

• Drive
• Scene
• Sensor
• Signal
• SignalType
• Unit
• Vehicle

Documentation For Authorization

All endpoints do (currently) not require authorization.

Author

Lars Klitzke