Search & Autocomplete

Ermöglicht eine schrittweise Suche nach einzelnen Elementen (z. B. Name, Strasse) mit der Möglichkeit, die Suchergebnisse sukzessive zu verfeinern. Im Gegensatz zur Match-Funktion ist hier kein vollständiger String erforderlich.

Authentifizierung mit API-Key

Für den Zugriff auf die API wird ein API-Key benötigt.

1

API-Key erhalten

Der API-Key wird nach erfolgreichem Onboarding von uns bereitgestellt.

2

API-Key im Request verwenden

Der API-Key muss bei jedem Request im Header übermittelt werden.

Beispiel:

curl 'https://api.multisource.ch/v2/Search/AutoComplete?source=kbb&value=swisscom%20directories' \
  --header 'Auth-Key: <API-KEY>'

Autocomplete

get

https://api.multisource.ch/v2https://api.multisource.chhttps://apitep.multisource.ch

/Search/AutoComplete

Autorisierungen

auth-key

auth-keystringErforderlich

API Key required for authorized endpoints

Abfrageparameter

sourcestringOptional

valuestringOptional

typeintegerOptionalDefault: 1

Antworten

200

OK

text/plainapplication/jsontext/json

hitCountinteger · int32Optional

resultCountinteger · int32Optional

get

/Search/AutoComplete

HTTPcURLJavaScriptPython

GET /v2/Search/AutoComplete HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "hitCount": 1,
  "resultCount": 1,
  "data": [
    {
      "companyname": "text",
      "firstname": "text",
      "name": "text",
      "street": "text",
      "houseNumber": "text",
      "zip": "text",
      "location": "text"
    }
  ]
}

Response Felder

Root-Level Felder

Feld	Typ	Beschreibung	Beispiel
hitCount	integer	Gesamtanzahl der Treffer in der Datenbank für die angefragte Telefonnummer	1
resultCount	integer	Anzahl der tatsächlich zurückgegebenen Einträge im data-Array	1
data	array	Array mit den gefundenen Verzeichniseinträgen	siehe Eintragsfelder unten

Eintrags-Felder

Feld	Typ	Beschreibung	Beispiel
companyname	string	Firmenname bei Unternehmenseinträgen	Swisscom Directories AG
firstname	string	Vorname bei Privatpersonen	Lara
name	string	Nachname bei Privatpersonen	Graf
street	string	Strassenname	Förrlibuckstrasse
houseNumber	string	Hausnummer	62
zip	string	Postleitzahl (PLZ)	8005
location	string	Ortsname	Zürich
phoneNumbers	array	Array mit einer oder mehreren Festnetznummern	[ “*0800 123 456", "*058 123 45 67" ]
mobileNumbers	array	Array mit einer oder mehreren Mobilnummern	[ “*079 123 45 67" ]

Fulltext

Dieser Endpoint ist für umfassende Suchanfragen ausgelegt, bei denen mehrere Begriffe oder ein Volltextdurchlauf erforderlich sind.

1. type: Suchmodus

   1. Exact: Suche nach einem exakten Einzelwort.

   2. Like: Linksbündige Suche, die ab dem Beginn eines Einzelwortes erfolgt und Teilwörter im gesamten Wort berücksichtigt.

   3. Phonetic: Suche mit phonetischem Abgleich, um ähnliche Begriffe zu finden.

2. source: Datenquelle, in der gesucht wird. Verfügbare Optionen:

   1. etc

   2. etb

   3. kbc

   4. kbb

   5. kbg

3. resultThreshold: Mindestanzahl an Ergebnissen, die angezeigt werden sollen.

4. resultMaximum: Maximale Anzahl an Ergebnissen, die zurückgegeben werden.

5. includeCount: Gibt an, ob die Gesamtanzahl der Treffer in der Antwort enthalten sein soll (true/false).

6. includeData: Gibt an, ob Detailinformationen zu den Treffern ausgegeben werden sollen (true/false).

7. search: Suchbegriff oder Suchphrase.

post

https://api.multisource.ch/v2https://api.multisource.chhttps://apitep.multisource.ch

/Search/Fulltext

Autorisierungen

auth-key

auth-keystringErforderlich

API Key required for authorized endpoints

Rumpf

application/jsontext/jsonapplication/*+json

typeinteger · enumOptionalMögliche Werte:

likeTypeinteger · enumOptionalMögliche Werte:

sourcestringOptional

resultThresholdinteger · int32Optional

resultMaximuminteger · int32Optional

includeCountbooleanOptional

includeDatabooleanOptional

termOperationinteger · enumOptionalMögliche Werte:

searchstringOptional

Antworten

200

OK

text/plainapplication/jsontext/json

hitCountinteger · int32Optional

resultCountinteger · int32Optional

post

/Search/Fulltext

HTTPcURLJavaScriptPython

POST /v2/Search/Fulltext HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "type": "0 = Exact",
  "likeType": "0 = StartsWith",
  "source": "text",
  "resultThreshold": 1,
  "resultMaximum": 1,
  "includeCount": true,
  "includeData": true,
  "termOperation": "0 = And",
  "search": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "hitCount": 1,
  "resultCount": 1,
  "data": [
    {
      "dwhId": "text",
      "companyname": "text",
      "firstname": "text",
      "name": "text",
      "street": "text",
      "houseNumber": "text",
      "zip": "text",
      "location": "text"
    }
  ]
}

Detail

Dieser Endpoint liefert die Detailergebnisse einer Suche basierend auf den angegebenen Parametern. Er eignet sich ideal für präzise Anfragen, bei denen sowohl die Anzahl der Treffer als auch die vollständigen Daten relevant sind.

post

https://api.multisource.ch/v2https://api.multisource.chhttps://apitep.multisource.ch

/Search/Detail

Autorisierungen

auth-key

auth-keystringErforderlich

API Key required for authorized endpoints

Rumpf

application/jsontext/jsonapplication/*+json

typeinteger · enumOptionalMögliche Werte:

likeTypeinteger · enumOptionalMögliche Werte:

sourcestringOptional

resultThresholdinteger · int32Optional

resultMaximuminteger · int32Optional

includeCountbooleanOptional

includeDatabooleanOptional

termOperationinteger · enumOptionalMögliche Werte:

Antworten

200

OK

text/plainapplication/jsontext/json

hitCountinteger · int32Optional

resultCountinteger · int32Optional

post

/Search/Detail

HTTPcURLJavaScriptPython

POST /v2/Search/Detail HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 464

{
  "type": "0 = Exact",
  "likeType": "0 = StartsWith",
  "source": "text",
  "resultThreshold": 1,
  "resultMaximum": 1,
  "includeCount": true,
  "includeData": true,
  "termOperation": "0 = And",
  "search": {
    "dwhId": "text",
    "uid": "text",
    "chNr": "text",
    "egId": "text",
    "postAddressId": "text",
    "beac": "text",
    "companyname": "text",
    "householdId": "text",
    "firstname": "text",
    "name": "text",
    "street": "text",
    "houseNumber": "text",
    "zip": "text",
    "location": "text",
    "phone": "text",
    "mobile": "text",
    "birthdate": "text"
  }
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "hitCount": 1,
  "resultCount": 1,
  "data": [
    {
      "dwhId": "text",
      "companyname": "text",
      "firstname": "text",
      "name": "text",
      "street": "text",
      "houseNumber": "text",
      "zip": "text",
      "location": "text"
    }
  ]
}