Projekte

Projekte sind als "Über-Objekte" zu verstehen. Ein Projekt umfasst in der Regel mehrere Objekte, auch Einheiten genannt.

Project Schema

Field Name	Field Type	Description
name	string	The name of the project.
status	enum	one of: ACQUISITION PROGRESS SALES SOLD
note	string
warning_notice	string	Shown in the project as a red warning bar
broker_id	integer	Reference who is responsible for the project. See "Nutzer" table
title	string	headline for the exposé
for_rent	boolean	to be marked as a project for rental properties
street	string
house_number	string
zip_code	string
city	string
lat	float	latitude
lng	float	longitude
location_id	integer	see "Geolagen" table
courtage	string
courtage_note	string
description_note	string
location_note	string
furnishing_note	string
construction_year	integer

Projekte abrufen

GET https://api.propstack.de/v1/projects

Mit diesem Endpoint erhältst du alle Projekte des Unternehmens.

Path Parameters

Name	Type	Description
expand	string	Wert ist egal, z.B. 1. Wenn der Parameter gesetzt ist, werden die erweiterten Daten zurückgegeben, wie wenn man ein einzelnes Projekt aufruft.

200 successfully retrieved.

[
  {
    "id": 23,
    "title": "Living Home",
    "status": {
      "label": "Vertrieb",
      "color": "#123123"
    },
    "broker_id": 66,
    "title_image": {
      "url": "https://...jpg",
      "square_url": "https://...jpg"
    },
    "project_id": "LH",
    "sub_headline": null,
    "tagline": null,
    "logo_url": "https://...jpg",
    "street": "Hauptstraße",
    "house_number": "12",
    "sublocality_level_1": "Kreuzberg",
    "zip_code": "12345",
    "city": "Berlin",
    "address": "Hauptstraße 12, 12345 Berlin, Deutschland",
    "lat": 13.4483934,
    "lng": 49.3483043,
    "hide_address": false,
    "custom_fields": {}
  }
]

Create a Project

POST https://api.propstack.de/v1/projects

Request Body

Name	Type	Description
project	object	See project schema

Response

201 Created

{
  "ok": true,
  "id": 24
}

Projekt abrufen

GET https://api.propstack.de/v1/projects/:id

Path Parameters

Name	Type	Description
id	number	ID des Projektes

200

{
  "id": 23,
  "title": "Living Home",
  "status": {
    "label": "Vertrieb",
    "color": "#123123"
  },
  "broker_id": 66,
  "title_image": {
    "url": "https://...jpg",
    "square_url": "https://...jpg"
  },
  "project_id": "LH",
  "sub_headline": null,
  "tagline": null,
  "logo_url": "https://...jpg",
  "street": "Hauptstraße",
  "house_number": "12",
  "sublocality_level_1": "Kreuzberg",
  "zip_code": "12345",
  "city": "Berlin",
  "address": "Hauptstraße 12, 12345 Berlin, Deutschland",
  "lat": 13.4483934,
  "lng": 49.3483043,
  "hide_address": false,
  "custom_fields": {},
  "description_note": "...",
  "location_note": "...",
  "images": [
    {
      "id": 123,
      "is_floorplan": false,
      "is_private": true,
      "title": "Schlafzimmer",
      "url": "https://...",
      "square_url": "https://..."
    }
  ],
  "floorplans": [
    {
      "id": 123,
      "title": "Grundriss",
      "url": "https://..."
    }
  ],
  "documents": [
    {
      "id": 123,
      "title": "Dokument A",
      "is_private": true,
      "url": "https://..."
    }
  ],
  "links": [
    {
      "id": 123,
      "title": "Homepage",
      "url": "https://..."
    }
  ]
}

Update a Project

PUT https://api.propstack.de/v1/projects/:id

Path Parameters

Name	Type	Description
id	number	ID of the project to update.

Request Body

Name	Type	Description
project	object	See project schema

Response

200 OK

{
  "id": 24,
  "title": "Updated Project",
  ...
}