Dokumente

Dokumente sind Dateien, die entweder zu einem Projekt, einem Objekt oder einem Kontakt gehören

get
Dokumente lesen

https://crm.propstack.de/api/v1/documents
Die Dokumente werden paginiert.
Request
Response
Request
Query Parameters
order_by
optional
string
Sortierung der Ergebnismenge. Standard position,asc. Um nach Erstellungsdatum absteigend zu sortieren: created_at,desc
tag
optional
string
ein Schlagwort, welches das Dokument haben muss
is_private
optional
boolean
mögliche Werte: true oder false
client
optional
integer
ID des verknüpften Kontaktes
property
optional
integer
ID des verknüpften Objektes
project
optional
integer
ID des verknüpften Projektes
Response
200: OK
{
"documents": [
{
"id": 11,
"token": "1hw4mBZRnFrnitGUbj5jL4Rt",
"title": "grundriss.pdf",
"name": "grundriss.pdf",
"url": "...",
"position": 1,
"broker_id": 1,
"is_private": true,
"on_landing_page": true,
"is_exposee": false,
"second_document": null,
"is_floorplan": true,
"tags": [],
"created_at": "2019-11-12T14:56:25.140+01:00",
"updated_at": "2019-11-12T15:16:28.348+01:00"
}
],
"meta": {
"total_count": 1
}
}

post
Dokument erstellen

https://crm.propstack.de/api/v1/documents
Alle Parameter in einem document Objekt umschlossen werden. Ein Dokument sollte mit entweder einem Objekt, einem Projekt, oder einem Kontakt verknüpft werden, und keine Kombination der 3.
Request
Response
Request
Body Parameters
tags
optional
array
Nicht bereits vorhandene Tags werden automatisch neu angelegt
on_landing_page
optional
boolean
Soll das Dokument als Landing Pages angezeigt werden? Nur bei Projekten/Objekten sinnvoll
is_floorplan
optional
boolean
Handelt es sich bei dem Dokument um ein Grundriss?
is_exposee
optional
boolean
Soll das Dokument als das PDF-Exposé benutzt werden? Nur sinnvoll, wenn Dokument mit Projekt oder Objekt verknüpft ist
client_id
optional
integer
ID des Kontaktes, womit es verknüpft werden soll
project_id
optional
integer
ID des Projektes, womit es verknüpft werden soll
property_id
optional
integer
ID des Objektes, womit es verknüpft werden soll
doc
required
string
die eigentliche Datei, Base64 kodiert
title
optional
string
eigener Name für das Dokument, falls nicht der Dateiname benutzt werden soll
Response
200: OK

Body einer Beispiel-Anfrage

Es wird ein Dokument für das Objekt mit der ID 123 angelegt, was nur ein oranger Pixel ist:

{
"document": {
"property_id": 123,
"title": "orange-pixel.png",
"doc": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8v5vhPwAHNgK7sbW2nQAAAABJRU5ErkJggg=="
}
}

put
Vorhandenes Dokument aktualisieren

https://crm.propstack.de/api/v1/documents/:id
Die gleichen Parameter im POST können auch im PUT verändert werden
Request
Response
Request
Response
200: OK
{
"id": 12,
"token": "zxydpZE62eZ3GcEQSCN84bwT",
"title": "Exposé.pdf",
"name": "Exposé.pdf",
"url": "...",
"position": 1,
"broker_id": 1,
"is_private": true,
"on_landing_page": true,
"is_exposee": false,
"second_document": null,
"is_floorplan": false,
"tags": [],
"created_at": "2019-11-12T15:16:02.048+01:00",
"updated_at": "2020-01-14T17:27:17.818+01:00"
}

get
Tags auslesen

https://crm.propstack.de/api/v1/documents/tags
Alle möglichen Tags auslesen, die ein Dokument haben kann.
Request
Response
Request
Response
200: OK
{
"data": [
"Energieausweis"
],
"meta": {
"total_count": 1
}
}