ProSonata API
Folgende HTTP-Methoden stehen für CRM Ereignisse zur Verfügung:
Zugriff nur bei aktivem Erweiterungsmodul »CRM«.
Zugriff nur für Benutzer der Gruppen CRM-Erfasser, Zeiterfasser 2 und höher.
Nur Benutzer ab der Gruppe Verwaltung können CRM Ereignisse löschen.
GET /api/v1/crmevents
Antwort:
{
"meta": {
"status": 200,
"perPage": 100,
"page": 1,
"totalCount": 511,
"requestUserID": 1,
"requestUsername": "Admin1",
"usergroupName": "Administrator",
"apiLimitRemaining": 348,
"apiLimitReset": 619
},
"data": [
{
"eventID": 4,
"contactID": 102,
"title": "Herr",
"firstName": "Jan",
"lastName": "Müller",
"email": "jm@test.de",
"telephone": "06123 1234567",
"customerName": "Auto Müller",
"name1": "Autohaus Müller GmbH",
"name2": "",
"name3": "",
"street": "Bahnhofstraße",
"streetNo": "7",
"postalCode": "61231",
"city": "Wiesbaden",
"country": "",
"createdByUserID": 1,
"username": "Admin1",
"showToUsergroup": null,
"eventDate": "2022-06-05",
"eventTime": "14:09:18",
"eventNote": "<p>Hier stehen ausführliche Infos zum Ereignis</p>",
"media": 0,
...
},
...
]
}
Über Parameter kann gefiltert werden:
GET /api/v1/crmevents?contactID=4&eventDate=2022-06-04
| Parameter | Beschreibung |
|---|---|
| contactID | ID eines Ansprechpartners |
| firstName | Vorname eines Ansprechpartners |
| lastName | Nachname eines Ansprechpartners |
| customerID | ID einer Firma/Gruppe |
| customerName | Bezeichnung einer Firma/Gruppe |
| name1 | Firmierung 1 der Firmenadresse |
| name2 | Firmierung 2 der Firmenadresse |
| showToUsergroup | auf Benutzergruppen beschränkte Ereignisse 1 = Teamleiter und höher 2 = Verwaltung und höher 3 = Administratoren |
| eventDate | Datum des Ereignisses durch Angabe von > oder < vor dem Datum kann eine Suche ab dem bzw. bis zum Datum erfolgen |
| media | das Medium des Ereignisses 0 = E-Mail 1 = Telefon 2 = Newsletter 3 = Social Media 10 = Brief 11 = Mailing 15 = Meeting 20 = Sonstige |
| projectID | ID eines Projekts |
| projectNo | Projektnummer |
| projectName | Bezeichnung eines Projekts |
| eventPrio | Priorität eines Ereignisses 5 = normal 1 = niedrig 9 = hoch |
| crmTags | Tag eines Ereignisses |
| followUpDate | Datum der Wiedervorlage durch Angabe von > oder < vor dem Datum kann eine Suche ab dem bzw. bis zum Datum erfolgen |
| followUpUser | Wiedervorlagen für einen Benutzer (ID des Benutzers) Sonderwert: String »myself« für Wiedervorlagen des anfragenden Benutzeraccounts |
| followUpDone | Wiedervorlage ist erledigt 0 = nein 1 = ja |
Nach folgenden Parametern kann sortiert werden (Sortierrichtung ggf. mit ASC bzw. DESC ergänzen):
eventID, contactID, eventDate, createdByUserID, eventPrio, followUpDate, followUpUser, followUpDone
GET /api/v1/crmevent/{id}
Antwort:
{
"meta": {
"status": 200,
"requestUserID": 1,
"requestUsername": "Admin1",
"usergroupName": "Administrator",
"apiLimitRemaining": 192,
"apiLimitReset": 533
},
"data": {
"eventID": 15,
"contactID": 53,
"title": "Frau",
"firstName": "Christiane",
"lastName": "Maier",
"email": "c.maier@beckermode.de",
"telephone": "01334 12345678",
"customerID": 12,
"customerName": "Versandmode Becker",
"name1": "Versandmode Becker KG",
"name2": "Your Fashion Today",
"name3": "",
"street": "Fabrikstraße",
"streetNo": "65",
"postalCode": "12345",
"city": "Nähstadt",
"country": "",
"createdByUserID": 1,
"username": "Admin1",
"showToUsergroup": null,
"eventDate": "2022-11-10",
"eventTime": "09:46:41",
"eventNote": "<p>Hier steht eine ausführliche Information zum Ereignis</p>",
"media": 0,
"projectID": null,
"projectNo": null,
"projectName": null,
"eventPrio": 5,
"crmTags": "",
"followUpDate": null,
"followUpTime": null,
"followUpUser": null,
"followUpUsername": "",
"followUpNote": "",
"followUpDone": 0,
"eventViaApi": 0
}
}
POST /api/v1/crmevents
Notwendige und mögliche Parameter im Body:
| Parameter | Beschreibung | Typ | Default-Wert | Pflichtfeld |
|---|---|---|---|---|
| contactID | ID des Ansprechpartners | Int | ja | |
| eventDate | Datum des Ereignisses | Date | ja | |
| eventTime | Uhrzeit des Ereignisses | Time | 09:00:00 | |
| showToUsergroup | Ansicht auf Benutzergruppen beschränkt 1 = Teamleiter und höher 2 = Verwaltung und höher 3 = Administratoren null = alle |
Int | null | |
| media | das Medium des Ereignisses 0 = E-Mail 1 = Telefon 2 = Newsletter 3 = Social Media 10 = Brief 11 = Mailing 15 = Meeting 20 = Sonstige |
Int | 0 | |
| eventNote | Notiz/Info zum Ereignis (html Tags sind erlaubt) |
String | ||
| projectID | ID eines zugehörigen Projekts | Int | null | |
| eventPrio | Priorität des Ereignisses 5 = normal 1 = niedrig 9 = hoch |
Int | 5 | |
| crmTags | Tags zum Ereignis (mehrere kommasepariert möglich) |
String | ||
| followUpDate | Datum der Wiedervorlage (aktiviert die Wiedervorlagenfunktion) |
Date | null | |
| followUpTime | Uhrzeit der Wiedervorlage | Time | null | |
| followUpUser | Wiedervorlagen für Benutzer mit ID | Int | null | |
| followUpNote | Notiz zur Wiedervorlage (keine html Tags) |
String |
Beispiel:
{
"contactID": 124,
"eventDate": "2022-11-13",
"eventTime": "11:30:00",
"eventNote": "<p>Hier steht eine <strong>Info</strong> zum Ereignis</p>",
"media": 1,
"followUpDate": "2022-12-08",
"followUpUser": 3,
"followUpNote": "eine Info zur Wiedervorlage"
}
PUT /api/v1/crmevents/{id}
Es müssen nicht alle Parameter für eine Bearbeitung übergeben werden.
Es stehen die Parameter zum Erstellen der Ressource zur Verfügung (s.o.).
Ergänzend stehen weitere Parameter zur Verfügung:
| Parameter | Beschreibung | Typ |
|---|---|---|
| followUpDone | erledigt 0 = nein 1 = ja |
Int |
DELETE /api/v1/crmevents/{id}
Es müssen keine weiteren Parameter übergeben werden.