Cobai V2 API
Cobai V2 API
Breadcrumbs

Kontakte anlegen

Beschreibung

Mit dieser Methode können Sie neue Kontakte für einen vorhandenen Kunden anlegen.

Anfrage

Syntax 

POST /v2/customer/<UUID_des_Kunden>/contact HTTP/1.1
Host: api.cobai.com
Date: Datum/Uhrzeit
Content-Length: Länge
Content-Type: application/xml
Authorization: Signatur

Request-Parameter

Diese Methode benutzt keine zusätzlichen Request-Parameter

Request-Header

Diese Methode benutzt zusätzlich zu den Standard-Requestheadern keine weiteren Header.

Request-Body

Im Request-Body erwartet die Methode ein XML-Dokument mit den Daten des anzulegenden Kontaktes innerhalb des Root-Elements <contact/>. Die folgenden Felder können übergeben werden:

Feldname

Pflicht

Typ

Bemerkung

gender



Geschlecht des Kontaktes, beachten Sie hierzu auch die Hinweise zu Geschlechtsangaben.

firstName


C(35)


lastName


C(35)


officePhone


C(30)


officeFax


C(30)


officeMobile


C(30)


officeMail


C(200)


webUserName


C(80)


webPassword


C(50)

Übergeben Sie das Passwort als Klartext. {::nomarkdown}

Wir speichern nur einen Hash des Passwortes, Sie können es also nachfolgend nicht wieder auslesen.

{:/}

role



Die Nutzerrolle des anzulegenden Kontaktes. Bitte beachten Sie hierzu die Hinweise zu Benutzerrollen.

ignoreAssortment



true wenn für diesen Kontakt Sortimente ignoriert werden sollen, sonst false.

Antwort

Erfolgsfall

Im Erfolgsfall wird im Zielsystem ein neuer Kontakt angelegt. Sie erhalten als Antwort HTTP-Status 201 Created, einen Location-Header mit der Url des Kontaktes sowie ein Antwortdokument mit den gespeicherten Kontaktdaten.

Fehlerfall

Im Fehlerfall wird kein neuer Kontakt angelegt. Sie erhalten als Antwort HTTP-Status 400 Bad Request und ein BadRequest Antwort-Dokument.

Antwortheader

Location : Im Location-Header erhalten Sie die URL des neu angelegten Kontaktes.

Antwortdokument

Als Antwort auf die Anfrage erhalten sie ein Antwortdokument mit folgendem Inhalt:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<contact xmlns:atom="http://www.w3.org/2005/atom">
    <firstName>Rico</firstName>
    <gender>MALE</gender>
    <ignoreAssortment>false</ignoreAssortment>
    <lastName>Blaa</lastName>
    <officeFax></officeFax>
    <officeMail>rico@blaa.de</officeMail>
    <officeMobile></officeMobile>
    <officePhone></officePhone>
    <role>ROLE_SHOP_COSTCENTER_USER</role>
    <atom:link rel="self" href="http://api.cobai.com/v1/customer/b00de3c0-f685-42d5-92b5-c46f04803c8f/contact/683aacec-1225-4fe5-a71b-cbb0010fe1eb"/>
    <uuid>683aacec-1225-4fe5-a71b-cbb0010fe1eb</uuid>
    <webUserName>rico</webUserName>
</contact>

Die UUID des Kontaktes ist sein eindeutiger Schlüssel. Speichern Sie die UUID oder die vollständige Url aus dem Location-Header in Ihrem System, ohne sie können Sie keine Änderungen an dem gerade angelegten Kontakt vornehmen.