Wiki source code of address_management/set_area_vehicle.php
Last modified by YellowFox_RD on 2025/01/23 09:11
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | (% class="box" %) | ||
2 | ((( | ||
3 | Table of Contents | ||
4 | ))) | ||
5 | |||
6 | {{toc/}} | ||
7 | |||
8 | This function allows you to assign or remove server-based vehicles. | ||
9 | |||
10 | = Description = | ||
11 | |||
12 | (% class="green mark" %)**GET**(%%)** **/**address_management**/**set_area_vehicle.php?company**=RTI_COMPANYKEY**&mode**=assign**&category**=passive**&uuid**=ABC-123-DEF**&vehicle**=VEHICLE_KEY | ||
13 | |||
14 | = Parameter = | ||
15 | |||
16 | |=Parameter|=Description|=Type|=Note|=Mandatory | ||
17 | |company|RTI Company key|string| |yes | ||
18 | |mode|Distinguishing between the different actions|string|Possible values:((( | ||
19 | * assign= assigning a new vehicle to an area | ||
20 | * remove =remove the assigned vehicle to an area | ||
21 | )))|yes | ||
22 | |vehicle|RTI Vehicle key|string| |yes | ||
23 | |uuid|To clearly identify the area|string| |yes | ||
24 | |category|Type of area|string|Possible values :((( | ||
25 | * passive | ||
26 | )))|yes | ||
27 | |||
28 | = Return = | ||
29 | |||
30 | A **String **is returned. Otherwise an "(% class="error" %)**ERROR:Description**(%%)" is returned | ||
31 | |||
32 | == Parameter == | ||
33 | |||
34 | |=Parameter|=Description|=Type | ||
35 | |status|Outputs OK if the action performed was successful|string | ||
36 | |||
37 | == JSON Format == | ||
38 | |||
39 | {{code language="java"}} | ||
40 | { | ||
41 | "status": "OK" | ||
42 | } | ||
43 | {{/code}} | ||
44 | |||
45 | = Example = | ||
46 | |||
47 | {{code language="java"}}https://map.yellowfox.de/rti/address_management/set_area_vehicle.php?company=COMPANY_KEY&vehicle=VEHICLE_KEY&category=passive&uuid=ABC-123-DEF&mode=assign {{/code}} | ||
48 |