fasvadms-client 1.1.0
FASva Data Management System Client API
Keywords: OpenAPI,FASva Data Management System 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](https://github.com/OpenAPITools/openapi-generator) project:

## Requirements.

Python 2.7 and 3.4+

## Installation & Usage

### pip install

You can find the latest release version on [PyPi](https://pypi.org/project/fasvadms-client/). 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:
```python
import fasvadms_client 
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import fasvadms_client
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python
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**](docs/DriveApi.md#delete_by_name) | **DELETE** /drive/{name}/ | Remove a entity by its name
*DriveApi* | [**get_by_id**](docs/DriveApi.md#get_by_id) | **GET** /drive/{iddrive} | Get a entity by its id
*DriveApi* | [**get_by_name**](docs/DriveApi.md#get_by_name) | **GET** /drive/{name}/ | Get a entity by its name
*DriveApi* | [**get_drive_list**](docs/DriveApi.md#get_drive_list) | **GET** /drive/ | Get all drives
*SceneApi* | [**get_scene_by_id**](docs/SceneApi.md#get_scene_by_id) | **GET** /scene/{idscene}/ | Get a scene by its id
*SceneApi* | [**get_scene_by_time_and_drive**](docs/SceneApi.md#get_scene_by_time_and_drive) | **GET** /scene/time/{timestamp}/drive/{iddrive} | Get a scene by its id
*SceneApi* | [**get_scene_by_time_interval**](docs/SceneApi.md#get_scene_by_time_interval) | **GET** /scene/start/{start_time}/end/{end_time} | Get all scenes of the drive with the &#x60;iddrive&#x60; within the interval defined by &#x60;start_time&#x60; and &#x60;end_time&#x60;
*SceneApi* | [**get_scene_by_time_interval_and_drive**](docs/SceneApi.md#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 &#x60;start_time&#x60; and &#x60;end_time&#x60;
*SceneApi* | [**get_scene_list**](docs/SceneApi.md#get_scene_list) | **GET** /scene/ | Get all scenes
*SceneApi* | [**get_scene_signal_by_id**](docs/SceneApi.md#get_scene_signal_by_id) | **GET** /scene/{idscene}/signal/{idsignal} | Get the signal information (identified by &#x60;name&#x60;) of the scene with the &#x60;idscene&#x60;
*SceneApi* | [**get_scene_signal_by_name**](docs/SceneApi.md#get_scene_signal_by_name) | **GET** /scene/{idscene}/signal/{name} | Get the signal information (identified by &#x60;idsignal&#x60;) of the scene with the &#x60;idscene&#x60;
*SensorApi* | [**delete_sensor_by_name**](docs/SensorApi.md#delete_sensor_by_name) | **DELETE** /sensor/{name}/ | Remove a sensor by its name
*SensorApi* | [**get_sensor_by_id**](docs/SensorApi.md#get_sensor_by_id) | **GET** /sensor/{idsensor} | Get a sensor by its id
*SensorApi* | [**get_sensor_by_name**](docs/SensorApi.md#get_sensor_by_name) | **GET** /sensor/{name}/ | Get a sensor by its name
*SensorApi* | [**get_sensor_list**](docs/SensorApi.md#get_sensor_list) | **GET** /sensor/ | Get all sensors
*SignalApi* | [**get_signal_by_name**](docs/SignalApi.md#get_signal_by_name) | **GET** /signal/{name}/ | Get a signal by its name
*SignalApi* | [**get_signal_list**](docs/SignalApi.md#get_signal_list) | **GET** /signal/ | Get all signals
*SignalTypeApi* | [**get_valuetype_by_id**](docs/SignalTypeApi.md#get_valuetype_by_id) | **GET** /type/{idvaluetype} | Get a value type by its id
*SignalTypeApi* | [**get_valuetype_by_name**](docs/SignalTypeApi.md#get_valuetype_by_name) | **GET** /type/{name}/ | Get a sensor by its name
*SignalTypeApi* | [**get_valuetype_list**](docs/SignalTypeApi.md#get_valuetype_list) | **GET** /type/ | Get all signal types
*ThumbnailApi* | [**get_by_time_and_vehicle**](docs/ThumbnailApi.md#get_by_time_and_vehicle) | **GET** /thumbnail/time/{time}/serialnumber/{serialnumber} | Get a thumbnail of &#x60;timestamp&#x60; of the vehicle with the &#x60;serialnumber&#x60;
*ThumbnailApi* | [**get_interval**](docs/ThumbnailApi.md#get_interval) | **GET** /thumbnail/start/{start}/end/{end}/serialnumber/{serialnumber} | Get thumbnail of the interval defined by &#x60;start&#x60; and &#x60;end&#x60; of the vehicle with the &#x60;serialnumber&#x60;
*UnitApi* | [**get_by_id**](docs/UnitApi.md#get_by_id) | **GET** /unit/{idunit} | Get a entity by its id
*UnitApi* | [**get_by_name**](docs/UnitApi.md#get_by_name) | **GET** /unit/{name}/ | Get a entity by its name
*UnitApi* | [**get_list**](docs/UnitApi.md#get_list) | **GET** /unit/ | Get all entities
*VehicleApi* | [**get_vehicle_by_id**](docs/VehicleApi.md#get_vehicle_by_id) | **GET** /vehicle/{idvehicle} | Get a vehicle by its id
*VehicleApi* | [**get_vehicle_by_name**](docs/VehicleApi.md#get_vehicle_by_name) | **GET** /vehicle/{name}/ | Get a vehicle by its name
*VehicleApi* | [**get_vehicle_list**](docs/VehicleApi.md#get_vehicle_list) | **GET** /vehicle/ | Get all vehicles


## Documentation For Models

 - [Drive](docs/Drive.md)
 - [Scene](docs/Scene.md)
 - [Sensor](docs/Sensor.md)
 - [Signal](docs/Signal.md)
 - [SignalType](docs/SignalType.md)
 - [Unit](docs/Unit.md)
 - [Vehicle](docs/Vehicle.md)


## Documentation For Authorization

 All endpoints do (**currently**) not require authorization.


## Author

[Lars Klitzke](http://oldweb.hs-emden-leer.de/no_cache/hochschule/beschaeftigte.html?tx_wtdirectory_pi1%5Bshow%5D=861&tx_wtdirectory_pi1%5Bfilter%5D%5Bmiddle_name%5D=k%25&cHash=0493216d4f05c4bad73909bb9dd265fd)