230 lines
5.6 KiB
Markdown
230 lines
5.6 KiB
Markdown
# managerapi.api.DisplayApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:managerapi/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *https://localhost:44339*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**displayCreate**](DisplayApi.md#displaycreate) | **POST** /api/Display |
|
|
[**displayDelete**](DisplayApi.md#displaydelete) | **DELETE** /api/Display/{id} |
|
|
[**displayGet**](DisplayApi.md#displayget) | **GET** /api/Display |
|
|
[**displayGetDetail**](DisplayApi.md#displaygetdetail) | **GET** /api/Display/{id} |
|
|
[**displayUpdate**](DisplayApi.md#displayupdate) | **PUT** /api/Display |
|
|
|
|
|
|
# **displayCreate**
|
|
> RessourceDetailDTO displayCreate(displayDTO)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:managerapi/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = DisplayApi();
|
|
final displayDTO = DisplayDTO(); // DisplayDTO |
|
|
|
|
try {
|
|
final result = api_instance.displayCreate(displayDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling DisplayApi->displayCreate: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**displayDTO** | [**DisplayDTO**](DisplayDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**RessourceDetailDTO**](RessourceDetailDTO.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)
|
|
|
|
# **displayDelete**
|
|
> String displayDelete(id)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:managerapi/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = DisplayApi();
|
|
final id = id_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.displayDelete(id);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling DisplayApi->displayDelete: $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)
|
|
|
|
# **displayGet**
|
|
> List<DisplayDTO> displayGet()
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:managerapi/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = DisplayApi();
|
|
|
|
try {
|
|
final result = api_instance.displayGet();
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling DisplayApi->displayGet: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**List<DisplayDTO>**](DisplayDTO.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)
|
|
|
|
# **displayGetDetail**
|
|
> DisplayDTO displayGetDetail(id)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:managerapi/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = DisplayApi();
|
|
final id = id_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.displayGetDetail(id);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling DisplayApi->displayGetDetail: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **String**| |
|
|
|
|
### Return type
|
|
|
|
[**DisplayDTO**](DisplayDTO.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)
|
|
|
|
# **displayUpdate**
|
|
> DisplayDTO displayUpdate(displayDTO)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:managerapi/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = DisplayApi();
|
|
final displayDTO = DisplayDTO(); // DisplayDTO |
|
|
|
|
try {
|
|
final result = api_instance.displayUpdate(displayDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling DisplayApi->displayUpdate: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**displayDTO** | [**DisplayDTO**](DisplayDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**DisplayDTO**](DisplayDTO.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)
|
|
|