mirror of
https://bitbucket.org/FransoletThomas/tablet-app.git
synced 2025-12-06 16:41:19 +00:00
274 lines
6.9 KiB
Markdown
274 lines
6.9 KiB
Markdown
# manager_api.api.InstanceApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:manager_api/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *http://localhost:5000*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**instanceCreateInstance**](InstanceApi.md#instancecreateinstance) | **POST** /api/Instance |
|
|
[**instanceDeleteInstance**](InstanceApi.md#instancedeleteinstance) | **DELETE** /api/Instance/{id} |
|
|
[**instanceGet**](InstanceApi.md#instanceget) | **GET** /api/Instance |
|
|
[**instanceGetDetail**](InstanceApi.md#instancegetdetail) | **GET** /api/Instance/{id} |
|
|
[**instanceGetInstanceByPinCode**](InstanceApi.md#instancegetinstancebypincode) | **GET** /api/Instance/byPin |
|
|
[**instanceUpdateinstance**](InstanceApi.md#instanceupdateinstance) | **PUT** /api/Instance |
|
|
|
|
|
|
# **instanceCreateInstance**
|
|
> InstanceDTO instanceCreateInstance(instance)
|
|
|
|
|
|
|
|
### 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 = InstanceApi();
|
|
final instance = Instance(); // Instance |
|
|
|
|
try {
|
|
final result = api_instance.instanceCreateInstance(instance);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling InstanceApi->instanceCreateInstance: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**instance** | [**Instance**](Instance.md)| |
|
|
|
|
### Return type
|
|
|
|
[**InstanceDTO**](InstanceDTO.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)
|
|
|
|
# **instanceDeleteInstance**
|
|
> String instanceDeleteInstance(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 = InstanceApi();
|
|
final id = id_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.instanceDeleteInstance(id);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling InstanceApi->instanceDeleteInstance: $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)
|
|
|
|
# **instanceGet**
|
|
> List<Instance> instanceGet()
|
|
|
|
|
|
|
|
### 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 = InstanceApi();
|
|
|
|
try {
|
|
final result = api_instance.instanceGet();
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling InstanceApi->instanceGet: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**List<Instance>**](Instance.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)
|
|
|
|
# **instanceGetDetail**
|
|
> InstanceDTO instanceGetDetail(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 = InstanceApi();
|
|
final id = id_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.instanceGetDetail(id);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling InstanceApi->instanceGetDetail: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **String**| |
|
|
|
|
### Return type
|
|
|
|
[**InstanceDTO**](InstanceDTO.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)
|
|
|
|
# **instanceGetInstanceByPinCode**
|
|
> InstanceDTO instanceGetInstanceByPinCode(pinCode)
|
|
|
|
|
|
|
|
### 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 = InstanceApi();
|
|
final pinCode = 56; // int |
|
|
|
|
try {
|
|
final result = api_instance.instanceGetInstanceByPinCode(pinCode);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling InstanceApi->instanceGetInstanceByPinCode: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**pinCode** | **int**| | [optional]
|
|
|
|
### Return type
|
|
|
|
[**InstanceDTO**](InstanceDTO.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)
|
|
|
|
# **instanceUpdateinstance**
|
|
> InstanceDTO instanceUpdateinstance(instance)
|
|
|
|
|
|
|
|
### 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 = InstanceApi();
|
|
final instance = Instance(); // Instance |
|
|
|
|
try {
|
|
final result = api_instance.instanceUpdateinstance(instance);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling InstanceApi->instanceUpdateinstance: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**instance** | [**Instance**](Instance.md)| |
|
|
|
|
### Return type
|
|
|
|
[**InstanceDTO**](InstanceDTO.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)
|
|
|