Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede

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. Es Standardmäßig wird einfach 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

Status
colourBlue
titlePOST
 cancel_order.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&customorderid=AUF_1234

Parameter

ParameterBeschreibungTypHinweisPflicht
companyRTI Firmenschlüsselstring

ja

vehicleRTI Fahrzeugschlüsselstring
ja
customorderideigene Auftragsnummerstringmaximal 20 Zeichenja
Rückgabewerte
cancelallFlag ob alle gefundenen Aufträge oder nur der erste widerrufen werden sollenboolist standardmäßig falsenein

Rückgabe

Es wird ein string zurückgegeben. Bei Erfolg wird als Antwort "OK" zurückgegeben. Ansonsten wird ein "ERROR:Beschreibung" zurückgegeben.

Beispiele


Code Block
titleWiderruft 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


Sv translation
languageen

Sends a "cancel order" to the connected display of requested car and sets the order as deleted/closed.

Requested custom order id will not be quecked checked for dublicates. In this case duplicates. By default only the first found order will be canceledcancelled. But you can specify by a flag that all found orders should be cancelled.

Description

Status
colourBlue
titlePOST
 cancel_order.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&customorderid=AUF_1234

Parameter

parameter
Parameter
description
Description
type
Type
note
Note
mandatory
Mandatory
companyRTI company keystring

yes

vehicleRTI car keystring
yes
customorderidown order idstringmax 20 charsyes
cancelallflag if all found orders or only the first one should be cancelledboolis false by defaultno

Return

Return Returns string. A success message will be "OK". Otherwise it will return "ERROR:Description".

Examples

Example call


Code Block
titlecancels order "AUF_1234"
httphttps://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