address_management/get_areas.php

Last modified by YellowFox_RD on 2025/11/27 07:46

Table of Contents

Description
Parameter
Return
- Parameter
- JSON Format
Example Calls

This function allows you to retrieve a list of all server-based areas.

Description

GET /address_management/get_areas.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&displayDeleted=0

Parameter

Parameter	Beschreibung	Typ	Hinweis	Pflicht
company	RTI company key	string		yes
import	RTI import key (all vehicles)	string		yes
displayDeleted	Should deleted areas be displayed?	string	Optional parameter 0 (default) =Display only non-deleted areas 1 =Display deleted areas as well	no
format	Output format	string	json (Standard)	yes
limit	max number of returned areas	int	These parameter were introduced later, so they are not mandatory. If your company has a lot of areas or assignments to them, you might not get a result without limit and offset due to large data. We highly recommend using them for a stable usage.	no
offset	offset in results	int		no

Return

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

Parameter

=== Parameter ===	Description	Type
uuid	For the unique identification of the area data	string
name	Area name	string
type	Area type(polygon,polyline )	string
costCenter	Cost center	integer
coordinates	Latitude/Longitude	float
radius	Route width	integer
changeDate	Date of change of the data	Format YYYY-MM-dd'T'HH:MM:SS.SSSZ
createDate	Date of creation of the data	Format YYYY-MM-dd'T'HH:MM:SS.SSSZ
deleteDate	Date of deletion of the data	Format YYYY-MM-dd'T'HH:MM:SS.SSSZ
useInTimeRecording	should the area be displayed in the time recording?	boolean
useInMap	should the area be displayed on the map?	boolean
assignedVehicles	List of assigned vehicles (active)	array
_links	Links (IFrameMapEditor, Delete)

JSON Format

[{
       "uuid": "ABC-123-DEF",
       "name": "100 test",
       "type": "polygon",
       "costCenter": "100",
       "coordinates": [
            {
               "lat": 2.33867,
               "lon": 48.8554
            },
            {
               "lat": 2.33867,
               "lon": 48.859
            },
            {
               "lat": 2.34413,
               "lon": 48.859
            },
            {
               "lat": 2.34413,
               "lon": 48.8554
            }
        ],
       "radius": 0,
       "changeDate": "2023-02-22T14:02:21+0100",
       "createDate": "2023-02-21T12:51:12+0100",
       "deleteDate": null,
       "useInTimeRecording": true,
       "useInMap": true,
       "assignedVehicles": [
            {
               "vehicleSign ": "vehicleSign 1"
            },
            {
               "vehicleSign ": "vehicleSign 2"
            },
            {
               "vehicleSign ": "vehicleSign 3"
            }

        ],
   "_links": {
           "editor": {
               "href": "https://map.yellowfox.de/rti/address_management/area_editor.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&uuid=123-ABC-345-DEF&category=passive"
     }
    }
   }],

Example Calls

http://map.yellowfox.de/rti/address_management/get_areas.php?company=COMPANY_KEY&import=IMPORT_KEY&displayDeleted=1