Wiki-Quellcode von address_management/set_area.php
Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36
Verstecke letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | (% class="box" %) |
| 2 | (((Inhaltsverzeichnis))) | ||
| 3 | {{toc/}} | ||
| 4 | |||
| 5 | Mit dieser Funktion können Sie servergestützte Gebiete erstellen, aktualisieren und löschen. | ||
| 6 | = Beschreibung = | ||
| 7 | //**(% 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 | ||
| 8 | = Parameter = | ||
| 9 | |||
| 10 | |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht | ||
| 11 | |company|RTI Firmenschlüssel|string||ja | ||
| 12 | |import|RTI Importschlüssel|string||ja | ||
| 13 | |mode|Unterscheidung der verschiedenen Aktionen|string|Parameter | ||
| 14 | ((( | ||
| 15 | * create = Neues Gebiet erstellen | ||
| 16 | * update =Gebiet aktualisieren | ||
| 17 | * delete = Gebiet löschen | ||
| 18 | )))|ja | ||
| 19 | |category|Gebietskategorie|string|ist aktuell immer 'passive'|ja | ||
| 20 | |uuid|Zur eindeutigen Identifizierung des Gebiets|string|Pflicht für Modus update und delete|ja | ||
| 21 | |type|Art des Gebiets|string|Optionaler Parameter | ||
| 22 | ((( | ||
| 23 | * polygon | ||
| 24 | * polyline | ||
| 25 | * square | ||
| 26 | )))|ja(1) | ||
| 27 | |coordinates|Breitengrad/Längengrad | ||
| 28 | Beispiel : [{"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|Koordinaten für den Gebietstyp: | ||
| 29 | ((( | ||
| 30 | * polygon = mindestens 3 | ||
| 31 | * polyline = mindestens 2 | ||
| 32 | * square = genau eine Koordinate | ||
| 33 | )))|ja(1)(2) | ||
| 34 | |name|Gebietsname|string|max. 50 Zeichen|ja(1)(2) | ||
| 35 | |costCenter|Kostenstelle|integer||nein | ||
| 36 | |useInTimeRecording|Soll das Gebiet in der Zeiterfassung angezeigt werden?|integer|Optionaler Parameter | ||
| 37 | ((( | ||
| 38 | * 0 (Standard) = Gebiet in der Zeiterfassung nicht anzeigen | ||
| 39 | * 1 = Gebiet in der Zeiterfassung anzeigen | ||
| 40 | )))|nein | ||
| 41 | |useInMap|Soll das Gebiet in der Karte angezeigt werden?|integer|Optionaler Parameter | ||
| 42 | ((( | ||
| 43 | * 0 (Standard) = Gebiet in der Karte nicht anzeigen | ||
| 44 | * 1 = Gebiet in der Karte anzeigen | ||
| 45 | )))|nein | ||
| 46 | |radius|Streckenbreite in Meter|integer|Nur wenn Gebietstyp 'polyline' oder 'square'. | ||
| 47 | Min. 200 und Max. 20.000|ja(1)(2) | ||
| 48 | |||
| 49 | Hinweise: | ||
| 50 | 1) Pflicht im Modus 'create' | ||
| 51 | 2) optional im Modus 'update' | ||
| 52 | |||
| 53 | = Rückgabe = | ||
| 54 | Es wird ein **String** zurückgegeben. Ansonsten wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben | ||
| 55 | === Parameter === | ||
| 56 | |=Parameter|=Beschreibung|=Typ | ||
| 57 | |uuid|Zur eindeutigen Identifizierung des Gebiets|string | ||
| 58 | |status|Ausgaben OK wenn die durchgeführte Aktion erfolgreich war|string | ||
| 59 | |||
| 60 | === JSON Format === | ||
| 61 | |||
| 62 | {{code language="java"}} { | ||
| 63 | "uuid": "ABC-123-DEF", | ||
| 64 | "status": "OK" | ||
| 65 | }{{/code}} | ||
| 66 | |||
| 67 | = Beispiele = | ||
| 68 | |||
| 69 | {{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}} | ||
| 70 |