Skip to main content

List-Endpunkte – Auflistungen von Stammdaten & Ressourcen

List-Endpunkte dienen dazu, bestehende Daten aus DeDeFleet auszulesen, um sie:

  • im eigenen System zu spiegeln,

  • als Referenzen für weitere API-Aufrufe zu verwenden,

  • oder Planungsentscheidungen darauf aufzubauen.

Alle List-Endpunkte folgen einem ähnlichen Muster:

  • HTTP GET

  • keine Parameter

  • Rückgabe eines Objekttyps als Liste

  • zusätzlich ein Status-Objekt zur Auswertung des Ergebnisses

Customer/List – Kunden auflisten

API-Referenz (Swagger)

https://ortung.dedefleet.de/swagger/?url=https://ortung.dedefleet.de/swagger/data/api/2#/Customer/Customer_List

Zweck

Liefert alle im System vorhandenen Kunden inkl. Stammdaten und Standortinformationen.

Typische Verwendung:

  • Synchronisation von Kundenstammdaten

  • Referenz für Aufträge mit location.type = 1

  • Prüfung archivierter Kunden


Endpoint

GET /customer/list

GET /customer/list

Beispielantwort

{
  "customers": [
    {
      "customerNumber": "CUST-1001",
      "name": "Musterkunde GmbH",
      "location": {
        "type": 2,
        "name": "Musterkunde GmbH",
        "street": "Hauptstraße 12",
        "postal": "37154",
        "city": "Northeim",
        "country": "DE",
        "latitude": 51.7065,
        "longitude": 10.0034
      },
      "radius": 50,
      "salesVolume": 120000,
      "contact": "Max Müller",
      "phoneNumber": "+49 5551 12345",
      "email": "kontakt@musterkunde.de",
      "customerClass": "A",
      "notes": "Bevorzugter Anlieferkunde",
      "shipmentTracking": true,
      "archived": false
    }
  ],
  "status": {
    "code": 100,
    "description": "OK"
  }
}

Employee/List – Mitarbeiter (Fahrer) abrufen

API-Referenz (Swagger)

https://ortung.dedefleet.de/swagger/?url=https://ortung.dedefleet.de/swagger/data/api/2#/Employee/Employee_List

Zweck

Liefert alle Mitarbeiter inkl. Arbeitszeiten, Standort und Lizenzinformationen.

Typische Verwendung:

  • Fahrerzuweisung bei der Tourenplanung

  • Abgleich von Arbeitszeiten und Arbeitstagen

  • Prüfung der Tourenplanungsfähigkeit

Endpoint

GET /employee/list

Beispielantwort

{
  "employees": [
    {
      "employeeNumber": "DRV-1001",
      "firstName": "Max",
      "lastName": "Mustermann",
      "email": "max.mustermann@unternehmen.de",
      "phoneNumber": "+49 170 1234567",
      "workTimeStart": "07:00",
      "workTimeEnd": "16:00",
      "workingDays": [1, 2, 3, 4, 5],
      "vehicleApiID": "VEH-42",
      "hasTourPlanningLicense": true,
      "location": {
        "type": 0,
        "id": "DEPOT-1",
        "name": "Zentrallager Northeim"
      }
    }
  ],
  "status": {
    "code": 100,
    "description": "OK"
  }
}

Location/List – Standorte abrufen

API-Referenz (Swagger)

https://ortung.dedefleet.de/swagger/?url=https://ortung.dedefleet.de/swagger/data/api/2#/Location/Location_List

Zweck

Liefert alle definierten Standorte (Locations).

Typische Verwendung:

  • Referenz für Aufträge (location.type = 0)

  • Verwendung als Depot oder Tour-Start-/Endpunkt

  • Zentrale Pflege wiederkehrender Orte

Endpoint

GET /location/list

Beispielantwort

{
  "locations": [
    {
      "locationNumber": "LOC-100",
      "name": "Zentrallager Northeim",
      "location": {
        "type": 2,
        "street": "Industriestraße 1",
        "postal": "37154",
        "city": "Northeim",
        "country": "DE",
        "latitude": 51.7072,
        "longitude": 10.0041
      },
      "radius": 100
    }
  ],
  "status": {
    "code": 100,
    "description": "OK"
  }
}

TrackingObject/List

API-Referenz (Swagger)

https://ortung.dedefleet.de/swagger/?url=https://ortung.dedefleet.de/swagger/data/api/2#/TrackingObject/TrackingObject_List

Zweck

Liefert alle Trackingobjekte im System.
Dieser Endpoint wird häufig genutzt, um Fahrzeuge für die Tourenplanung zu identifizieren.

Typische Verwendung:

  • Fahrzeugübersicht

  • Referenz für Touren (vehicleApiID)

  • Prüfung von Planungs- und Optimierungslizenzen

Endpoint

GET /trackingobject/list

Beispielantwort

{
  "trackingObjects": [
    {
      "trackingObjectId": "TO-4711",
      "vehicleApiID": "VEH-42",
      "licenseNumber": "NOM-DE-123",
      "manufacturer": "Mercedes-Benz",
      "name": "Sprinter 42",
      "vin": "WDB9066551S123456",
      "loadingVolume": 12.5,
      "numberSeats": 3,
      "hasTourPlanningLicense": true,
      "hasOptimizationLicense": true,
      "hasTrailer": false,
      "archived": false
    }
  ],
  "status": {
    "code": 100,
    "description": "OK"
  }
}

VehicleProfile/List – Fahrzeugprofile abrufen

API-Referenz (Swagger)

https://ortung.dedefleet.de/swagger/?url=https://ortung.dedefleet.de/swagger/data/api/2#/VehicleProfile/VehicleProfile_List

Zweck

Liefert alle Fahrzeugprofile, die für Routen- und Tourenoptimierung verwendet werden.

Fahrzeugprofile definieren u. a.:

  • Abmessungen und Gewicht

  • Skills und Kapazitäten

  • Kostenparameter für die Optimierung

Endpoint

GET /vehicleprofile/list

Beispielantwort

{
  "vehicleProfiles": [
    {
      "guid": "f1c0b6d2-8a3f-4b0e-9f21-7a2c3d9e1111",
      "name": "Standard Transporter",
      "height": 2.6,
      "width": 2.1,
      "length": 6.0,
      "payload": 1200,
      "totalWeight": 3500,
      "maxSpeed": 130,
      "skills": ["Kühlfahrzeug"],
      "capacities": [
        {
          "capacity": "EURO_PALLET",
          "value": 8
        }
      ],
      "optCostsPerKM": 0.45,
      "optCostsPerMin": 0.3
    }
  ],
  "status": {
    "code": 100,
    "description": "OK"
  }
}