Alle Kontakte eines Kunden auflisten
GET /api/contacts?client_id={client_id}
Kontakte können immer nur für einen bestimmten Kunden zurückgegeben werden.
Deshalb ist client_id ein Pflichtparameter.
<?xml version="1.0" encoding="UTF-8"?>
<contacts type="array" page="1" per_page="100" total="2">
<contact>
...
</contact>
<contact>
...
</contact>
</contacts>
Einzelnen Kontakt aufrufen
GET /api/contacts/{id}
<?xml version="1.0" encoding="UTF-8"?>
<contact>
<id type="integer">4</id>
<client_id type="integer">134432</client_id>
<name></name>
<salutation>Frau</salutation>
<first_name>Erika</first_name>
<last_name>Mustermann</last_name>
<street></street>
<zip></zip>
<city></city>
<state></state>
<country_code></country_code>
<phone></phone>
<fax></fax>
<mobile></mobile>
<email>e.mustermann@example.com</email>
<www></www>
</contact>
Kontakt erstellen
POST /api/contacts
XML-Element |
Beschreibung |
Typ |
Default-Wert |
Pflichtfeld |
client_id |
ID des Kunden |
INT |
|
ja |
label |
Bezeichnung |
ALNUM |
|
|
name |
Firmenname |
ALNUM |
|
|
street |
Straße |
ALNUM |
|
|
zip |
PLZ |
ALNUM |
|
|
city |
Ort |
ALNUM |
|
|
state |
Bundesland, Bezirk, Region |
ALNUM |
|
|
country_code |
Land |
Ländercode nach ISO 3166 Alpha-2 |
|
|
first_name |
Vorname |
ALNUM |
|
|
last_name |
Nachname |
ALNUM |
|
|
salutation |
Anrede |
ALNUM |
|
|
phone |
Telefon |
ALNUM |
|
|
fax |
Fax |
ALNUM |
|
|
mobile |
Mobiltelefon-Nummer |
ALNUM |
|
|
email |
E-Mail |
gültige E-Mail-Adresse |
|
|
www |
Website |
URL (ohne http) |
|
|
Bei leeren Werten wird der Wert des Kunden übernommen.
<contact>
<client_id type="integer">134432</client_id>
<name></name>
<salutation>Frau</salutation>
<first_name>Erika</first_name>
<last_name>Mustermann</last_name>
<street></street>
<zip></zip>
<city></city>
<state></state>
<country_code></country_code>
<phone></phone>
<fax></fax>
<mobile></mobile>
<email></email>
<www></www>
</contact>
<?xml version="1.0" encoding="UTF-8"?>
<contact>
<id type="integer">4</id>
<created type="datetime">2013-05-27T12:07:37+02:00</created>
<client_id type="integer">134432</client_id>
<name></name>
<salutation>Frau</salutation>
<first_name>Erika</first_name>
<last_name>Mustermann</last_name>
<street></street>
<zip></zip>
<city></city>
<state></state>
<country_code></country_code>
<phone></phone>
<fax></fax>
<mobile></mobile>
<email></email>
<www></www>
</contact>
Kontakt bearbeiten
PUT /api/contacts/{id}
Hier gelten die selben Parameter wie beim Anlegen.
<contact>
<first_name>Hans</first_name>
<last_name>Mustermann</last_name>
</contact>
Kontakt löschen
DELETE /api/contacts/{id}
Kontaktbild aufrufen
GET /api/contacts/{id}/avatar?size={size}
Liefert das Kontaktbild für den Kontakt mit der übergebenen ID. Das Bild wird quadratisch zugeschnitten. Die Größe in Pixel kann über den Paramater size angegeben werden.