address_management/get_areas.php
Version 2.1 von Dominic Lippmann am 2025/01/17 15:20
Inhaltsverzeichnis
Mit dieser Funktion können Sie eine Liste aller servergestützten Gebiete abrufen.
Beschreibung
GET /address_management/get_areas.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&displayDeleted=0
Parameter
| Parameter | Beschreibung | Typ | Hinweis | Pflicht |
|---|---|---|---|---|
| company | RTI Firmenschlüssel | string | ja | |
| import | RTI Importschlüssel (alle Fahrzeuge) | string | ja | |
| displayDeleted | Sollen gelöschte Gebiete angezeigt werden? | string | Optionaler Parameter
| nein |
| format | Ausgabeformat | string | json (Standard) | ja |
Rückgabe
Es wird ein String zurückgegeben. Ansonsten wird ein "ERROR:Beschreibung" zurückgegeben
Parameter
| === Parameter === | Beschreibung | Typ |
|---|---|---|
| uuid | Zur eindeutigen Identifizierung der Gebietsdaten | string |
| name | Gebietsname | string |
| type | Gebietstyp(polygon,polyline ) | string |
| costCenter | Kostenstelle | integer |
| coordinates | Breitengrad/Längengrad | float |
| radius | Breite der Route | integer |
| changeDate | Änderungsdatum der Angaben | Format YYYY-MM-dd'T'HH:MM:SS.SSSZ |
| createDate | Erstellungsdatum der Angaben | Format YYYY-MM-dd'T'HH:MM:SS.SSSZ |
| deleteDate | Löschdatum der Angaben | Format YYYY-MM-dd'T'HH:MM:SS.SSSZ |
| useInTimeRecording | soll das Gebiet in der Zeiterfassung angezeigt werden? | boolean |
| useInMap | soll das Gebiet in der Karte angezeigt werden? | boolean |
| assignedVehicles | Liste der zugewiesenen Fahrzeuge (aktive) | 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"
}
}
}],
"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"
}
}
}],
Beispielaufruf
https://map.yellowfox.de/rti/address_management/get_areas.php?company=COMPANY_KEY&import=IMPORT_KEY&displayDeleted=0