Die CATAMA API für Bestandsfahrzeuge, gibt Ihnen die Daten als JSON zurück und antwortet mit den Keys „data“ (mit den Fahrzeugdaten), dem Feld „status“ (1 oder 0) für den Erfolg des Abrufs sowie einer Nachricht „message“ die ggf. eine Fehlermeldung enthält. Die Funktion steht für CATAMA Enterprise Unlimited Instanzen zur Verfügung.

GET – Zum Auslesen der Bestandsfahrzeuge

Endpunkt:
https://ihre-catama-url/api/vehicles/list

Pflichtparameter:
token – String = Token für den API-Aufruf

Optionale Parameter:
offset – Integer = Angabe, ab welchem Datensatz die Datenselektion erfolgen soll (nur in Kombi mit take)
take – Integer = Anzahl an Datensätzen, die selektiert werden sollen (nur in Kombi mit offset)
statusid – Integer (1 oder 2) = Filteroption, um ggf. auch deaktivierte Fahrzeuge (Status: inaktiv, ID = 2) zu erhalten  (Default: 1)

Beispiel – Abruf der Daten für sämtliche Bestandsfahrzeuge
https://ihre-catama-url/api/vehicles/list?token=IHRGEHEIMERCATAMATOKEN

Beispiel – Abruf der Daten für Fahrzeuge ab dem 10. Datensatz (offset = 10), mit maximal 10 Datensätzen als Rückgabe-Inhalt (take=10) übergeben
https://ihre-catama-url/api/vehicles/list?token=IHRGEHEIMERCATAMATOKEN&take=10&offset=10

Filter mit Status-ID (am Beispiel von statusid=2 um inaktive Fahrzeuge zu erhalten)
https://ihre-catama-url/api/vehicles/list?token=IHRGEHEIMERCATAMATOKEN&statusid=2

GET – Zum Auslesen eines Bestandfahrzeugs anhand der ID

Endpunkt:
https://ihre-catama-url/api/vehicles/byid

Pflichtparameter:
token – String = Token für den API-Aufruf
id – Integer = ID des Fahrzeugs (Fahrzeug-ID)

Beispiel – Abruf der Daten für Fahrzeug mit ID = 1
https://ihre-catama-url/api/vehicles/byid?id=1&token=IHRGEHEIMERCATAMATOKEN