address_management/set_area.php

Last modified by YellowFox_RD on 2025/01/23 09:11

Table of Contents

Description
Parameter
Return
- Parameter
- JSON Format
Examples

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

Description

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	Description	Type	Note	Obligation
company	RTI Company key	string		yes
import	RTI Import key	string		yes
mode	Distinguishing between the different actions	string	Parameter create = Create new area update =Update area delete = Delete area	yes
category	Area category	string	is currently always 'passive	yes
uuid	For the unique identification of the area	string	Mandatory for update and delete mode	yes
type	Type of area	string	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)
name	Area name	string	max. 50 Characters	yes(1)(2)
costCenter	Cost centre	integer		no
useInTimeRecording	Should 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
useInMap	Should the area be displayed on the map?	integer	Optional Parameter 0 (Standard) =Do not show area on map 1 = Show area in map	no
radius	Route width in metres	integer	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

Parameter	Description	Type
uuid	To clearly identify the area	string
status	Outputs OK if the action performed was successful	string

JSON Format

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

Examples

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