softvisor/Holzleitner-Lieferservice-App
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
Holzleitner-Lieferservice-App/packages/holzleitner_api/doc/DeliveriesApi.md
Dennis Nemec a9bf8ecdd1 Final commit.
2026-06-01 17:12:28 +02:00

19 KiB
Raw Permalink Blame History

holzleitner_api.api.DeliveriesApi

Load the API package

import 'package:holzleitner_api/api.dart';

All URIs are relative to http://localhost

Method HTTP request Description
applyCredit POST /deliveries/{delivery_id}/credit Wendet ein Betrags-Gutschrift-Ereignis an (`set`/`remove`). Append-only, idempotent über `clientEventId`. Nur bei aktiver Lieferung; bei `set` sind Betrag (0 < x ≤ 150 €, 10-€-Schritte) und Grund Pflicht. Antwort: der aktuelle Gutschrift-Stand (`null`, wenn entfernt).
assignCar PUT /deliveries/{delivery_id}/assigned-car Setzt das `assigned_car_id` einer Lieferung. `carId: null` löst die Zuordnung wieder. Der Use Case stellt sicher, dass das Fahrzeug zum angemeldeten Account gehört.
cancel POST /deliveries/{delivery_id}/cancel Setzt die Lieferung auf `canceled` — endgültig. Erlaubt aus `active` und `held`.
complete POST /deliveries/{delivery_id}/complete Schließt die Lieferung ab — `state = completed`. Nur aus `active`.
createNote POST /deliveries/{delivery_id}/notes Legt eine neue Notiz an einer Lieferung an. Mindestens eines von `text` und `imageAttachment` muss inhaltlich gefüllt sein (Leerstrings werden serverseitig getrimmt und als leer behandelt).
deleteNote DELETE /deliveries/{delivery_id}/notes/{note_id} Löscht eine Notiz. Antwortet mit `204 No Content`.
deleteServiceValue DELETE /deliveries/{delivery_id}/services/{service_id} Entfernt den Service-Wert einer Lieferung (Service „nicht gesetzt&quot;). Nur bei aktiver Lieferung. Antwort `204`.
hold POST /deliveries/{delivery_id}/hold Setzt die Lieferung auf `held`. Nur aus `active` zulässig.
resume POST /deliveries/{delivery_id}/resume Setzt die Lieferung zurück auf `active`. Nur aus `held` zulässig.
setService PUT /deliveries/{delivery_id}/services/{service_id} Setzt (Upsert) den Wert eines Service für eine Lieferung. Genau das zum Service-Typ passende Feld (`boolValue`/`numericValue`) muss gesetzt sein; numerische Werte werden gegen min/max geprüft. Nur bei aktiver Lieferung.
updateNote PATCH /deliveries/{delivery_id}/notes/{note_id} Ändert Text/Bild einer Notiz. Innerhalb des (geteilten) Accounts darf jeder Fahrer Notizen pflegen — kein Autor-Check. `delivery_id` ist Teil des Pfads (REST-Konsistenz), die Notiz wird über `note_id` adressiert.
uploadNoteImage POST /deliveries/{delivery_id}/notes/image Lädt ein Bild zu einer Lieferung hoch (multipart/form-data, Feld `file`) und legt dafür eine Bild-Notiz an. Das Bild geht in den DOCUframe-Dokumentenspeicher; gespeichert wird die zurückgelieferte Referenz (`~ObjectID`) als `image_attachment` der Notiz.

applyCredit

DeliveryCreditResponse applyCredit(deliveryId, deliveryCreditEventRequest)

Wendet ein Betrags-Gutschrift-Ereignis an (set/remove). Append-only, idempotent über clientEventId. Nur bei aktiver Lieferung; bei set sind Betrag (0 < x ≤ 150 €, 10-€-Schritte) und Grund Pflicht. Antwort: der aktuelle Gutschrift-Stand (null, wenn entfernt).

Example

import 'package:holzleitner_api/api.dart';

final api = HolzleitnerApi().getDeliveriesApi();
final String deliveryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final DeliveryCreditEventRequest deliveryCreditEventRequest = ; // DeliveryCreditEventRequest | 

