address_management/set_area.php

Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36

Inhaltsverzeichnis

Beschreibung
Parameter
Rückgabe
- - Parameter
  - JSON Format
Beispiele

Mit dieser Funktion können Sie servergestützte Gebiete erstellen, aktualisieren und löschen.

Beschreibung

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

Parameter

Parameter	Beschreibung	Typ	Hinweis	Pflicht
company	RTI Firmenschlüssel	string		ja
import	RTI Importschlüssel	string		ja
mode	Unterscheidung der verschiedenen Aktionen	string	Parameter create = Neues Gebiet erstellen update =Gebiet aktualisieren delete = Gebiet löschen	ja
category	Gebietskategorie	string	ist aktuell immer 'passive'	ja
uuid	Zur eindeutigen Identifizierung des Gebiets	string	Pflicht für Modus update und delete	ja
type	Art des Gebiets	string	Optionaler Parameter polygon polyline square	ja(1)
coordinates	Breitengrad/Längengrad 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: polygon = mindestens 3 polyline = mindestens 2 square = genau eine Koordinate	ja(1)(2)
name	Gebietsname	string	max. 50 Zeichen	ja(1)(2)
costCenter	Kostenstelle	integer		nein
useInTimeRecording	Soll das Gebiet in der Zeiterfassung angezeigt werden?	integer	Optionaler Parameter 0 (Standard) = Gebiet in der Zeiterfassung nicht anzeigen 1 = Gebiet in der Zeiterfassung anzeigen	nein
useInMap	Soll das Gebiet in der Karte angezeigt werden?	integer	Optionaler Parameter 0 (Standard) = Gebiet in der Karte nicht anzeigen 1 = Gebiet in der Karte anzeigen	nein
radius	Streckenbreite in Meter	integer	Nur wenn Gebietstyp 'polyline' oder 'square'. Min. 200 und Max. 20.000	ja(1)(2)

Hinweise:
1) Pflicht im Modus 'create'
2) optional im Modus 'update'

Rückgabe

Es wird ein String zurückgegeben. Ansonsten wird ein "ERROR:Beschreibung" zurückgegeben

Parameter

Parameter	Beschreibung	Typ
uuid	Zur eindeutigen Identifizierung des Gebiets	string
status	Ausgaben OK wenn die durchgeführte Aktion erfolgreich war	string

JSON Format

  {
       "uuid": "ABC-123-DEF",
       "status": "OK"
}

Beispiele

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