Aktivitäten
Aktivitäten können nicht direkt angelegt werden, sondern werden intern durch PS angelegt. Um eine Aktivität anzulegen, muss man entweder eine Message oder einen Task direkt anlegen.
Typ | Beschreibung |
Message | Ein- und ausgehende E-Mails |
Task | Mit Task sind diverse Aktivitätstypen gemeint, wie Notizen, Aufgaben, Termine, Briefe |
Policy | Policies sind Nachweise über die Widerrufsbelehrung oder Kontakterlaubnis. Mehr Infos gibt es hier. |
getAktivitäten lesen
message, note, reminder, event, policy{"data": [{"id": 123,"broker_id": 12,"client_ids": [123401],"property_ids": [4321],"project_ids": [],"client_names": ["Stefanie Mante"],"property_names": ["CLA-1050"],"project_names": [],"conversation_type": "note","sender_type": null,"source_id": null,"creator_id": 123,"category_id": null,"reason_id": null,"created_at": "2019-01-15T01:22:37.619+01:00","starts_at": null,"price": null,"group_ids": [],"state": "neutral","title": "Eingehender Anruf um 18:00","access_broker_ids": null,"access_department_ids": null,"blocked": false,"comments_count": 0,"attachments_count": 0,"done": false,"outgoing": false,"tracking_size": 0,"unread_tracking_size": 0,"attachments": 0,"comment_size": 0},],"meta": {"total_count": 10205}}
Aktivitäten lassen sich paginieren über die Parameter page und per. Standardmäßig werden die ersten 20 Aktivitäten angezeigt.
getEinzelne Aktivität lesen
{"id": 41711,"activatable_type": "Task","activatable": {// je nachdem was activatable_type ist,// .. kommt hier das Objekt zur E-Mail oder zum Task}}
In der Regel möchte man eine einfache Notiz anlegen, welches in Propstacks API ein "Task" wäre. Die Beschreibung für einen Task sieht wie folgt aus:
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 |
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 |
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 |
Attribut | Typ | Beschreibung |
client_source_id | integer | ID der Anfrage-Quelle |
getAktivitätstypen lesen
{"data": [{"id": 35,"name": "Anfrage","category": "message"},{"id": 38,"name": "Angebot","category": "message"},{"id": 102,"name": "Notartermin","category": "event"},{"id": 386,"name": "Marketing: Mailing","category": "note"},{"id": 73,"name": "Anruf","category": "reminder"}]}
