Anschriften 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

Anschriften / Adressen (addrs) verhalten sich von den Actions (index, show, create, update, delete) her wie die Personen. Es stehen folgende Felder zur Verfügung:

Feldname Feldtyp Beschreibung
id INTEGER ID der Anschrift (Read only)
attachable_id INTEGER ID des verknüpften Objektes, Beispiel Person oder Firma.
attachable_type VARCHAR(20) Typ des verknüpften Objektes, Person oder Company.
atype VARCHAR(20) Typ der Anschrift, work_hq, work, invoice, delivery, private oder other.
primary BOOLEAN Setzt die primäre Anschrift mit true oder false.
street Text Straßenname(Pflichtfeld)
zip VARCHAR(10) Postleitzahl
city VARCHAR(120) Stadt
country VARCHAR(120) Land
created_at TIMESTAMP Zeitpunkt der Erstellung (automatisch gesetzt, read only)
updated_at TIMESTAMP Zeitpunkt des letzten Updates (automatisch gesetzt, read only)

Beispiel Action: Update

PUT /people/{id}/addrs/{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 ' {"addr":{"street":"Marktstraße 10 - Gebäude AU13","zip":"50968"}}'
https://accountname.centralstationcrm.net/api/people/{id}/addrs/{id}.json 

Status: 200 OK