RufBusle/Entwickler
Dokumentation
GET/api/v1/vehicles

Fahrzeuge

Fahrzeug-Stammdaten inklusive Kennzeichen und externalId — der Schlüssel für den Abgleich mit einem Fuhrparksystem.

Wofür

Für den Abgleich mit einem führenden Fuhrpark- oder Dispositionssystem: Kapazitäten, Kennzeichen und die eigene Fremd-ID.

Anfrage

Erfordert das Recht read:vehicles.
AnfrageShell
curl -sS \
  -H "Authorization: Bearer rb_live_…" \
  "https://rufbusle.de/api/v1/vehicles"

Query-Parameter

limit
Seitengröße, 1–200. Ohne Angabe 50.
cursor
Wert aus nextCursor der vorigen Seite.

Antwort

Seitenweise: data mit den Einträgen, nextCursor für die Folgeseite.
BeispielantwortJSON
{
  "data": [
    {
      "id": "bus_2Hd6rT",
      "label": "Rufbus 1",
      "licensePlate": "ES-RB 123",
      "vehicleType": "Kleinbus",
      "externalId": "FZG-00417",
      "seatCapacity": 8,
      "wheelchairCapacity": 1,
      "isActive": true
    }
  ],
  "nextCursor": "bkg_5Rt8wY"
}

Beispielwerte, keine echten Daten. Unbekannte Felder bitte ignorieren — es können jederzeit welche hinzukommen.

Felder je Eintrag (Vehicle)

Die Hülle mit data und nextCursor ist bei allen Listen gleich; hier stehen die Felder eines einzelnen Eintrags.
FeldTypBeschreibung
idstringInterne ID des Fahrzeugs.
labelstringBezeichnung in RufBusle.
licensePlatestring | nullAmtliches Kennzeichen, falls gepflegt.
vehicleTypestring | nullFahrzeugart, frei gepflegt.
externalIdstring | nullID im führenden Fremdsystem.
seatCapacityinteger | nullSitzplätze; steuert in RufBusle die Buchbarkeit.
wheelchairCapacityinteger | nullRollstuhlplätze, getrennt von den Sitzplätzen gezählt.
isActivebooleanIm Betrieb; stillgelegte bleiben erhalten.

Worauf zu achten ist

Die Punkte, an denen Integrationen erfahrungsgemäß hängen bleiben.
  • externalId ist ein freies Feld, das die Stadt pflegt. Tragen Sie dort die ID aus Ihrem System ein, dann können Sie ohne Namensvergleich zuordnen.
  • Positionen oder Echtzeit-Zustände gibt es hier nicht — es sind reine Stammdaten.