cancel_order.php
Inhaltsverzeichnis
Sendet ein "Auftrag widerrufen" an das am Fahrzeug verbundene Display und setzt den Auftrag als gelöscht/abgeschlossen.
Die eigene Auftragsnummer wird beim anlegen nicht auf Duplikate geprüft. Standardmäßig wird nur der erste Auftrag storniert, der unter der übergebenen Auftragsnummer gefunden wird. Über ein Flag kann zusätzlich definiert werden, das alle gefundenen Aufträge storniert werden sollen.
Beschreibung
POST cancel_order.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&customorderid=AUF_1234
Parameter
| Parameter | Beschreibung | Typ | Hinweis | Pflicht |
|---|---|---|---|---|
| company | RTI Firmenschlüssel | string | ja | |
| vehicle | RTI Fahrzeugschlüssel | string | ja | |
| customorderid | eigene Auftragsnummer | string | maximal 20 Zeichen | ja |
| cancelall | Flag ob alle gefundenen Aufträge oder nur der erste widerrufen werden sollen | bool | ist standardmäßig false | nein |
Rückgabe
Es wird ein string zurückgegeben. Bei Erfolg wird als Antwort "OK" zurückgegeben. Ansonsten wird ein "ERROR:Beschreibung" zurückgegeben.
Beispiele
Widerruft den Auftrag "AUF_1234"
https://map.yellowfox.de/rti/cancel_order.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&customorderid=AUF_1234
https://map.yellowfox.de/rti/cancel_order.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&customorderid=AUF_1234