try {
    final response = api.applyCredit(deliveryId, deliveryCreditEventRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DeliveriesApi->applyCredit: $e\n');
}

Parameters

Name Type Description Notes
deliveryId String
deliveryCreditEventRequest DeliveryCreditEventRequest

Return type

DeliveryCreditResponse

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]

assignCar

DeliveryResponse assignCar(deliveryId, assignCarRequest)

Setzt das assigned_car_id einer Lieferung. carId: null löst die Zuordnung wieder. Der Use Case stellt sicher, dass das Fahrzeug zum angemeldeten Account gehört.

Example

import 'package:holzleitner_api/api.dart';

final api = HolzleitnerApi().getDeliveriesApi();
final String deliveryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final AssignCarRequest assignCarRequest = ; // AssignCarRequest | 

try {
    final response = api.assignCar(deliveryId, assignCarRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DeliveriesApi->assignCar: $e\n');
}

Parameters

Name Type Description Notes
deliveryId String
assignCarRequest AssignCarRequest

Return type

DeliveryResponse

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]

cancel

DeliveryResponse cancel(deliveryId, cancelDeliveryRequest)

Setzt die Lieferung auf canceled — endgültig. Erlaubt aus active und held.

Example

import 'package:holzleitner_api/api.dart';

final api = HolzleitnerApi().getDeliveriesApi();
final String deliveryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final CancelDeliveryRequest cancelDeliveryRequest = ; // CancelDeliveryRequest | 

try {
    final response = api.cancel(deliveryId, cancelDeliveryRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DeliveriesApi->cancel: $e\n');
}

Parameters

Name Type Description Notes
deliveryId String
cancelDeliveryRequest CancelDeliveryRequest

Return type

DeliveryResponse

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]

complete

DeliveryResponse complete(deliveryId)

Schließt die Lieferung ab — state = completed. Nur aus active.

multipart/form-data mit drei Feldern: * customer_signature — PNG der Kunden-Unterschrift (Pflicht) * driver_signature — PNG der Fahrer-Unterschrift (Pflicht) * acknowledgements — JSON (CompleteDeliveryAcknowledgements): receiptConfirmed (Pflicht true), notesAcknowledged, acknowledgedNoteIds, authorCarId. Atomar: Signaturen werden lokal gespeichert, die Abschluss-Zeile geschrieben und der Status auf completed gesetzt — alles oder nichts. Gates: Lieferung aktiv, alle scanbaren Positionen fertig, Notizen bestätigt (falls vorhanden).

Example

import 'package:holzleitner_api/api.dart';

final api = HolzleitnerApi().getDeliveriesApi();
final String deliveryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 

try {
    final response = api.complete(deliveryId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DeliveriesApi->complete: $e\n');
}

Parameters

Name Type Description Notes
deliveryId String

Return type

DeliveryResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

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

createNote

DeliveryNoteResponse createNote(deliveryId, createDeliveryNoteRequest)

Legt eine neue Notiz an einer Lieferung an. Mindestens eines von text und imageAttachment muss inhaltlich gefüllt sein (Leerstrings werden serverseitig getrimmt und als leer behandelt).

Example

import 'package:holzleitner_api/api.dart';

final api = HolzleitnerApi().getDeliveriesApi();
final String deliveryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final CreateDeliveryNoteRequest createDeliveryNoteRequest = ; // CreateDeliveryNoteRequest | 

try {
    final response = api.createNote(deliveryId, createDeliveryNoteRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DeliveriesApi->createNote: $e\n');
}

Parameters

Name Type Description Notes
deliveryId String
createDeliveryNoteRequest CreateDeliveryNoteRequest

Return type

DeliveryNoteResponse

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]

deleteNote

deleteNote(deliveryId, noteId)

Löscht eine Notiz. Antwortet mit 204 No Content.

Example

import 'package:holzleitner_api/api.dart';

final api = HolzleitnerApi().getDeliveriesApi();
final String deliveryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final String noteId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 

try {
    api.deleteNote(deliveryId, noteId);
} catch on DioException (e) {
    print('Exception when calling DeliveriesApi->deleteNote: $e\n');
}

Parameters

Name Type Description Notes
deliveryId String
noteId String

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]

deleteServiceValue

deleteServiceValue(deliveryId, serviceId)

