Last modified by YellowFox_RD on 2025/01/23 09:09
From version 3.1
edited by YellowFox_RD
on 2025/01/23 09:09
Change comment: There is no comment for this version
To version 1.1
edited by YellowFox_RD
on 2024/12/19 10:11
Change comment: Imported from XAR

Summary

Details

Page properties
Content
... ... @@ -1,22 +1,17 @@
1 1  (% class="box" %)
2 -(((
3 -Table of Contents
4 -)))
5 -
2 +(((Table of Contents)))
6 6  {{toc/}}
7 7  
8 8  This function allows you to retrieve a list of all server-based areas.
9 -
10 10  = Description =
11 -
12 -(% class="green mark" %)**GET**(%%)** **/**address_management**/**get_areas.php?company**=RTI_COMPANYKEY**&import=**RTI_IMPORTKEY**&displayDeleted**=0
13 -
7 +**(% class="green mark" %)GET(%%) **/**address_management**/**get_areas.php?company**=RTI_COMPANYKEY**&import=**RTI_IMPORTKEY**&displayDeleted**=0
14 14  = Parameter =
15 15  
16 16  |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
17 -|company|RTI company key|string| |yes
18 -|import|RTI import key (all vehicles)|string| |yes
19 -|displayDeleted|Should deleted areas be displayed?|string|Optional parameter(((
11 +|company|RTI company key|string||yes
12 +|import|RTI import key (all vehicles)|string||yes
13 +|displayDeleted|Should deleted areas be displayed?|string|Optional parameter
14 +(((
20 20  * 0 (default) =Display only non-deleted areas
21 21  * 1 =Display deleted areas as well
22 22  )))|no
... ... @@ -23,11 +23,8 @@
23 23  |format|Output format|string|json (Standard)|yes
24 24  
25 25  = Return =
26 -
27 27  A **string **is returned. Otherwise an  "(% class="error" %)**ERROR:Description**(%%)" is returned
28 -
29 -== Parameter ==
30 -
22 +=== Parameter ===
31 31  |==== Parameter ===|=Description|=Type
32 32  |uuid|For the unique identification of the area data|string
33 33  |name|Area name|string
... ... @@ -41,12 +41,11 @@
41 41  |useInTimeRecording|should the area be displayed in the time recording?|boolean
42 42  |useInMap|should the area be displayed on the map?|boolean
43 43  |assignedVehicles|List of assigned vehicles (active)|array
44 -|_links|Links (IFrameMapEditor, Delete)|
36 +|_links|Links (IFrameMapEditor, Delete)|
45 45  
46 -== JSON Format ==
38 +=== JSON Format ===
47 47  
48 -{{code language="js"}}
49 - [{
40 +{{code language="js"}} [{
50 50   "uuid": "ABC-123-DEF",
51 51   "name": "100 test",
52 52   "type": "polygon",
... ... @@ -87,17 +87,15 @@
87 87   }
88 88  
89 89   ],        
90 - "_links": {
81 + "_links": {
91 91   "editor": {
92 92   "href": "https://map.yellowfox.de/rti/address_management/area_editor.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&uuid=123-ABC-345-DEF&category=passive"
93 - }
94 - }
95 -      }],
96 -{{/code}}
84 + }
85 + }
86 +      }],{{/code}}
97 97  
98 -
99 -
88 +//
89 +//
100 100  = Example Calls =
101 -
102 -{{code language="js"}}http://map.yellowfox.de/rti/address_management/get_areas.php?company=COMPANY_KEY&import=IMPORT_KEY&displayDeleted=1{{/code}}
91 +|https:~/~/[[map.yellowfox.de/rti/address_management/get_areas.php?company=COMPANY_KEY&import=IMPORT_KEY&displayDeleted=>>http://map.yellowfox.de/rti/address_management/get_areas.php?company=COMPANY_KEY&import=IMPORT_KEY&displayDeleted=1]]0
103 103