Wiki-Quellcode von cancel_order.php
Version 1.1 von YellowFox_RD am 2024/12/19 10:11
Zeige letzte Bearbeiter
author | version | line-number | content |
---|---|---|---|
1 | (% class="box" %) | ||
2 | (((Inhaltsverzeichnis))) | ||
3 | {{toc/}} | ||
4 | |||
5 | Sendet ein "Auftrag widerrufen" an das am Fahrzeug verbundene Display und setzt den Auftrag als gelöscht/abgeschlossen. | ||
6 | 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. | ||
7 | = Beschreibung = | ||
8 | //**(% class="blue mark" %)POST(%%) cancel_order.php?company**=//COMPANY_RTIKEY//**&vehicle=**//VEHICLE_RTIKEY//**&customorderid**=AUF_1234// | ||
9 | = Parameter = | ||
10 | |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht | ||
11 | |company|RTI Firmenschlüssel|string||ja | ||
12 | |vehicle|RTI Fahrzeugschlüssel|string||ja | ||
13 | |customorderid|eigene Auftragsnummer|string|maximal 20 Zeichen|ja | ||
14 | |cancelall|Flag ob alle gefundenen Aufträge oder nur der erste widerrufen werden sollen|bool|ist standardmäßig false|nein | ||
15 | |||
16 | = Rückgabe = | ||
17 | Es wird ein **string** zurückgegeben. Bei Erfolg wird als Antwort "**OK**" zurückgegeben. Ansonsten wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben. | ||
18 | = Beispiele = | ||
19 | |||
20 | **Widerruft den Auftrag "AUF_1234"** | ||
21 | {{code language="java"}}https://map.yellowfox.de/rti/cancel_order.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&customorderid=AUF_1234 | ||
22 | |||
23 | https://map.yellowfox.de/rti/cancel_order.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&customorderid=AUF_1234{{/code}} | ||
24 |