Skip to content

MitarbeiterWebservice - Kundenverwaltung

Funktionen

Name HTTP Eingabe Ausgabe
addKunde POST ${pfad}/{$ma}/kunden JSON Kunde JSON Kunde
getKunde GET ${pfad}/{$ma}/kunden/${Kunde-Id} JSON Kunde
setKunde PUT ${pfad}/{$ma}/kunden/${Kunde-Id} JSON Kunde JSON Kunde
getKundenAdressen GET ${pfad}/{$ma}/kunden/${Kunde-Id}/adressen JSON ArrayOf Adresse
addKundenAdresse POST ${pfad}/{$ma}/kunden/${Kunde-Id}/adressen JSON Adresse JSON Adresse
setKundenAdresse PUT ${pfad}/{$ma}/kunden/${Kunde-Id}/adressen/${Adresse-Id} JSON Adresse JSON Adresse
deleteKundenAdresse DELETE ${pfad}/{$ma}/kunden/${Kunde-Id}/adressen/${Adresse-Id}
getKundenKontaktdaten GET ${pfad}/{$ma}/kunden/${Kunde-Id}/kontaktdaten JSON ArrayOf Kontaktdatensatz
addKundenKontaktdatensatz POST ${pfad}/{$ma}/kunden/${Kunde-Id}/kontaktdaten JSON Kontaktdatensatz JSON Kontaktdatensatz
setKundenKontaktdatensatz PUT ${pfad}/{$ma}/kunden/${Kunde-Id}/kontaktdaten/${Kontaktdatensatz-Id} JSON Kontaktdatensatz JSON Kontaktdatensatz
deleteKundenKontaktdatensatz DELETE ${pfad}/{$ma}/kunden/${Kunde-Id}/kontaktdaten/${Kontaktdatensatz-Id}
getKundenVertraege GET ${pfad}/{$ma}/kunden/${Kunde-Id}/vertraege JSON ArrayOf Vertrag
getKundenDokumente GET ${pfad}/{$ma}/kunden/${Kunde-Id}/dokumente JSON ArrayOf Archiveintrag
getKundenArchiveintraege GET ${pfad}/{$ma}/kunden/${Kunde-Id}/archiveintraege JSON ArrayOf Archiveintrag
searchKunden GET ${pfad}/{$ma}/kunden/_search?q=${SuchText}&from=${Einträge-Von}&size=${Einträge-Maximal} JSON ArrayOf KundenSuchErgebnis
searchKunden POST ${pfad}/{$ma}/kunden/_search?q=${SuchText}&from=${Einträge-Von}&size=${Einträge-Maximal} JSON SearchQuery JSON ArrayOf KundenSuchErgebnis
sendUnterschrifftenlink GET ${pfad}/{$ma}/kunden/unterschriftenlinks/_senden JSON SendeUnterschrifftenlinkAuftrag JSON Meldungen

addKunde

Legt einen neuen Kunden an.
☛ Es werden derzeit nur Id & Benutzername des neu angelegten Kunden zurückgegeben.

Beispiele

Request (formatiert)
POST ${path}/${ma}/kunden HTTP/1.1
Host: www.maklerinfo.biz
${Auth}
Content-Type: application/json
Content-Length: 310
Connection: close

{
    "Benutzername": "maxmustermann",
    "Anrede": "1",
    "Person": {
        "Typ": "natuerlich",
        "Vorname": "Max",
        "Nachname": "Mustermann",
        "Geburtsdatum": "1980-08-02"
    },
    "Kontaktdaten": [
        {
            "Kontext": "private",
            "Typ": "email",
            "Value": "maxmustermann@example.com"
        }
    ],
    "Mitteilungen": {
        "Passwort": true
    }
}
Response (formatiert)
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 46
Connection: close

{
    "Id": "123456",
    "Benutzername": "maxmustermann"
}

getKunde PHP mit fsockopen

$authHeaders = [ /* s. Abschnitt Authentetifizierung */ ];


$ma = '123456_123456';
$kunde = '12345678';


$body = '';

$headers = 'GET /service/bd/employee/1.0/rest/'.$ma.'/kunden/'.$kunde.' HTTP/1.1
Host: www.maklerinfo.biz
'.implode("\r\n", $authHeaders).'
Content-Length: '.strlen($body).'
User-Agent: Dionera HttpClient 1.0
Connection: close';

