softvisor/Holzleitner-Lieferservice-App
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Final commit.

Browse Source
This commit is contained in:
Dennis Nemec
2026-06-01 17:12:28 +02:00
parent 3ecbc82885
commit a9bf8ecdd1
385 changed files with 29081 additions and 12089 deletions
Download Patch File Download Diff File Expand all files Collapse all files

182
packages/holzleitner_api/doc/ServicesApi.md Normal file
View File

@ -0,0 +1,182 @@
# holzleitner_api.api.ServicesApi
## Load the API package
```dart
import 'package:holzleitner_api/api.dart';
```
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**createService**](ServicesApi.md#createservice) | **POST** /services | Legt einen neuen Service an.
[**deleteService**](ServicesApi.md#deleteservice) | **DELETE** /services/{id} | Hartes Löschen. `409 Conflict`, wenn der Service noch von einer Lieferung referenziert wird — dann stattdessen deaktivieren.
[**listServices**](ServicesApi.md#listservices) | **GET** /services | Listet die Services (sortiert nach `sortOrder`).
[**updateService**](ServicesApi.md#updateservice) | **PATCH** /services/{id} | Patcht Name/Grenzen/Aktiv-Flag/Sortierung. `kind` ist nicht änderbar.
# **createService**
> ServiceResponse createService(createServiceRequest)
Legt einen neuen Service an.
### Example
```dart
import 'package:holzleitner_api/api.dart';
final api = HolzleitnerApi().getServicesApi();
final CreateServiceRequest createServiceRequest = ; // CreateServiceRequest |
try {
final response = api.createService(createServiceRequest);
print(response);
} catch on DioException (e) {
print('Exception when calling ServicesApi->createService: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**createServiceRequest** | [**CreateServiceRequest**](CreateServiceRequest.md)| |
### Return type
[**ServiceResponse**](ServiceResponse.md)
### Authorization
[bearer_auth](../README.md#bearer_auth)
### 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)
# **deleteService**
> deleteService(id)
Hartes Löschen. `409 Conflict`, wenn der Service noch von einer Lieferung referenziert wird — dann stattdessen deaktivieren.
### Example
```dart
import 'package:holzleitner_api/api.dart';
final api = HolzleitnerApi().getServicesApi();
final String id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Service-Id
try {
api.deleteService(id);
} catch on DioException (e) {
print('Exception when calling ServicesApi->deleteService: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| Service-Id |
### Return type
void (empty response body)
### Authorization
[bearer_auth](../README.md#bearer_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[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)
# **listServices**
> ServicesList listServices(includeInactive)
Listet die Services (sortiert nach `sortOrder`).
### Example
```dart
import 'package:holzleitner_api/api.dart';
final api = HolzleitnerApi().getServicesApi();
final bool includeInactive = true; // bool | Wenn true, werden inaktive Services mitgeliefert (default: false)
try {
final response = api.listServices(includeInactive);
print(response);
} catch on DioException (e) {
print('Exception when calling ServicesApi->listServices: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**includeInactive** | **bool**| Wenn true, werden inaktive Services mitgeliefert (default: false) | [optional]
### Return type
[**ServicesList**](ServicesList.md)
### Authorization
[bearer_auth](../README.md#bearer_auth)
### 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)
# **updateService**
> ServiceResponse updateService(id, updateServiceRequest)
Patcht Name/Grenzen/Aktiv-Flag/Sortierung. `kind` ist nicht änderbar.
### Example
```dart
import 'package:holzleitner_api/api.dart';
final api = HolzleitnerApi().getServicesApi();
final String id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Service-Id
final UpdateServiceRequest updateServiceRequest = ; // UpdateServiceRequest |
try {
final response = api.updateService(id, updateServiceRequest);
print(response);
} catch on DioException (e) {
print('Exception when calling ServicesApi->updateService: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| Service-Id |
**updateServiceRequest** | [**UpdateServiceRequest**](UpdateServiceRequest.md)| |
### Return type
[**ServiceResponse**](ServiceResponse.md)
### Authorization
[bearer_auth](../README.md#bearer_auth)
### 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)