Entfernt den Service-Wert einer Lieferung (Service „nicht gesetzt"). Nur bei aktiver Lieferung. Antwort 204.

Example

import 'package:holzleitner_api/api.dart';

final api = HolzleitnerApi().getDeliveriesApi();
final String deliveryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final String serviceId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 

try {
    api.deleteServiceValue(deliveryId, serviceId);
} catch on DioException (e) {
    print('Exception when calling DeliveriesApi->deleteServiceValue: $e\n');
}

Parameters

Name Type Description Notes
deliveryId String
serviceId String

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]

hold

DeliveryResponse hold(deliveryId, holdDeliveryRequest)

Setzt die Lieferung auf held. Nur aus active zulässig.

Example

import 'package:holzleitner_api/api.dart';

final api = HolzleitnerApi().getDeliveriesApi();
final String deliveryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final HoldDeliveryRequest holdDeliveryRequest = ; // HoldDeliveryRequest | 

try {
    final response = api.hold(deliveryId, holdDeliveryRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DeliveriesApi->hold: $e\n');
}

Parameters

Name Type Description Notes
deliveryId String
holdDeliveryRequest HoldDeliveryRequest

Return type

DeliveryResponse

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]

resume

DeliveryResponse resume(deliveryId)

Setzt die Lieferung zurück auf active. Nur aus held zulässig.

Example

import 'package:holzleitner_api/api.dart';

final api = HolzleitnerApi().getDeliveriesApi();
final String deliveryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 

try {
    final response = api.resume(deliveryId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DeliveriesApi->resume: $e\n');
}

Parameters

Name Type Description Notes
deliveryId String

Return type

DeliveryResponse

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]

setService

DeliveryServiceResponse setService(deliveryId, serviceId, setDeliveryServiceRequest)

Setzt (Upsert) den Wert eines Service für eine Lieferung. Genau das zum Service-Typ passende Feld (boolValue/numericValue) muss gesetzt sein; numerische Werte werden gegen min/max geprüft. Nur bei aktiver Lieferung.

Example

import 'package:holzleitner_api/api.dart';

final api = HolzleitnerApi().getDeliveriesApi();
final String deliveryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final String serviceId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final SetDeliveryServiceRequest setDeliveryServiceRequest = ; // SetDeliveryServiceRequest | 

try {
    final response = api.setService(deliveryId, serviceId, setDeliveryServiceRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DeliveriesApi->setService: $e\n');
}

Parameters

Name Type Description Notes
deliveryId String
serviceId String
setDeliveryServiceRequest SetDeliveryServiceRequest

Return type

DeliveryServiceResponse

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]

updateNote

DeliveryNoteResponse updateNote(deliveryId, noteId, updateDeliveryNoteRequest)

Ändert Text/Bild einer Notiz. Innerhalb des (geteilten) Accounts darf jeder Fahrer Notizen pflegen — kein Autor-Check. delivery_id ist Teil des Pfads (REST-Konsistenz), die Notiz wird über note_id adressiert.

Example

import 'package:holzleitner_api/api.dart';

final api = HolzleitnerApi().getDeliveriesApi();
final String deliveryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final String noteId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final UpdateDeliveryNoteRequest updateDeliveryNoteRequest = ; // UpdateDeliveryNoteRequest | 

try {
    final response = api.updateNote(deliveryId, noteId, updateDeliveryNoteRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DeliveriesApi->updateNote: $e\n');
}

Parameters

Name Type Description Notes
deliveryId String
noteId String
updateDeliveryNoteRequest UpdateDeliveryNoteRequest

Return type

DeliveryNoteResponse

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]

uploadNoteImage

DeliveryNoteResponse uploadNoteImage(deliveryId)

Lädt ein Bild zu einer Lieferung hoch (multipart/form-data, Feld file) und legt dafür eine Bild-Notiz an. Das Bild geht in den DOCUframe-Dokumentenspeicher; gespeichert wird die zurückgelieferte Referenz (~ObjectID) als image_attachment der Notiz.

Example

import 'package:holzleitner_api/api.dart';

final api = HolzleitnerApi().getDeliveriesApi();
final String deliveryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 

try {
    final response = api.uploadNoteImage(deliveryId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DeliveriesApi->uploadNoteImage: $e\n');
}

Parameters

Name Type Description Notes
deliveryId String

Return type

DeliveryNoteResponse

Authorization

bearer_auth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

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