Search

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.

Autocomplete

Die Autocomplete-Funktion vervollständigt Ihre Eingabe automatisch. Suchen Sie genauso, wie Sie es von Internet-Suchmaschinen gewohnt sind.

get

https://webservices.kbdata.chhttps://webservices-dev.kbdata.ch

/api/Search/AutoComplete

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sourcestringOptional

valuestringOptional

typeintegerOptionalDefault: 1

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/Search/AutoComplete

HTTPcURLJavaScriptPython

GET /api/Search/AutoComplete HTTP/1.1
Host: webservices.kbdata.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

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

Fulltext

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

1. type: Suchmodus

   • Exact: Suche nach einem exakten Einzelwort.

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

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

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

   • etc

   • etb

   • kbc

   • kbb

   • 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.

get

https://webservices.kbdata.chhttps://webservices-dev.kbdata.ch

/api/Search/Fulltext

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/jsontext/jsonapplication/*+json

typeinteger · enumOptionalPossible values:

likeTypeinteger · enumOptionalPossible values:

sourcestringOptional

resultThresholdinteger · int32Optional

resultMaximuminteger · int32Optional

includeCountbooleanOptional

includeDatabooleanOptional

termOperationinteger · enumOptionalPossible values:

searchstringOptional

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/Search/Fulltext

HTTPcURLJavaScriptPython

GET /api/Search/Fulltext HTTP/1.1
Host: webservices.kbdata.ch
Authorization: Bearer YOUR_SECRET_TOKEN
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.

get

https://webservices.kbdata.chhttps://webservices-dev.kbdata.ch

/api/Search/Detail

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/jsontext/jsonapplication/*+json

typeinteger · enumOptionalPossible values:

likeTypeinteger · enumOptionalPossible values:

sourcestringOptional

resultThresholdinteger · int32Optional

resultMaximuminteger · int32Optional

includeCountbooleanOptional

includeDatabooleanOptional

termOperationinteger · enumOptionalPossible values:

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/Search/Detail

HTTPcURLJavaScriptPython

GET /api/Search/Detail HTTP/1.1
Host: webservices.kbdata.ch
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  ]
}