API

Immobilien

GET https://domain.com/api/estatemanager/v1/estates/:id

Abrufen einer oder mehrerer Immobilien.

Path Parameters

Name	Type	Description
id	integer	ID der abzurufenden Immobilie

Query Parameters

Name	Type	Description
moduleID	integer	Modul-ID (required für das verwenden eines Filters sowie eines Templates mit Immobilien-Objekt)
pageId	integer	Seiten-ID (required für das verwenden eines Filters)
template	string	Name des Fronend-Templates (Bspw. real_estate_item_default).
dataType	string	json, geojson Default: json
fields	array	Die abzurufenden Immobilien-Felder.
groups	array	Die abzurufenden Immobilien-Gruppen. (required für das verwenden eines Filters)
filter	boolean	Die Abfrage findet unter Berücksichtigung eines Filters statt.
filterMode	boolean	Sofern ein Filter verwendet werden soll, kann hier der Filter-Modus definiert werden. (required für das verwenden eines Filters)

200 /api/estatemanager/v1/estates/35

{
  "status": "OK",
  "meta": [
    "total": 1,
    "query": []
  ],
  "results": [
    {
      "id": "35",
      "dateAdded": "1543328488",
      "dateChanged": "1572949938"
    }
  ]
}

Kontaktpersonen

GET https://domain.com/api/estatemanager/v1/contactpersons/:id

Abrufen einer oder mehrerer Kontaktpersonen.

Path Parameters

Name	Type	Description
id	string	ID der abzurufenden Kontaktperson

Query Parameters

Name	Type	Description
imgSize	array	Bildgröße des Kontaktpersonen-Fotos.
fields	array	Die abzurufenden Kontaktperson-Felder.

200 /api/estatemanager/v1/contactpersons?fields[]=vorname&fields[]=name

{
  "status": "OK",
  "meta": [
    "total": 1,
    "query": [
      "fields": [
        "vorname",
        "name"
      ]
    ]
  ],
  "results": [
    {
      "vorname": "Maria",
      "name": "Musterfrau"
    }
  ]
}

Fehlerbehandlung