Kontaktdaten in CentralStationCRM

API Navigation

Allgemeines: Grundlagen Authentifizierung Fehlerbehandlung Datenstruktur

Hauptmodelle: Personen Firmen Angebote Projekte Aufgaben

Sonstiges: Anschriften Kontaktdaten Wichtige Daten Individuelle Felder Positionen Notizen Dateianhänge Tags

Die Kür: Webhooks Nutzer Aktivitäten Filter Gruppen Individuelle Feld Typen

Kontaktdaten / contact_details verhalten sich von den Actions (index, show, create, update, delete) her wie die Personen. Die contact_details gruppieren die Unterelemente tel (Telefonnummer), email (E-Mail Adressen), tweet (Twitter Accounts), im, (Instant Messenger), sm (Social Media), homepage (Homepages). Es stehen folgende Felder zur Verfügung:

Feldname Feldtyp Beschreibung
id INTEGER ID des contact_details (Read only)
type VARCHAR(20) Typ des contact_details, z.B. Email, Im (Instant Messenger), Sm (Social Media), Tel oder Homepage.
attachable_id INTEGER ID des verknüpften Objektes, zum Beispiel Person oder Firma.
attachable_type VARCHAR(20) Typ des verknüpften Objektes, z.B. Person oder Company.
atype VARCHAR(20) Weiterer Typ des contact_details, z.B. für eine Telefonnummer (office office_hq mobile fax private voip skype other). (Pflichtfeld)
name VARCHAR(255) Name / Inhalt des contact_details (Pflichtfeld)
created_at TIMESTAMP Zeitpunkt der Erstellung (automatisch gesetzt, read only)
updated_at TIMESTAMP Zeitpunkt des letzten Updates (automatisch gesetzt, read only)

Beispiel Action: Create

POST /people/{id}/contact_details.json
Eine neue E-Mail Adresse (oder ein anderes contact_detail) kann mit der Action create angelegt werden. Im positiven Fall liefert das System das neue contact_detail zurück. Zum Anlegen ist die Übergabe von name und atype Pflicht.

Beispiel
curl -v -H "Accept: application/json" -H "Content-type: application/json" 
-X POST -d '{"email":{"atype":"office","name":"test@test.de"}}'
https://api.centralstationcrm.net/api/people/506201/contact_details.json 

{"email":{"id":4079954,"attachable_type":"Person","attachable_id":455636,
"atype":"office","primary":null,"name":"test@test.de","name_clean":null,
"created_at":"2015-07-20T17:17:58.008+02:00","updated_at":"2015-07-20T17:17:58.008+02:00",
"api_input":true}}

Beispiel Action: Update

PUT /people/{id}/contact_details/{id}.json
Für die Update Action ist das Verb PUT erforderlich und die Route muss die ID des zu bearbeitenden Elementes, sowie die ID des Mutterobjektes (Person oder Firma) erhalten. Die Rückgabe ist hier nicht das Element selber, sondern der Header :ok mit dem HTTP Code 200.

Beispiel
curl -v -H "Accept: application/json" -H "Content-type: application/json" 
-X PUT -d ' {"contact_detail":{"name":"+49 (0)221-291997-86"}}'
https://accountname.centralstationcrm.net/api/people/:person_id/contact_details/{id}.json 

Status: 200 OK

Kontaktdaten Sonderfunktionen

Action: Search

GET /contact_details/search.json?type=people&name=04721
Um anhand eines Contact Details (E-Mail Adresse, Telefonnummer, Homepage oä) nach Personen oder Firmen zu suchen können die Parameter name übergeben werden. Außerdem kann über den Parameter type angegeben werden, ob Personen (type=people) oder Firmen (type=companies) durchsucht werden sollen. Standard ist die Suche nach Personen. Wenn ein oder mehrere Treffer gefunden wurden erfolgt die Rückgabe in gleicher Form, wie bei der Personen/Firmen Index Funktion. Wenn keine Treffer gefunden wurden geben wir einen leeren Array zurück.