Comment on page
Task
Task ist ein Sammelbegriff, welches mehrere Arten von Aktivitäten bezeichnet.
Ein Task kann mehreres sein: Eine Notiz, eine Aufgabe, ein Termin, ein Brief, eine SMS, eine Absage, eine Anfrage.
Attribut | Typ | Beschreibung |
title | string | Titel |
note_type_id | integer | Aktivitätstyp (alle bis auf E-Mail-Typen) |
body | string | Notizfeld für weitere Bemerkungen als HTML |
client_ids | integer[] | Ein Array von Kontakt-IDs mit welcher die Aktivität verknüpft werden soll. In der Regel will man nur eine Kontakt-ID mitgeben |
property_ids | integer[] | Ein Array von Objekt-IDs, womit die Aktivität verknüpft werden soll. |
project_ids | integer[] | Ein Array von Projekt-IDs, womit die Aktivität verknüpft werden soll. |
broker_id | integer | Nutzer, dem der Task zugewiesen werden soll |
task_creator_id | integer | Ersteller des Tasks |
task_updater_id | integer | der Nutzer, der den Task zuletzt bearbeitet hat |
Attribut | Typ | Beschreibung |
is_reminder | boolean | muss true sein |
due_date | date | Datum + Uhrzeit der Fälligkeit der Aufgabe |
remind_at | date | Datum (vor dem due_date), wann der Zugewiesene erinnert werden soll (in Form einer E-Mail) |
done | boolean | Ist die Aufgabe erledigt? |
Attribut | Typ | Beschreibung |
is_event | boolean | muss true sein |
starts_at | date | Beginn des Termins |
ends_at | date | Ende des Termins |
private | boolean | Soll der Termin nur für die Teilnehmer sichtbar sein? |
all_day | boolean | Ganztägiger Termin? |
location | string | Ort des Termins |
recurring | boolean | Wiederkehrender Termin? |
rrule | string | bei wiederkehrenden Terminen der String, welcher die Regeln festlegt, in welchem Interval der Termin stattfindet. Mehr Infos hier |
- 1.clients
- 2.units (Property)
- 3.projects
- 4.broker
- 5.task_creator
- 6.note_type
- 7.attachments
Attribut | Typ | Beschreibung |
id | integer | Unique ID des Anhanges |
name | string | Name des Anhanges |
url | string | URL zum Anhang (nur für wenige Minuten gültig) |
post
http://api.propstack.de/v1
/tasks
Task erstellen
Beispiel-Request zum Anlegen eines Termins:
{
"task": {
"is_event": true,
"title": "Besichtigungstermin",
"note_type_id": 123,
"client_ids": [10002],
"property_ids": [1004],
"location": "Musterstraße 123, 12345 Berlin",
"starts_at": "2020-02-20T14:00:00+01:00",
"ends_at": "2020-02-20T14:30:00+01:00"
}
}
Beispiel-Request zum Anlegen einer Aufgabe:
{
"task": {
"is_reminder": true,
"title": "Propstacks Dokumenation verstehen",
"note_type_id": 503,
"client_ids": [50002],
"property_ids": [5004],
"due_date": "2020-02-20T09:00:00+01:00"
}
}
Beispiel-Request zum Anlegen einer Notiz:
{
"task": {
"title": "Anfrage über die Webseite",
"note_type_id": 720,
"client_ids": [2006],
"property_ids": [7006],
"body": "Folgender Interessent hat angefragt:<br>Name: Hans Peter<br>Email..."
}
}
Last modified 3yr ago