Änderungen von Dokument address_management/get_areas.php

Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36
Von Version 1.1
bearbeitet von YellowFox_RD
am 2024/12/19 10:11
Änderungskommentar: Imported from XAR
Auf Version 3.1
bearbeitet von YellowFox_RD
am 2025/01/20 11:21
Änderungskommentar: Replaced user [XWiki.yf-dominic] in fields [author, contentAuthor] to user [XWiki.YellowFox_RD]

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,25 +1,33 @@
1 1  (% class="box" %)
2 -(((Inhaltsverzeichnis)))
2 +(((
3 +Inhaltsverzeichnis
4 +)))
5 +
3 3  {{toc/}}
4 4  
5 5  Mit dieser Funktion können Sie eine Liste aller servergestützten Gebiete abrufen.
9 +
6 6  = Beschreibung =
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 Firmenschlüssel|string||ja
12 -|import|RTI Importschlüssel (alle Fahrzeuge)|string||ja
13 -|displayDeleted|Sollen gelöschte Gebiete angezeigt werden?|string|Optionaler Parameter
14 -(((
17 +|company|RTI Firmenschlüssel|string| |ja
18 +|import|RTI Importschlüssel (alle Fahrzeuge)|string| |ja
19 +|displayDeleted|Sollen gelöschte Gebiete angezeigt werden?|string|Optionaler Parameter(((
15 15  * 0 (Standard) =Nur nicht gelöschte Gebiete anzeigen
16 -* 1 =auch Gelöschte Gebiete anzeigen 
21 +* 1 =auch Gelöschte Gebiete anzeigen
17 17  )))|nein
18 18  |format|Ausgabeformat|string|json (Standard)|ja
19 19  
20 20  = Rückgabe =
26 +
21 21  Es wird ein **String** zurückgegeben. Ansonsten wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben
28 +
22 22  === Parameter ===
30 +
23 23  |==== Parameter ===|=Beschreibung|=Typ
24 24  |uuid|Zur eindeutigen Identifizierung der Gebietsdaten|string
25 25  |name|Gebietsname|string
... ... @@ -33,11 +33,12 @@
33 33  |useInTimeRecording|soll das Gebiet in der Zeiterfassung angezeigt werden?|boolean
34 34  |useInMap|soll das Gebiet in der Karte angezeigt werden?|boolean
35 35  |assignedVehicles|Liste der zugewiesenen Fahrzeuge (aktive)|array
36 -|_links|Links (IFrameMapEditor, Delete)|
44 +|_links|Links (IFrameMapEditor, Delete)|
37 37  
38 38  === 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",
... ... @@ -82,11 +82,15 @@
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 84   }    
85 - }
86 - }],{{/code}}
94 + }
95 + }],
96 +{{/code}}
87 87  
88 -//
89 -//
98 +
99 +
90 90  = Beispielaufruf =
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
101 +
102 +{{code language="js"}}
103 +https://map.yellowfox.de/rti/address_management/get_areas.php?company=COMPANY_KEY&import=IMPORT_KEY&displayDeleted=0
104 +{{/code}}
92 92