Objekte
get
https://api.propstack.de
/v1/units?with_meta=1
Objekte lesen
Eine Excel-Datei mit allen relevanten Felder eines Objektes, gruppiert nach Objekttyp:
exposee-fields.xlsx
27KB
Binary
Objekt-Felder (für Exposés speziell)
In Propstack kann man bestimmte Texte eines Objektes in mehreren Sprachen einstellen. Folgende Felder können übersetzt werden:
- 1.Überschrift (title)
- 2.Objektbeschreibung (description_note)
- 3.Lagebeschreibung (location_note)
- 4.Ausstattung (furnishing_note)
- 5.Sonstiges (other_note)
- 6.Käuferprovision (courtage)
- 7.Provisionshinweis (courtage_note)
Um die Objekte in einer anderen Sprache zu erhalten gibt man einen weiteren Parameter
locale
mit. Standardmäßig erhält man die deutsche Sprache. Über locale=en
würde man die englischen Texte erhalten.Folgende Felder kann man zusätzlich über die API filtern anhand von "ab-bis" Angaben:
- Kaufpreis: price
- Kaltmiete: base_rent
- Warmmiete: total_rent
- Fläche: property_space_value
- Wohnfläche: living_space
- Grundstücksfläche: plot_area
- Zimmer: number_of_rooms
- Schlafzimmer: number_of_bed_rooms
- Badezimmer: number_of_bath_rooms
- Etage: floor
- Baujahr: construction_year
Die Parameter dafür haben immer ein
_from
oder _to
angehängt, um zu bestimmen ob es ab diesem Wert gilt oder bis zu diesem Wert. Beispiel:?price_from=300000&price_to=350000
wirft alle Objekte aus, deren Preis zwischen 300.000 und 350.000 € liegen. ?plot_area=1500
wirft alle Objekte aus, deren Grundstücksfläche über 1.500qm beträgt.- Auftragsnummer:
exposee_id
- Baujahr:
construction_year
- Einheitenummer:
unit_id.raw
- Etage:
floor
- Erstellungsdatum:
created_at
- Fläche:
property_space_value
- Grundstücksfläche:
plot_area
- Kaltmiete:
base_rent
- Kaufpreis:
price
- Preis:
object_price
- Fläche/qm:
price_per_sqm
- Status:
property_status_position
- Straße:
street_number.raw
- Verkaufsdatum:
sold_date
- Warmmiete:
total_rent
- Zimmer:
number_of_rooms
- Zuletzt bearbeitet:
updated_at
Mögliche Vermarktungsart (
marketing_type
): - 1.
BUY
- 2.
RENT
Mögliche Oberkategorie für Objekttypen
object_type
:- 1.
LIVING
- 2.
COMMERCIAL
- 3.
INVESTMENT
Mögliche Objekttypen (
rs_type
):- 1.
APARTMENT
- 2.
HOUSE
- 3.
TRADE_SITE
- 4.
GARAGE
- 5.
SHORT_TERM_ACCOMODATION
- 6.
OFFICE
- 7.
GASTRONOMY
- 8.
INDUSTRY
- 9.
STORE
- 10.
SPECIAL_PURPOSE
- 11.
INVESTMENT
(Text-)Felder, die in verschiedenen Sprachen hinterlegt werden können:
- title
- description_note
- location_note
- furnishing_note
- other_note
- long_description_note
- long_location_note
- long_furnishing_note
- long_other_note
- courtage
- courtage_note
Mögliche Objektarten (
rs_category
):ROOF_STOREY
- DachgeschossLOFT
- LoftMAISONETTE
- MaisonettePENTHOUSE
- PenthouseTERRACED_FLAT
- TerrassenwohnungGROUND_FLOOR
- ErdgeschosswohnungAPARTMENT
- EtagenwohnungRAISED_GROUND_FLOOR
- HochparterreHALF_BASEMENT
- SouterrainOTHER
- SonstigeSINGLE_FAMILY_HOUSE
- EinfamilienhausTWO_FAMILY_HOUSE
- ZweifamilienhausTERRACE_HOUSE
- ReihenhausMID_TERRACE_HOUSE
- ReihenmittelhausTERRACE_END_HOUSE
- ReihenendhausEND_TERRACE_HOUSE
- ReiheneckhausMULTI_FAMILY_HOUSE
- MehrfamilienhausTOWNHOUSE
- StadthausFINCA
- FincaFREEHOLD_FLAT
- EigentumswohnungBUNGALOW
- BungalowFARMHOUSE
- BauernhausSEMIDETACHED_HOUSE
- DoppelhaushälfteVILLA
- VillaCASTLE_MANOR_HOUSE
- Burg/SchlossSPECIAL_REAL_ESTATE
- Besondere ImmobilieTWIN_SINGLE_FAMILY_HOUSE
- DoppeleinfamilienhausGARAGE
- GarageSTREET_PARKING
- AußenstellplatzCARPORT
- CarportDUPLEX
- DuplexCAR_PARK
- ParkhausUNDERGROUND_GARAGE
- TiefgarageDOUBLE_GARAGE
- DoppelgarageNO_INFORMATION
- Keine AngabeSTUDIO
- AtelierOFFICE
- BüroOFFICE_FLOOR
- BüroetageOFFICE_BUILDING
- BürohausOFFICE_CENTRE
- BürozentrumOFFICE_STORAGE_BUILDING
- Büro-/ LagergebäudeSURGERY
- PraxisSURGERY_FLOOR
- PraxisetageSURGERY_BUILDING
- PraxishausCOMMERCIAL_CENTRE
- GewerbezentrumLIVING_AND_COMMERCIAL_BUILDING
- Wohn- und GeschäftsgebäudeOFFICE_AND_COMMERCIAL_BUILDING
- Büro- und GeschäftsgebäudeBAR_LOUNGE
- Barbetrieb/LoungeCAFE
- CaféCLUB_DISCO
- Club/DiskothekGUESTS_HOUSE
- GästehausTAVERN
- GaststätteHOTEL
- HotelHOTEL_RESIDENCE
- HotelanwesenHOTEL_GARNI
- Hotel garniPENSION
- PensionRESTAURANT
- RestaurantSHOWROOM_SPACE
- AusstellungsflächeSHOPPING_CENTRE
- EinkaufszentrumFACTORY_OUTLET
- Factory OutletDEPARTMENT_STORE
- KaufhausKIOSK
- KioskSTORE
- LadenSELF_SERVICE_MARKET
- SB-MarktSALES_AREA
- VerkaufsflächeSALES_HALL
- VerkaufshalleRESIDENCE
- AnwesenFARM
- BauernhofHORSE_FARM
- ReiterhofVINEYARD
- WeingutREPAIR_SHOP
- WerkstattLEISURE_FACILITY
- FreizeitanlageINDUSTRIAL_AREA
- GewerbeflächeSPECIAL_ESTATE
- SpezialobjektLIVING_BUSINESS_HOUSE
- Wohn- und GeschäftshausHOUSING_ESTATE
- WohnanlageMICRO_APARTMENTS
- Micro-ApartmentsCOMMERCIAL_BUILDING
- GeschäftshausSHOP_SALES_FLOOR
- Laden/VerkaufsflächeSUPERMARKET
- SupermarktRETAIL_PARK
- FachmarktzentrumBOARDING_HOUSE
- Boarding HouseCLINIC
- KlinikASSISTED_LIVING
- Betreutes WohnenHALL_STORAGE
- Halle/LogistikINDUSTRIAL_PROPERTY
- Produktion/Fertigung
post
https://api.propstack.de/v1
/units
Objekt anlegen
Beim Anlegen eines Objektes kann auch gleichzeitig ein Eigentümer mitverknüpft werden. Der Payload dafür sieht wie folgt aus:
{
"property": {
"title": "Nice apartment",
// ...
"relationships_attributes": [{
"internal_name": "owner",
"related_client_id": 123
}]
}
}
Der Eigentümer muss vorher in Propstack existieren. Die ID des Kontaktes wird dann unter
related_client_id
mitgegeben.Beim Anlegen eines Objektes kann auch gleichzeitig ein Kontakt (Partner) mitverknüpft werden. Der Payload dafür sieht wie folgt aus:
{
"property": {
"title": "Nice apartment",
// ...
"relationships_attributes": [{
"internal_name": "partner",
"name": "Käufer",
"related_client_id": 123
}]
}
}
Der Kontakt muss vorher in Propstack existieren. Die ID des Kontaktes wird dann unter
related_client_id
mitgegeben.put
https://api.propstack.de/v1
/units/:id
Objekt bearbeiten
delete
https://api.propstack.de/v1
/units/:id
Objekt löschen
get
https://api.propstack.de/v1
/units/:id?new=1
Objekt lesen
get
https://api.propstack.de
/v1/property_statuses
Objekt-Stati lesen
Last modified 2yr ago