Versions Compared

Old Version 2

changes.mady.by.user YellowFox R&D

Saved on

compared with

New Version Current

changes.mady.by.user YellowFox R&D

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede

Mit dieser Funktion können Sie

...

servergestützte Gebiete erstellen, aktualisieren und löschen.

Beschreibung

...

Status
colourBlue
titlePOST
/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


ParameterBeschreibungTypHinweisPflicht
companyRTI Firmenschlüsselstring
ja
importRTI Importschlüssel

...

string
ja
modeUnterscheidung der verschiedenen Aktionenstring

Parameter

  • create = Neues Gebiet erstellen
  • update =Gebiet aktualisieren
  • delete = Gebiet löschen
ja
categoryGebietskategoriestringist aktuell immer 'passive'ja
uuidZur eindeutigen Identifizierung des GebietsstringPflicht für Modus update und delete

...

ja
typeArt des Gebietsstring

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)

...

nameGebietsnamestringmax. 50 Zeichenja(1)(2)
costCenterKostenstelleinteger
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

...

Optionaler Parameter

  • create =Neues Gebiet erstellen
  • update=Gebiet aktualisieren
  • delete=Gebiet löschen

...

radiusStreckenbreite in Meterinteger

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

ParameterBeschreibungTyp
uuidZur eindeutigen Identifizierung

...

des Gebietsstring
statusAusgaben OK wenn die durchgeführte Aktion erfolgreich warstring

JSON Format

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

...


Beispiele


Code Block
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


Sv translation
languageen

This function allows you to create, update and delete server-based territories.

Description

Status
colourBlue
titlePOST
/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


ParameterDescriptionTypeNoteObligation
companyRTI Company keystring
yes
importRTI Import keystring
yes
modeDistinguishing between the different actionsstring

Parameter

  • create = Create new area
  • update =Update area
  • delete = Delete area
yes
categoryArea categorystringis currently always 'passiveyes
uuidFor the unique identification of the areastringMandatory for update and delete modeyes
typeType of areastring

Optional parameter

  • polygon
  • polyline
  • square
yes(1)
coordinates

Latitude/Longitude

Example:[{"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

Coordinates for the area type:

  • polygon = minimum 3
  • polyline = minimum 2
  • square  = Exactly one coordinate
yes(1)(2)
nameArea namestringmax. 50 Charactersyes(1)(2)
costCenterCost centreinteger
no
useInTimeRecordingShould the area be displayed in the time recording?integer

Optional Parameter

  • 0 (Standard) =Do not show area in time recording
  • 1 = Show area in time recording
no
useInMapShould the area be displayed on the map?integer

Optional Parameter

  • 0 (Standard) =Do not show area on map
  • 1 = Show area in map
no
radiusRoute width in metresinteger

Only if area type 'polyline' or 'square'.

Min. 200 und Max. 20.000

yes(1)(2)

Notes:

1) Mandatory in 'create' mode

2)  Optional in 'update' mode


Return

A string is returned. Otherwise a "ERROR:Description" returned

Parameter

ParameterDescriptionType
uuidTo clearly identify the areastring
statusOutputs OK if the action performed was successfulstring

JSON Format

Code Block

JSON Format

Code Block
[ 
{
        "uuid": "ABC-123-DEF",
        "status": "OK"
  
}
]

Examples
...

 Code Block
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