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

Summary

Details

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