Merkmale

Merkmale kann man als "Tags" verstehen, welche man Kontakten, Objekten oder Aktivitäten geben kann, um sie später danach filtern zu können.

get
Merkmale abrufen

https://api.propstack.de/v1/groups
Hier werden alle Merkmale entweder von Kontakten, Objekten oder Aktivitäten zurückgegeben. Wenn kein Wert unter entity angegeben wird, dann werden standardmäßig nur die Merkmale der Kontakte zurückgegeben.
Request
Response
Request
Query Parameters
super_group
optional
integer
ID der Oberkategorie
entity
required
string
Eines von for_clients, for_properties, oder for_activities. Default: for_clients
Response
200: OK
[
{
"id": 100,
"name": "Eigentümer",
"super_group_id": 99
}
]

post
Merkmal erstellen

https://api.propstack.de/v1/groups
Request
Response
Request
Body Parameters
super_group_id
optional
integer
ID der Oberkategorie (auch ein Merkmal)
entity
required
string
Eines von for_clients, for_properties oder for_activities.
name
required
string
Name des Merkmals. Es darf kein anderes Merkmal mit dem gleichen Namen geben.
Response
200: OK

get
Obermerkmale lesen

https://api.propstack.de/v1/super_groups
Request
Response
Request
Query Parameters
entity
optional
string
eines von for_clients, for_properties, for_activities
include
optional
string
kann den Wert groups haben, um die Merkmale mitzuliefern
Response
200: OK
Antwort, wenn man include=groups mitgibt. Ansonsten fehlt das Attribut groups
{
"data": [
{
"id": 1,
"name": "Berufe",
"entity": "for_clients",
"groups": [
{
"id": 1789,
"name": "Architekt",
"super_group_id": 1
},
{
"id": 1802,
"name": "Designeer",
"super_group_id": 1
}
]
}
]
}