Zum Inhalt

Web Kontakte API#

Für die Übermittlung von Kontaktdaten, die sowohl als Kontakt als auch als Debitor/Kreditor genutzt werden können, steht eine API für Kontakte zur Verfügung. Die bereitgestellten Daten sind im eBox-Eingang "WebKontakt" abrufbar und zur weiteren Verarbeitung vorgesehen.

Hinweis

Weiterführende Informationen zur Aktivierung der APIs für Microsoft Dynamics 365 Business Central1 finden Sie unter: Enabling the APIs for Business Central

Einrichtung#

Definition WebKontakte API#

Nachfolgend werden Ihnen die Felder der WebKontakte API und ihre Definition näher erläutert:

Kontakte#

Feldbezeichnung Feldtyp Sofern nicht anders angegeben handelt es sich um interne Ids
partnerId Code20 PartnerID der internen API Partner Einrichtung, muss vom PartnerSystem übermittelt werden.
id Guid Nicht editierbar; SystemInterne ID des Datendatzes, kann für späteren Zugriff auf nachfolgende Funktionen (GET, BoundedAction) genutzt werden.
name Text100 Name
name2 Text50 Name 2
address Text100 Adresse
address2 Text50 Adresse 2
postCode PLZ Code
city Text30 Stadt
countryRegionCode Code10 Ländercode
county Text30 Region
birthday Date Geburtsdatum
eMail Text80 E-Mail
fromTemplateCode Code10 Vorlagencode für die Anlage des Kontakts
externalID Code20 Externe ID
mobilePhoneNo Text30 Mobilnr.
phoneNo Text30 Telefonnr.
personContact Boolean Personenkontakt Ja/Nein
salespersonCode Code20 Verkäufercode
salutationCode Code10 Anredecode
physicianNo Code20 offizielle Arztnummer
plantLocation Code20 Betriebsstättennummer des Arztes
insurantNo Code20 Versichertennummer, wird die Versichternnummer statt einer Debitoren- oder Kontaktnummer übermittelt, dann wird anhand dieser Nummer im Debitorenstamm der Versichterte ermittelt
insurantStatus
institutionCode Code20 Institutionskennzeichen; aktuell keine Funktion
status Enum {Received, InProcess, Processed, Error} nur Rückgabe
teamcode Code10 Team Code

Zugeordnete Partner#

Feldbezeichnung Feldtyp Sofern nicht anders angegeben handelt es sich um interne Ids
id Guid Nicht editierbar; SystemInterne ID des Datendatzes, kann für späteren Zugriff auf nachfolgende Funktionen (GET, BoundedAction) genutzt werden.
assignedPartnerRoleType Enum {None,Insurant,Physician,"Healthcare Insurance",Agent"Nursing Insurance","Pricing Customer","Salesperson Code","Salesperson Code 2","Assigned UserID","Purchaser Code","Private Insurant","Private Healthcare Insurance","Pricing Vendor"}
partnerType Enum {Contact,Customer,Vendor}
partnerCode Code20 Stammdaten Nummer entsprechend der angegebenen Partnerart.
processType Code10 Vorgangsart

JSON Struktur#

Nachfolgend wird Ihnen ein Beispiel einer JSON-Struktur für die Übermittlung von WebKontakte an KUMAVISION healthcare365 aufgezeigt:

{    "partnerId": "TILLHUB",
    "salutationCode": "F",
    "name": "Gerda Müller",
    "address":"Mühlenweg 1",
    "postCode": "44143",
    "city": "Dortmund",
    "birthday": "1998-12-03",
    "mobilePhoneNo": "+49121212122",
    "fromTemplateCode": "01PATGKV",
    "physicianNo": "",
    "plantLocation": "",
    "insurantNo": "121223236455",
    "insurantStatus": "5",
    "institutionCode": "",
    "webContactAssignedPartners": [
        {
            "assignedPartnerRoleType": "Physician",
            "partnerType": "Contact",
            "partnerCode": "K00542279",
            "processType": ""
        },
        {
            "assignedPartnerRoleType": "Healthcare Insurance",
            "partnerType": "Customer",
            "partnerCode": "10001162"
        }
    ] 
}

Prozess#

Die übermittelten Daten sind im eBox-Eingang unter "WebKontakt" verfügbar und können dort abgerufen sowie weiterverarbeitet werden.

In der eBox stehen Ihnen folgende Funktionen zur Verfügung:

Funktion Beschreibung
Abrufen Mit dieser Funktion werden alle offenen sowie fehlerhaften eingegangenen WebKontakte angezeigt; von hier aus können diese direkt in die eigene eBox übernommen werden.
Löschen Der ausgewählte WebKontakt wird aus der eBox entfernt und steht anschließend wieder allen NutzerInnen zur Verfügung.
Datensätze aktualisieren Führt eine Prüfung durch, um sicherzustellen, dass die Mindestanforderungen für die Erstellung eines Kontakts in der Kurzerfassung erfüllt sind.
Verarbeiten Die Funktion "Datensätze aktualisieren" wird ausgeführt. Nach erfolgreicher Durchführung erfolgt die Erstellung einer Kontaktkurzerfassung, aus der die entsprechenden Stammdatensätze generiert werden. Anschließend erfolgt die Archivierung des WebKontakts sowie die Entfernung aus der eBox und den offenen WebKontakten.
Anderen Benutzer zuweisen Der ausgewählte WebKontakt wird in die eBox eines anderen frei wählbaren Benutzers verschoben.
Anderes Team zuweisen Der ausgewählte WebKontakt wird einem Team zugewiesen und wird somit zurück in den offenen WebKontaktpool verschieben.
Archivieren ohne Verarbeitung Der offene WebKontakt wird archiviert und gelöscht, ohne dass weitere Funktionen ausgeführt werden.

Im Rahmen der Weiterverarbeitung werden die Daten aus den WebKontakten an die Kontaktkurzerfassung übermittelt. Anschließend findet, sofern eingerichtet, eine Pflichtfeldprüfung statt. Danach werden automatisch die in der Vorlage definierten Stammdatensätze (Debitor, Kreditor, Kontakt) erstellt.

Sobald ein WebKontakt erfolgreich an die Kurzerfassung übermittelt wurde, gilt er als abgeschlossen, wird archiviert und aus der eBox entfernt.

  1. Microsoft, Microsoft Dynamics und Microsoft Dynamics 365 sind Marken der Microsoft-Unternehmensgruppe. ↩