mirror of
https://bitbucket.org/FransoletThomas/tablet-app.git
synced 2025-12-06 08:31:19 +00:00
278 lines
7.0 KiB
Markdown
278 lines
7.0 KiB
Markdown
# manager_api.api.DeviceApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:manager_api/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *https://api.myinfomate.be*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**deviceCreate**](DeviceApi.md#devicecreate) | **POST** /api/Device |
|
|
[**deviceDelete**](DeviceApi.md#devicedelete) | **DELETE** /api/Device/{id} |
|
|
[**deviceGet**](DeviceApi.md#deviceget) | **GET** /api/Device |
|
|
[**deviceGetDetail**](DeviceApi.md#devicegetdetail) | **GET** /api/Device/{id}/detail |
|
|
[**deviceUpdate**](DeviceApi.md#deviceupdate) | **PUT** /api/Device |
|
|
[**deviceUpdateMainInfos**](DeviceApi.md#deviceupdatemaininfos) | **PUT** /api/Device/mainInfos |
|
|
|
|
|
|
# **deviceCreate**
|
|
> DeviceDetailDTO deviceCreate(deviceDetailDTO)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = DeviceApi();
|
|
final deviceDetailDTO = DeviceDetailDTO(); // DeviceDetailDTO |
|
|
|
|
try {
|
|
final result = api_instance.deviceCreate(deviceDetailDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling DeviceApi->deviceCreate: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**deviceDetailDTO** | [**DeviceDetailDTO**](DeviceDetailDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**DeviceDetailDTO**](DeviceDetailDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **deviceDelete**
|
|
> String deviceDelete(id)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = DeviceApi();
|
|
final id = id_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.deviceDelete(id);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling DeviceApi->deviceDelete: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **String**| |
|
|
|
|
### Return type
|
|
|
|
**String**
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **deviceGet**
|
|
> List<DeviceDTO> deviceGet(instanceId)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = DeviceApi();
|
|
final instanceId = instanceId_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.deviceGet(instanceId);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling DeviceApi->deviceGet: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**instanceId** | **String**| | [optional]
|
|
|
|
### Return type
|
|
|
|
[**List<DeviceDTO>**](DeviceDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **deviceGetDetail**
|
|
> DeviceDetailDTO deviceGetDetail(id)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = DeviceApi();
|
|
final id = id_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.deviceGetDetail(id);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling DeviceApi->deviceGetDetail: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **String**| |
|
|
|
|
### Return type
|
|
|
|
[**DeviceDetailDTO**](DeviceDetailDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **deviceUpdate**
|
|
> DeviceDetailDTO deviceUpdate(deviceDetailDTO)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = DeviceApi();
|
|
final deviceDetailDTO = DeviceDetailDTO(); // DeviceDetailDTO |
|
|
|
|
try {
|
|
final result = api_instance.deviceUpdate(deviceDetailDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling DeviceApi->deviceUpdate: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**deviceDetailDTO** | [**DeviceDetailDTO**](DeviceDetailDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**DeviceDetailDTO**](DeviceDetailDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **deviceUpdateMainInfos**
|
|
> DeviceDTO deviceUpdateMainInfos(deviceDTO)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = DeviceApi();
|
|
final deviceDTO = DeviceDTO(); // DeviceDTO |
|
|
|
|
try {
|
|
final result = api_instance.deviceUpdateMainInfos(deviceDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling DeviceApi->deviceUpdateMainInfos: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**deviceDTO** | [**DeviceDTO**](DeviceDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**DeviceDTO**](DeviceDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|