$content = $headers
    ."\r\n\r\n"
    .$body;


$fp = fsockopen('tls://www.maklerinfo.biz',443);
fwrite($fp, $content);
$response = stream_get_contents($fp);

addKundenAdresse

☛ die Adresse darf nicht vom Typ hauptwohnsitz sein

setKundenAdresse

☛ bei der speziellen Adresse mit der Id 0 (Hauptwohnsitz) wird die Angabe von Typ ignoriert
☛ Adressen welche nicht die Id 0 (Hauptwohnsitz) haben dürfen nicht vom Typ hauptwohnsitz sein

deleteKundenAdresse

☛ bei der speziellen Adresse mit der Id 0 (Hauptwohnsitz) kann nicht gelöscht werden

setKundenKontaktdatensatz

☛ es werden nur die Attribute Value und Standard berücksichtigt

searchKunden

Eingabeparameter:

Name Typ Beschreibung
SuchText string mind. ein zeichen
Einträge-Von integer default 0
Einträge-Maximal integer default 50

Eingabeparameter POST: JSON SearchQuery

Rückgabe im Header:

Name Typ Beschreibung
Total integer Treffer insgesamt um eine Seitenblätterfunktion zu ermöglichen

Beispiel

Request GET
GET ${path}/${ma}/kunden/_search?q=test&from=10&size=5 HTTP/1.1
Host: www.maklerinfo.biz
${Auth}
Content-Type: application/json
Connection: close
Request POST
POST ${path}/${ma}/kunden/_search?q=test&from=10&size=5 HTTP/1.1
Host: www.maklerinfo.biz
${Auth}
Content-Type: application/json
Connection: close

{ "mail": "test" }
Response (gekürzt)
HTTP/1.1 200 OK
Content-Type: application/json
X-Dio-Total: 767
Connection: close

[...]

Datentypen

Kunde

Name Typ Anmerkung
Id string
Vermittler string Vermittlernummer
Anrede EnumValue getAnreden
Benutzername string
Person Person
Kontaktdaten Uri getKundenKontaktdatan
Adressen Uri getKundenAdressen
Vertraege Uri getKundenVertraege
Maklervollmacht Uri getArchiveintrag falls der Kunde bereits eine Maklervollmacht unterschrieben hat
Notizen string
Mitteilungen Benachrichtigung

KundePerson

Name Datentyp Beschreibung
Typ string "natuerlich" oder "juristisch"
Natürliche Person:
Titel string
Vorname string
Nachname string
Geburtsdatum Date
Beruf string
Fachrichtung string
Juristische Person:
Firma string
Ansprechpartner string
Gruendungsdatum Date
Branche string

Kontaktdatensatz

Name Datentyp Beschreibung
Uri Uri
Id string
Kontext string private o. business
Typ EnumValue getKundenKontaktarten
Value string
Standard boolean Bevorzugte Adresse je Typ

SearchQuery

Name Datentyp Beschreibung
mail string
id string

Adresse

Name Datentyp Beschreibung
Uri Uri
Id string
Typ EnumValue getAdresstypen
Zusatz string
Strasse string
Postleitzahl string
Ort string
Land EnumValue getLaender

Benachrichtigung

Name Datentyp Beschreibung
Passwort boolean Wenn true wird ein Passwort generiert und an die E-Mail des Kunden gesendet
ErstinfoUnterbinden boolean Wenn true wird keine E-Mail mit den Erstinformationen nach §11 der Vermittlerverordnung an den Kunden gesendet

KundenSuchErgebnis

Name Typ Anmerkung
Uri string
Id string
Anrede EnumValue getAnreden
Person KundenSuchErgebnisPerson
Hauptwohnsitz Adresse

KundenSuchErgebnisPerson

Name Datentyp Beschreibung
Typ string "natuerlich" oder "juristisch"
Natürliche Person:
Titel string
Vorname string
Nachname string
Geburtsdatum Date
Juristische Person:
Firma string
Ansprechpartner string
Gruendungsdatum Date

SendeUnterschrifftenlinkAuftrag

Name Typ Anmerkung
Art string maklervollmacht
Kommunikationsweg string sms o. email
Kommunikationsadresse string optional, abweichender Empfänger