Search & Autocomplete

Autocomplete

The autocomplete function automatically completes your input. Search just as you would with internet search engines.

get

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

/Search/AutoComplete

Authorizations

auth-key

auth-keystringRequired

API Key required for authorized endpoints

Query parameters

sourcestringOptional

valuestringOptional

typeintegerOptionalDefault: 1

Responses

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"
    }
  ]
}

Fulltext

This endpoint is designed for comprehensive search queries where multiple terms or a full-text scan are required.

1. type: Search Mode

   1. Exact: Search for an exact single word.

   2. Like: Left-aligned search starting from the beginning of a single word, considering partial words throughout the entire word.

   3. Phonetic: Search with phonetic matching to find similar terms.

2. source: Data source where the search is performed. Available options:

   1. etc

   2. etb

   3. kbc

   4. kbb

   5. kbg

3. resultThreshold: Minimum number of results that should be displayed.

4. resultMaximum: Maximum number of results that should be returned.

5. includeCount: Indicates whether the total number of hits should be included in the response (true/false).

6. includeData: Indicates whether detailed information about the hits should be included in the response (true/false).

7. search: Search term or search phrase.

post

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

/Search/Fulltext

Authorizations

auth-key

auth-keystringRequired

API Key required for authorized endpoints

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

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

This endpoint provides detailed results of a search based on the specified parameters. It is ideal for precise queries where both the number of hits and the complete data are relevant.

post

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

/Search/Detail

Authorizations

auth-key

auth-keystringRequired

API Key required for authorized endpoints

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

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"
    }
  ]
}