Notizen 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

Notizen verfügen als vererbte Elemente über die Actions index, show, create, update und delete. Es stehen folgende Felder zur Verfügung:

Feldname Feldtyp Beschreibung
id INTEGER ID der Notiz (Read only)
account_id INTEGER ID des Accounts (Read only, automatisch gesetzt)
user_id INTEGER ID des Users (Read only, automatisch gesetzt)
person_ids ARRAY IDs der verknüpften Personen
company_ids ARRAY IDs der verknüpften Firmen
name VARCHAR(60) Anriss der Notiz (automatisch gesetzt)
content TEXT Inhalt der Notiz (Pflichtfeld)
confidential BOOLEAN True, wenn die Notiz vertraulich ist.
type VARCHAR(20) ObjectNote, wenn die Notiz zu einer Person, einem Angebot oder einem Projekt gehört. Bei Status Nachrichten eines Nutzers UserNote
badge VARCHAR(20) Art der Notiz (note, call, email, meeting, other oder research bei Firmen / companies)
created_at TIMESTAMP Zeitpunkt der Erstellung (automatisch gesetzt, read only)
updated_at TIMESTAMP Zeitpunkt des letzten Updates (automatisch gesetzt, read only)
Beispiel für das Anlegen eines neuen Protocols über JSON an eine Person
curl -v -H "Accept: application/json" -H "Content-type: application/json" 
-X POST -d '{"protocol":{"name":"jolly sagt","content":"mäh"}}'
https://accountname.centralstationcrm.net/api/people/:person_id/protocols.json

Der Server gibt dann das erstellte Objekt zurück:
    
{
"protocol":
{
"name":"jolly sagt",
"created-at":"2012-06-29T16:49:07+02:00",
"updated-by-user-id":null,
"updated-at":"2012-06-29T16:49:07+02:00",
"account-id":849,
"id":310061,
"user-id":1,
"content":"mäh",
"badge":"Notiz",
"mailmeta":null,
"confidential":null
}
}