BISO SH Online-Termine

API-Endpunkte

• Für BISO SH werden die Endpunkte im Controller KtShApiController definiert.
• Die Import-Logik ist in ImportInboxShService zu finden.
• Die Endpunkte sind hier dokumentiert: Wichtig sind die Endpunkte unter {{backend_root}}/api/ktsh/*

Beispiel-Requests

sendFormData

POST {{baseUrl}}/api/ktsh/sendFormData

{
  "original_data": {
    "date_guid": "01a0b3f4-3cfe-73f8-848e-f94b43bf5b50",
    "anrede": "frau",
    "name": "Suter",
    "vorname": "Heinz",
    "strasse": "Tellstrasse",
    "nummer": "95",
    "plz": "8200",
    "ort": "Schaffhausen",
    "telefon_mobile": "xxx",
    "email": "suter.tell@he.ch",
    "geburtsdatum": "1985-12-15",
    "nationalitaet": "Liechtenstein",
    "ausbildung": "Dies",
    "taetigkeit": "Das",
    "fragestellung": "Soso",
    "ideen": "Warum",
    "beratungsart": "biz",
    "erfahren_durch": "Website",
    "newsletter": false
  }
}

Konfiguration

Werte-Mapping

Folgendes Mapping muss für SH konfiguriert werden:

Anrede -> Geschlecht:

INSERT INTO value_map
(context,"key",external_value,biso_value) VALUES
     ('api_ktsh','anrede_geschlecht','Herr','m'),
     ('api_ktsh','anrede_geschlecht','Frau','f');

** Nationalität**

INSERT INTO value_map
(context,"key",external_value,biso_value) VALUES
     ('api_ktsh','nationalitaet_id','CH', 1)
;

Beratungsart -> Besprechungsart

Das Formular liefert im Feld beratungsart einen der Werte online, telefon oder biz. Dieser Wert wird auf die ID einer Besprechungsart (Tabelle bf_termin_besprechungsart) gemappt. external_value ist der Formularwert (Gross-/Kleinschreibung wird ignoriert), biso_value die ID der Besprechungsart. Ohne passenden Eintrag wird keine Besprechungsart gesetzt.

INSERT INTO value_map
(context,"key",external_value,biso_value) VALUES
     ('api_ktsh','besprechungsart_id','online', <ID Online>),
     ('api_ktsh','besprechungsart_id','telefon', <ID Telefon>),
     ('api_ktsh','besprechungsart_id','biz', <ID BIZ>)
;

Hilfsabfrage zum Ermitteln der IDs:

SELECT id, bezeichnung FROM bf_termin_besprechungsart;

Erfahren durch

Alle via Import Inbox eröffneten Fälle erhalten denselben "Erfahren durch"-Wert (z.B. "Direktanmeldung"). biso_value ist die ID des entsprechenden Eintrags in der Werteliste "Erfahren durch" (Tabelle beratung_erfahren_durch); external_value wird nicht verwendet. Ohne Eintrag bleibt das Feld bei der Fall-Eröffnung leer.

INSERT INTO value_map
(context,"key",external_value,biso_value) VALUES
     ('api_ktsh','beratung_erfahren_durch_id', NULL, <ID Direktanmeldung>)
;

Hilfsabfrage zum Ermitteln der ID:

SELECT id, erfahren_durch FROM beratung_erfahren_durch;

Admin > Parameter

• termin_email_organizer in Parameter setzen (Vcal-Organizer) oder api-User Person mit Mail zuordnen