Wiki-Quellcode von address_management/get_areas.php
Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36
Zeige letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="box" %) | ||
| 2 | ((( | ||
| 3 | Inhaltsverzeichnis | ||
| 4 | ))) | ||
| 5 | |||
| 6 | {{toc/}} | ||
| 7 | |||
| 8 | Mit dieser Funktion können Sie eine Liste aller servergestützten Gebiete abrufen. | ||
| 9 | |||
| 10 | = Beschreibung = | ||
| 11 | |||
| 12 | (% class="green mark" %)**GET**(%%)** **/**address_management**/**get_areas.php?company**=RTI_COMPANYKEY**&import=**RTI_IMPORTKEY**&displayDeleted**=0 | ||
| 13 | |||
| 14 | = Parameter = | ||
| 15 | |||
| 16 | |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht | ||
| 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((( | ||
| 20 | * 0 (Standard) =Nur nicht gelöschte Gebiete anzeigen | ||
| 21 | * 1 =auch Gelöschte Gebiete anzeigen | ||
| 22 | )))|nein | ||
| 23 | |format|Ausgabeformat|string|json (Standard)|ja | ||
| 24 | |||
| 25 | = Rückgabe = | ||
| 26 | |||
| 27 | Es wird ein **String** zurückgegeben. Ansonsten wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben | ||
| 28 | |||
| 29 | === Parameter === | ||
| 30 | |||
| 31 | |==== Parameter ===|=Beschreibung|=Typ | ||
| 32 | |uuid|Zur eindeutigen Identifizierung der Gebietsdaten|string | ||
| 33 | |name|Gebietsname|string | ||
| 34 | |type|Gebietstyp(polygon,polyline )|string | ||
| 35 | |costCenter|Kostenstelle|integer | ||
| 36 | |coordinates|Breitengrad/Längengrad|float | ||
| 37 | |radius|Breite der Route|integer | ||
| 38 | |changeDate|Änderungsdatum der Angaben|Format YYYY-MM-dd'T'HH:MM:SS.SSSZ | ||
| 39 | |createDate|Erstellungsdatum der Angaben|Format YYYY-MM-dd'T'HH:MM:SS.SSSZ | ||
| 40 | |deleteDate|Löschdatum der Angaben|Format YYYY-MM-dd'T'HH:MM:SS.SSSZ | ||
| 41 | |useInTimeRecording|soll das Gebiet in der Zeiterfassung angezeigt werden?|boolean | ||
| 42 | |useInMap|soll das Gebiet in der Karte angezeigt werden?|boolean | ||
| 43 | |assignedVehicles|Liste der zugewiesenen Fahrzeuge (aktive)|array | ||
| 44 | |_links|Links (IFrameMapEditor, Delete)| | ||
| 45 | |||
| 46 | === JSON Format === | ||
| 47 | |||
| 48 | {{code language="js"}} | ||
| 49 | [{ | ||
| 50 | "uuid": "ABC-123-DEF", | ||
| 51 | "name": "100 test", | ||
| 52 | "type": "polygon", | ||
| 53 | "costCenter": "100", | ||
| 54 | "coordinates": [ | ||
| 55 | { | ||
| 56 | "lat": 2.33867, | ||
| 57 | "lon": 48.8554 | ||
| 58 | }, | ||
| 59 | { | ||
| 60 | "lat": 2.33867, | ||
| 61 | "lon": 48.859 | ||
| 62 | }, | ||
| 63 | { | ||
| 64 | "lat": 2.34413, | ||
| 65 | "lon": 48.859 | ||
| 66 | }, | ||
| 67 | { | ||
| 68 | "lat": 2.34413, | ||
| 69 | "lon": 48.8554 | ||
| 70 | } | ||
| 71 | ], | ||
| 72 | "radius": 0, | ||
| 73 | "changeDate": "2023-02-22T14:02:21+0100", | ||
| 74 | "createDate": "2023-02-21T12:51:12+0100", | ||
| 75 | "deleteDate": null, | ||
| 76 | "useInTimeRecording": true, | ||
| 77 | "useInMap": true, | ||
| 78 | "assignedVehicles": [ | ||
| 79 | { | ||
| 80 | "vehicleSign ": "vehicleSign 1" | ||
| 81 | }, | ||
| 82 | { | ||
| 83 | "vehicleSign ": "vehicleSign 2" | ||
| 84 | }, | ||
| 85 | { | ||
| 86 | "vehicleSign ": "vehicleSign 3" | ||
| 87 | } | ||
| 88 | |||
| 89 | ], | ||
| 90 | "_links": { | ||
| 91 | "editor": { | ||
| 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}} | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | = Beispielaufruf = | ||
| 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}} | ||
| 105 |