Wiki source code of cancel_order.php

Last modified by YellowFox_RD on 2024/12/19 10:11
Show last authors
1 (% class="box" %)
2 (((Table of Contents)))
3 {{toc/}}
4
5 Sends a "cancel order" to the connected display of requested car and sets the order as deleted/closed.
6 Requested custom order id will not be checked for duplicates. By default only the first found order will be cancelled. But you can specify by a flag that all found orders should be cancelled.
7 = Description =
8 //**(% class="blue mark" %)POST(%%) cancel_order.php?company**=//COMPANY_RTIKEY//**&vehicle=**//VEHICLE_RTIKEY//**&customorderid**=AUF_1234//
9 = Parameter =
10 |=Parameter|=Description|=Type|=Note|=Mandatory
11 |company|RTI company key|string||yes
12 |vehicle|RTI car key|string||yes
13 |customorderid|own order id|string|max 20 chars|yes
14 |cancelall|flag if all found orders or only the first one should be cancelled|bool|is false by default|no
15
16 = Return =
17 Returns a **string**. A success message will be "**OK**". Otherwise it will return "(% class="error" %)**ERROR:Description**(%%)".
18 = Example call =
19
20 **cancels order "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