Last modified by YellowFox_RD on 2025/01/23 09:11
Show last authors
1 (% class="box" %)
2 (((
3 Table of Contents
4 )))
5
6 {{toc/}}
7
8 This function allows you to create, update and delete server-based territories.
9
10 = Description =
11
12 (% class="blue mark" %)//**POST**//(%%)//** **///**address_management**/**set_areas.php?company**=RTI_COMPANYKEY**&import=**RTI_IMPORTKEY**&type**=square**&coordinates**=[{"lat":13.33889,"lon":50.89091}]**&name**=name**&costCenter**=kosten**&useInTimeRecording**=0**&useInMap**=0**&mode**=create**&category**=passive
13
14 = Parameter =
15
16 |=Parameter|=Description|=Type|=Note|=Obligation
17 |company|RTI Company key|string| |yes
18 |import|RTI Import key|string| |yes
19 |mode|Distinguishing between the different actions|string|Parameter(((
20 * create = Create new area
21 * update =Update area
22 * delete = Delete area
23 )))|yes
24 |category|Area category|string|is currently always 'passive|yes
25 |uuid|For the unique identification of the area|string|Mandatory for update and delete mode|yes
26 |type|Type of area|string|Optional parameter(((
27 * polygon
28 * polyline
29 * square
30 )))|yes(1)
31 |coordinates|Latitude/Longitude
32 Example:[{"lat":13.33889,"lon":50.89091},{"lat":13.32491,"lon":50.89091},{"lat":13.32491,"lon":50.89989},{"lat":13.33889,"lon":50.89989}]|string|Coordinates for the area type:(((
33 * polygon = minimum 3
34 * polyline = minimum 2
35 * square  = Exactly one coordinate
36 )))|yes(1)(2)
37 |name|Area name|string|max. 50 Characters|yes(1)(2)
38 |costCenter|Cost centre|integer| |no
39 |useInTimeRecording|Should the area be displayed in the time recording?|integer|Optional Parameter(((
40 * 0 (Standard) =Do not show area in time recording
41 * 1 = Show area in time recording
42 )))|no
43 |useInMap|Should the area be displayed on the map?|integer|Optional Parameter(((
44 * 0 (Standard) =Do not show area on map
45 * 1 = Show area in map
46 )))|no
47 |radius|Route width in metres|integer|Only if area type 'polyline' or 'square'.
48 Min. 200 und Max. 20.000|yes(1)(2)
49
50 Notes:
51 1) Mandatory in 'create' mode
52 2)  Optional in 'update' mode
53
54 = Return =
55
56 A string is returned. Otherwise a "(% class="error" %)**ERROR:Description**(%%)" returned
57
58 == Parameter ==
59
60 |=Parameter|=Description|=Type
61 |uuid|To clearly identify the area|string
62 |status|Outputs OK if the action performed was successful|string
63
64 == JSON Format ==
65
66 {{code language="java"}}
67 {
68 "uuid": "ABC-123-DEF",
69 "status": "OK"
70 }
71 {{/code}}
72
73 = Examples =
74
75 {{code language="java"}}https://map.yellowfox.de/rti/address_management/set_area.php?company=COMPANY_KEY&import=IMPORT_KEY&type=polygon&coordinates=[{"lat":13.33889,"lon":50.89091},{"lat":13.32491,"lon":50.89091},{"lat":13.32491,"lon":50.89989},{"lat":13.33889,"lon":50.89989}]&name=testing123456&costCenter=012&useInTimeRecording=0&useInMap=0&mode=create&category=passive{{/code}}
76