Die CATAMA API für Kundenfahrzeuge, gibt Ihnen die Daten als JSON zurück und antwortet mit den Keys “data” (mit den Fahrzeugdaten und optional den dazu gehörenden Kundendaten), 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 Kundenfahrzeuge im Status “aktiv”
Endpunkt:
https://ihre-catama-url/api/customerscars/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)
withcustomerdata – Integer (1 oder 0) = Filteroption, um die Kundendaten im Abruf zu erhalten (Default: 0)
Beispiel – Abruf der Daten für sämtliche Kundenfahrzeuge
https://ihre-catama-url/api/customerscars/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/customerscars/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/customerscars/list?token=IHRGEHEIMERCATAMATOKEN&statusid=2
GET – Zum Auslesen eines Kundenfahrzeugs anhand der ID
Endpunkt:
https://ihre-catama-url/api/customerscars/byid
Pflichtparameter:
token – String = Token für den API-Aufruf
id – Integer = ID des Fahrzeugs (Fahrzeug-ID)
oder
customerid – Integer = ID des Kunden (Kunden-ID)
Optionale Parameter:
statusid – Integer (1 oder 2) = Filteroption, um inaktive Fahrzeuge des Kunden (Status: inaktiv, ID = 2) zu erhalten (Default: 1), wird eine id für ein Fahrzeug übergeben, wird der Parameter ignoriert
withcustomerdata – Integer (1 oder 0) = Filteroption, um die Kundendaten im Abruf zu erhalten (Default: 0)
Beispiel – Abruf der Daten für Fahrzeug mit ID = 1
https://ihre-catama-url/api/customerscars/byid?id=1&token=IHRGEHEIMERCATAMATOKEN
Beispiel – Abruf der Daten für Kunde mit KD1
https://ihre-catama-url/api/customerscars/byid?customerid=1&token=IHRGEHEIMERCATAMATOKEN
Beispiel – Abruf der Daten für Kunde mit KD1, nur inaktive Fahrzeuge
https://ihre-catama-url/api/customerscars/byid?customerid=1&statusid=2&token=IHRGEHEIMERCATAMATOKEN