Holzleitner-Lieferservice-App/packages/holzleitner_api/doc/ServicesApi.md

holzleitner_api.api.ServicesApi

Load the API package

import 'package:holzleitner_api/api.dart';

All URIs are relative to http://localhost

Method	HTTP request	Description
createService	POST /services	Legt einen neuen Service an.
deleteService	DELETE /services/{id}	Hartes Löschen. `409 Conflict`, wenn der Service noch von einer Lieferung referenziert wird — dann stattdessen deaktivieren.
listServices	GET /services	Listet die Services (sortiert nach `sortOrder`).
updateService	PATCH /services/{id}	Patcht Name/Grenzen/Aktiv-Flag/Sortierung. `kind` ist nicht änderbar.

createService

ServiceResponse createService(createServiceRequest)

Legt einen neuen Service an.

Example

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

Return type

ServiceResponse

Authorization

bearer_auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteService

deleteService(id)

Hartes Löschen. 409 Conflict, wenn der Service noch von einer Lieferung referenziert wird — dann stattdessen deaktivieren.

Example

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

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listServices

ServicesList listServices(includeInactive)

Listet die Services (sortiert nach sortOrder).

Example

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

Authorization

bearer_auth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateService

ServiceResponse updateService(id, updateServiceRequest)

Patcht Name/Grenzen/Aktiv-Flag/Sortierung. kind ist nicht änderbar.

Example

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

Return type

ServiceResponse

Authorization

bearer_auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]