Request
<!--HTTP GET-->
https://<url>/callatow/version
CURL Beispiel:
curl "https://<url>/callatow/version"
Response
{"version":"3.10"}
Response Attribute
Parametername | Typ | Beschreibung |
---|---|---|
version | string | Versionsnummer Schnittstelle |
Request
<!--HTTP POST-->
https://<url>/callatow/task
CURL Beispiel:
curl -X "POST" "https://<url>/callatow/task" \
-H 'Content-Type: application/json' \
-d $'{
"api_key": "abZ&rf",
"task_type": "breakdown",
"task_reference": "Testauftrag 1",
"breakdown_type": "no_fuel",
"payment_type": "selfpayer",
"vehicle_type": "car",
"vehicle_model": "VW Amarok",
"vehicle_identification_number": "VF37DZAH632252313",
"vehicle_registration_plate": "SO KO 36",
"location_address": "Luisenpl. 1-3, 64283 Darmstadt,Germany",
"location_lat": 51.567,
"location_lon": 7.345,
"contact_person": "Franz Maier",
"contact_language": "de",
"contact_phone": "01728208010",
"task_description": "Tank leer",
"activation_needed": false,
"preferred_time": "2018-08-19 13:00:00"
"callback_url": "https://<your_url>",
}'
Response
{"task_id":6730}
POST-Parameter
Parametername | Typ | Beschreibung | Pflicht |
---|---|---|---|
api_key | string | Der APIKEY dient zur Identifizierung des Senders benötigt und wird von der HESA Solutions GmbH mitgeteilt. |
X |
task_type | string | Vorgangsart: breakdown = Panne towing = Abschleppen wrong_parker = Falschparker wrong_fuel = Falsch getankt |
X |
task_reference | string | Kann als Referenzinfo mitgegeben werden und wird im CallBack Event mit zurückgegeben. |
|
breakdown_type | string | Pannenart: flat_tire = Reifenpanne key_in_car = Schlüssel im Auto not_starting = Fahrzeug startet nicht no_fuel = kein Kraftstoff other = Sonstige Nur Pflicht, wenn task_type = breakdown |
X * |
payment_type | string | Abrechnungsart: self_payer = Selbstzahler club = Clubmitglied insurance = Versicherung mobility = Mobilitätsgarantie |
X |
vehicle_type | string | Fahrzeugtyp: bike = Zweirad ebike = E-Bike car = PKW bis 2,8 to zGG. van = PKW 2,8 bis 3,5 to zGG. truck = LKW größer 3,5 to zGG. |
X |
vehicle_model | string | Hersteller / Modell: z.B.: VW Passat etc. |
X |
vehicle_identification_number | string | Fahrgestellnummer | |
vehicle_registration_plate | string | Fahrzeugkennzeichen | |
location_address | string | Fahrzeugstandort als Text: z.B.: Luisenplatz 1-3, 64283 Darmstadt,Germany |
X |
location_lat | double | Breitengrad Fahrzeugstandort: z.B.: 51.567 |
|
location_lon | double | Längengrad Fahrzeugstandort: z.B.: 7.345 |
|
destination_name | string | Name der Zieladresse Alle Attribute zur Zieladresse sind Pflicht, wenn zu einem bestimmten Ziel geschleppt werden soll. z.B.: Auto FIT Huber |
|
destination_address | string | Zieladresse als Text: z.B.: Hauptstrasse 1-3, 64283 Darmstadt,Germany |
|
destination_lat | double | Breitengrad Zieladresse: z.B.: 51.123 |
|
destination_lon | double | Längengrad Zieladresse: z.B.: 7.778 |
|
destination_contact | string | Ansprechpartner an Zieladresse: z.B.: Frau Schmitz |
|
destination_phone | string | Telefon Ansprechpartner an Zieladresse: z.B.: 0171 12345678 |
|
contact_person | string | Name des Havaristen z.B.: Armin Becker |
X |
contact_language | string | Sprache des Havaristen z.B.: de |
|
contact_phone | string | Mobilfunknummer des Havaristen z.B.: 0171 12345678 |
X |
task_description | string | Bemerkungen zum Vorgang: z.B. Kein Benzin |
|
activation_needed | boolean | Vorgang muß vom Havaristen durch SMS Verifizierung aktiviert werden, damit der Vorgang in die Vermittlung geht. true = Ja false = nein |
X |
preferred_time | string | Gewünschter Zeitpunkt zur Durchführung des Auftrags. Wenn nicht gesetzt, soll der Auftrag schnellstmöglichst durchgeführt werden. |
|
callback_url | string | URL, an die per HTTP POST Ereignisse des Vermittlungsverfahrens gesendet werden. |
Response Attribute
Parametername | Typ | Beschreibung |
---|---|---|
task_id | int | MySchleppApp Vorgangsnummer |
Request
<!--HTTP GET-->
https://<url>/callatow/task/<task_id>/status?api_key<=<api_key>
CURL Beispiel:
curl "https://<url>/callatow/task/6730/status?api_key<=<api_key>"
Response
Vorgang in der Vermittlung:
{
"task_id":"6730",
"status": "task_pending",
"status_time:": "2018-08-19T13:00:00+0200"
}
Vorgang erfolgreich vermittelt:
{
"task_id":"6730",
"status": "task_placed",
"status_time":"2018-08-19T13:00:00+0200"
"assigned_tow": {
"tow_id": "10202",
"tow_name": "ASD 24h",
"tow_street": "Schlepperstrasse 24",
"tow_zip": "23456 Schlepphausen",
"tow_country": "Deutschland",
"tow_phone": "02233 1234567",
"tow_lat": 53.567,
"tow_lon": 7.678
}
}
Vorgang konnte nicht vermittelt werden:
{
"task_id":"6730",
"status": "task_not_placed",
"status_time": "2018-08-19T13:00:00+0200"
}
GET-Parameter
Parametername | Typ | Beschreibung | Pflicht |
---|---|---|---|
task_id | int | MySchleppApp Vorgangsnummer | X |
api_key | string | MySchleppApp APIKEY | X |
Response Attribute
Parametername | Typ | Beschreibung |
---|---|---|
task_id | int | MySchleppApp Vorgangsnummer |
status | string | Vorgangsstatus: waiting_for_activation = Warte auf Aktivierung durch Anwender task_pending = Vorgang befindet sich in der Vermittlung task_placed = Vorgang wurde erfolgreich vermittelt task_not_placed = Vorgang konnte nicht vermittelt werden no_tow = Kein passender Abschleppdienst im Umkreis vorhanden driving_to_location = Anfahrt zum Havaristen location_arrived = Ankunft beim Havaristen driving_to_destination = Anfahrt zur Zieladresse destination_arrived = Ankunft an Zieladresse task_finished = Auftrag abgeschlossen task_stopped = Auftrag abgebrochen task_reversed = Auftrag storniert |
assigned_tow | tow | Objekt mit Informationen zum vermittelten Abschleppdienst. Dieses Attribut wird nur im Fall von task_placed zurückgegeben. |
proposed_to | array of tow | Array mit Informationen zu den Abschleppdiensten, denen der Vorgang angeboten wurde. Dieses Attribut wird nur im Fall von task_not_placed zurückgegeben. |
Request
<!--HTTP POST-->
https://<url>/callatow/task/status
CURL Beispiel:
curl -X "POST" "https://<url>/callatow/task/status" \
-H 'Content-Type: application/json' \
-d $'{
"api_key": "abZ&rf",
"customer_id": 10202,
"task_id": 20124,
"status_time": "2018-08-19T13:00:00+0200",
"status": "driving_to_location",
"location_time": "2018-08-19T13:00:00+0200",
"location_lat": 51.567,
"location_lon": 7.345,
"vehicle_ident": "SO-KO 36"
}'
Response
{
"success": true
}
{
"success": false,
"reason": 'Auftrag bereits vergeben!"
}
Antwort, wenn status Attribute = task_accepted
{
"success": true,
"contact_person": 'Herr Müller",
"contact_phone": '0171 123451234",
}
POST-Parameter
Parametername | Typ | Beschreibung | Pflicht |
---|---|---|---|
api_key | string | Der APIKEY dient zur Identifizierung des Senders benötigt und wird von der HESA Solutions GmbH mitgeteilt. |
X |
customer_id | int | customer_id aus der übermittelten Anfrage | X |
task_id | int | MySchleppApp Vorgangsnummer | X |
status_time | string | Status Zeitstempel ISO8601 | X |
tow | int | Id des Abschleppers | X |
status | string | task_accepted = Auftrag angenommen task_denied = Auftrag abgelehnt task_pending = keine aktive Aktion driving_to_location = Anfahrt zum Havaristen location_arrived = Ankunft beim Havaristen driving_to_destination = Anfahrt zur Zieladresse destination_arrived = Ankunft an Zieladresse task_finished = Auftrag abgeschlossen task_stopped = Auftrag abgebrochen task_reversed = Auftrag storniert empty_journey = Leerfahrt |
X |
status_reason | string | Begründung wenn "Auftrag abgebrochen","Auftrag storniert" und "Leerfahrt" | X* |
location_time | string | GPS Zeitstempel ISO8601 vom ASD-Fahrzeug | |
location_lat | double | Breitengrad ASD-Fahrzeug: z.B.: 51.567 |
|
location_lon | double | Längengrad ASD-Fahrzeug: z.B.: 7.345 |
|
vehicle_ident | string | ASD-Fahrzeug / Fahrerbezeichnung |
Struktur des tow Objektes:
Parametername | Typ | Beschreibung |
---|---|---|
tow_id | int | MySchleppApp Partnernummer |
tow_name | string | Name des Abschleppunternehmers |
tow_street | string | Straße des Abschleppunternehmers |
tow_zip | string | PLZ des Abschleppunternehmers |
tow_city | string | Ort des Abschleppunternehmers |
tow_country |
``` string | Land des Abschleppunternehmers|
| tow_phone | string | Rufnummer des Abschleppunternehmers|
Copyright © 2021 HESA Solutions GmbH