Skip to main content

Einschub – Arbeiten mit GUIDs (Create → Folgeaktionen)

Grundprinzip

Viele API-Operationen in DeDeFleet folgen einem einheitlichen Muster:

  1. Ein Objekt wird angelegt (z. B. Auftrag oder Tour).

  2. Die API liefert in der Antwort eine GUID zurück.

  3. Diese GUID wird anschließend genutzt, um mit dem Objekt weiter zu arbeiten, z. B.:

    • Auftrag/Tour zuweisen (Assign)

    • Auftrag/Tour ändern

    • Auftrag/Tour löschen

    • Auftrag/Tour abfragen

👉 Die GUID ist damit die technische, eindeutige Referenz des Objekts innerhalb von DeDeFleet.

Verwendung der GUID

Bei allen Folgeaktionen wird die GUID ausschließlich im Request Body übergeben.

  • Die GUID wird nicht als URL-Parameter verwendet

  • Die GUID wird nicht als Pfadparameter (/…/{guid}) verwendet

Die konkrete Verwendung der GUID wird in den jeweiligen API-Endpunkten beschrieben.

Bedeutung für Integrationen

💡 Empfehlung:
Speichern Sie die beim Anlegen zurückgegebene GUID im Quellsystem dauerhaft ab.

Nur so können Objekte:

  • eindeutig identifiziert

  • zuverlässig weiterverarbeitet

  • korrekt aktualisiert oder gelöscht werden

Beispiel: Response beim Anlegen eines Auftrags

{
  "guid": "00000000-0000-0000-0000-000000000000",
  "status": {
    "code": 100,
    "description": "string",
    "invalidItemKeys": [
      "string"
    ]
  }
}

Bedeutung

  • guid = eindeutige ID der erzeugten Tour (für Folgeaktionen)

  • status.code = Ergebnis des Requests (z. B. erfolgreich / Warnung / Fehler)

  • invalidItemKeys = optionale Liste ungültiger Felder/Elemente (falls vorhanden)

Hinweis zum Status-Objekt

Viele Endpoints liefern zusätzlich ein status-Objekt zurück.
Dieses enthält Informationen darüber, ob der Request erfolgreich war und welche Felder ggf. nicht verarbeitet werden konnten.