Match

Bietet eine Einzelabfrage ähnlich der Neartime-Funktion und eignet sich zur Überprüfung des Status eines spezifischen Datensatzes auf Änderungen. Die Match-Funktion unterstützt auch eine Fuzzy-Logik mit phonetischen Abgleichen, um ungenaue Eingaben auszugleichen.

Match

Die API durchsucht basierend auf den bereitgestellten Eingabedaten alle berechtigten Quellen, um das bestmögliche Ergebnis zu ermitteln.

• Ergebnisinterpretation:

  • Wird ein Treffer in der History gefunden, wird dieser als Umzug identifiziert.

  • Die Funktion verwendet fortschrittliche Matching-Algorithmen, um die Genauigkeit auch bei unvollständigen oder teils abweichenden Eingaben zu gewährleisten.

get

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

/api/match/Match

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

source_filterstringOptionalDefault: ""

criteria_filterstringOptionalDefault: ""

Body

application/jsontext/jsonapplication/*+json

sourceOriginstring | nullableOptional

matchPriostring | nullableOptional

dwhIdstring | nullableOptional

uidstring | nullableOptional

chnrstring | nullableOptional

beacinteger · int32 | nullableOptional

egidinteger · int32 | nullableOptional

postAddressIdinteger · int32 | nullableOptional

firstnamestring | nullableOptional

namestring | nullableOptional

streetstring | nullableOptional

houseNostring | nullableOptional

zipstring | nullableOptional

locationstring | nullableOptional

phonestring | nullableOptional

mobilestring | nullableOptional

birthdatestring | nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/match/Match

HTTPcURLJavaScriptPython

GET /api/match/Match HTTP/1.1
Host: webservices.kbdata.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 267

{
  "sourceOrigin": "text",
  "matchPrio": "text",
  "dwhId": "text",
  "uid": "text",
  "chnr": "text",
  "beac": 1,
  "egid": 1,
  "postAddressId": 1,
  "firstname": "text",
  "name": "text",
  "street": "text",
  "houseNo": "text",
  "zip": "text",
  "location": "text",
  "phone": "text",
  "mobile": "text",
  "birthdate": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "beac": "text",
  "recordType": "text",
  "matchRating": "0 = NoRating",
  "language": "text",
  "salutation": "text",
  "acadTitel": "text",
  "acadTitelLabel": "text",
  "careof1": "text",
  "careOf2": "text",
  "streetAdditional": "text",
  "countryCode": "text",
  "postBoxFlag": true,
  "postBox": "text",
  "postBoxText": "text",
  "postBoxZip": "text",
  "postBoxZip6": "text",
  "postBoxLocation": "text",
  "addressLabel1": "text",
  "addressLabel2": "text",
  "addressLabel3": "text",
  "addressLabel4": "text",
  "addressLabel5": "text",
  "addressLabel6": "text",
  "letterSalutation": "text",
  "dwhId": "text",
  "companyname": "text",
  "companyname2": "text",
  "companyname3": "text",
  "firstname": "text",
  "name": "text",
  "street": "text",
  "houseNumber": "text",
  "zip": "text",
  "zip6": "text",
  "location": "text",
  "meta": {
    "updateAvailable": true,
    "criterias": [
      {
        "dwhCriteriaId": "text",
        "criteriaId": "text",
        "criteriaSort": 1,
        "criteriaDescription": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "criteriaGroupSort": 1,
        "criteriaGroupDescription": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valueAvailable": true
      }
    ]
  }
}

MatchRating

Berechnet die Match-Bewertung.

Wird ausschliesslich für spezifische Anwendungszwecke genutzt und im Rahmen der Business-Analyse definiert.

get

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

/api/match/MatchRating

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/jsontext/jsonapplication/*+json

sourceOriginstring | nullableOptional

matchPriostring | nullableOptional

dwhIdstring | nullableOptional

uidstring | nullableOptional

chnrstring | nullableOptional

beacinteger · int32 | nullableOptional

egidinteger · int32 | nullableOptional

postAddressIdinteger · int32 | nullableOptional

firstnamestring | nullableOptional

namestring | nullableOptional

streetstring | nullableOptional

houseNostring | nullableOptional

zipstring | nullableOptional

locationstring | nullableOptional

phonestring | nullableOptional

mobilestring | nullableOptional

birthdatestring | nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/match/MatchRating

HTTPcURLJavaScriptPython

GET /api/match/MatchRating HTTP/1.1
Host: webservices.kbdata.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 267

{
  "sourceOrigin": "text",
  "matchPrio": "text",
  "dwhId": "text",
  "uid": "text",
  "chnr": "text",
  "beac": 1,
  "egid": 1,
  "postAddressId": 1,
  "firstname": "text",
  "name": "text",
  "street": "text",
  "houseNo": "text",
  "zip": "text",
  "location": "text",
  "phone": "text",
  "mobile": "text",
  "birthdate": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "matchRating": "0 = NoRating"
}

MatchScore

Berechnet den Match-Score.

Wird ausschliesslich für spezifische Anwendungszwecke genutzt und im Rahmen der Business-Analyse definiert.

get

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

/api/match/MatchScore

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

source_filterstringOptionalDefault: ""

criteria_filterstringOptionalDefault: ""

Body

application/jsontext/jsonapplication/*+json

sourceOriginstring | nullableOptional

matchPriostring | nullableOptional

dwhIdstring | nullableOptional

uidstring | nullableOptional

chnrstring | nullableOptional

beacinteger · int32 | nullableOptional

egidinteger · int32 | nullableOptional

postAddressIdinteger · int32 | nullableOptional

firstnamestring | nullableOptional

namestring | nullableOptional

streetstring | nullableOptional

houseNostring | nullableOptional

zipstring | nullableOptional

locationstring | nullableOptional

phonestring | nullableOptional

mobilestring | nullableOptional

birthdatestring | nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/match/MatchScore

HTTPcURLJavaScriptPython

GET /api/match/MatchScore HTTP/1.1
Host: webservices.kbdata.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 267

{
  "sourceOrigin": "text",
  "matchPrio": "text",
  "dwhId": "text",
  "uid": "text",
  "chnr": "text",
  "beac": 1,
  "egid": 1,
  "postAddressId": 1,
  "firstname": "text",
  "name": "text",
  "street": "text",
  "houseNo": "text",
  "zip": "text",
  "location": "text",
  "phone": "text",
  "mobile": "text",
  "birthdate": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "beac": "text",
  "recordType": "text",
  "matchRating": "0 = NoRating",
  "language": "text",
  "salutation": "text",
  "acadTitel": "text",
  "acadTitelLabel": "text",
  "careof1": "text",
  "careOf2": "text",
  "streetAdditional": "text",
  "countryCode": "text",
  "postBoxFlag": true,
  "postBox": "text",
  "postBoxText": "text",
  "postBoxZip": "text",
  "postBoxZip6": "text",
  "postBoxLocation": "text",
  "addressLabel1": "text",
  "addressLabel2": "text",
  "addressLabel3": "text",
  "addressLabel4": "text",
  "addressLabel5": "text",
  "addressLabel6": "text",
  "letterSalutation": "text",
  "dwhId": "text",
  "companyname": "text",
  "companyname2": "text",
  "companyname3": "text",
  "firstname": "text",
  "name": "text",
  "street": "text",
  "houseNumber": "text",
  "zip": "text",
  "zip6": "text",
  "location": "text",
  "meta": {
    "updateAvailable": true,
    "criterias": [
      {
        "dwhCriteriaId": "text",
        "criteriaId": "text",
        "criteriaSort": 1,
        "criteriaDescription": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "criteriaGroupSort": 1,
        "criteriaGroupDescription": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "valueAvailable": true
      }
    ]
  },
  "scoring": {
    "score": 1,
    "Name": 1,
    "Address": 1,
    "CompanyName": 1,
    "CompanyType": 1,
    "NameTotal": 1,
    "NameInitials": 1,
    "NameFirstname": 1,
    "NameLastname": 1,
    "EmployeeNameTotal": 1,
    "EmployeeInitials": 1,
    "EmployeeFirstname": 1,
    "EmployeeLastname": 1,
    "Zip": 1,
    "City": 1,
    "Street": 1,
    "Hnr": 1,
    "Phone": 1,
    "Email": 1,
    "Birthdate": 1,
    "Bankcode": 1,
    "AccountNr": 1,
    "Creditcard": 1,
    "F1": 1,
    "F2": 1,
    "F3": 1,
    "F4": 1,
    "F5": 1
  }
}

Update

Aktualisiert die Matching-Daten basierend auf den übergebenen Eingabewerten.

Vor der Aktualisierung wird automatisch ein Match durchgeführt.

get

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

/api/match/Update

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/jsontext/jsonapplication/*+json

sourceOriginstring | nullableOptional

matchPriostring | nullableOptional

dwhIdstring | nullableOptional

uidstring | nullableOptional

chnrstring | nullableOptional

beacinteger · int32 | nullableOptional

egidinteger · int32 | nullableOptional

postAddressIdinteger · int32 | nullableOptional

firstnamestring | nullableOptional

namestring | nullableOptional

streetstring | nullableOptional

houseNostring | nullableOptional

zipstring | nullableOptional

locationstring | nullableOptional

phonestring | nullableOptional

mobilestring | nullableOptional

birthdatestring | nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/match/Update

HTTPcURLJavaScriptPython

GET /api/match/Update HTTP/1.1
Host: webservices.kbdata.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 267

{
  "sourceOrigin": "text",
  "matchPrio": "text",
  "dwhId": "text",
  "uid": "text",
  "chnr": "text",
  "beac": 1,
  "egid": 1,
  "postAddressId": 1,
  "firstname": "text",
  "name": "text",
  "street": "text",
  "houseNo": "text",
  "zip": "text",
  "location": "text",
  "phone": "text",
  "mobile": "text",
  "birthdate": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "prioReferenceStatus": "text",
  "beac": "text",
  "recordType": "text",
  "matchRating": "0 = NoRating",
  "language": "text",
  "salutation": "text",
  "acadTitel": "text",
  "acadTitelLabel": "text",
  "careof1": "text",
  "careOf2": "text",
  "streetAdditional": "text",
  "countryCode": "text",
  "postBoxFlag": true,
  "postBox": "text",
  "postBoxText": "text",
  "postBoxZip": "text",
  "postBoxZip6": "text",
  "postBoxLocation": "text",
  "addressLabel1": "text",
  "addressLabel2": "text",
  "addressLabel3": "text",
  "addressLabel4": "text",
  "addressLabel5": "text",
  "addressLabel6": "text",
  "letterSalutation": "text",
  "dwhId": "text",
  "companyname": "text",
  "companyname2": "text",
  "companyname3": "text",
  "firstname": "text",
  "name": "text",
  "street": "text",
  "houseNumber": "text",
  "zip": "text",
  "zip6": "text",
  "location": "text"
}

Enrich

Ergänzt den Datensatz basierend auf der angegebenen dwhid mit berechtigten Zusatzinformationen. Vor der Anreicherung wird automatisch ein Match durchgeführt.

Die Enrich-Funktion aktualisiert automatisch alle verfügbaren Kriterien.

Falls Sie nur bestimmte Kriterien aus der gesamten Liste benötigen, folgen Sie diesen Schritten:

1

DWH-ID abrufen

Nutzen Sie die Search/Match-Funktion, um die DWH-ID des Eintrags zu erhalten.

2

Detaillierte Informationen abrufen

Verwenden Sie die Data/Detail-Funktion, um alle verfügbaren Informationen zum Eintrag zu laden.

3

Meta-Block prüfen

Überprüfen Sie, ob das gewünschte Kriterium im Meta-Block enthalten ist.

4

Verfügbarkeit sicherstellen

Falls das benötigte Kriterium (z. B. PE_PHONE) die Eigenschaft valueAvailable = true besitzt, verwenden Sie die zugehörige dwhCriteriaId.

5

Spezifische Kriterien laden

Mit der Data/CriteriasDetail-Funktion können Sie gezielt nur die benötigten Kriterien abrufen. Der Request-Body sollte eine Liste der gewünschten dwhCriteriaId enthalten.

get

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

/api/match/Enrich

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/jsontext/jsonapplication/*+json

sourceOriginstring | nullableOptional

matchPriostring | nullableOptional

dwhIdstring | nullableOptional

uidstring | nullableOptional

chnrstring | nullableOptional

beacinteger · int32 | nullableOptional

egidinteger · int32 | nullableOptional

postAddressIdinteger · int32 | nullableOptional

firstnamestring | nullableOptional

namestring | nullableOptional

streetstring | nullableOptional

houseNostring | nullableOptional

zipstring | nullableOptional

locationstring | nullableOptional

phonestring | nullableOptional

mobilestring | nullableOptional

birthdatestring | nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/match/Enrich

HTTPcURLJavaScriptPython

GET /api/match/Enrich HTTP/1.1
Host: webservices.kbdata.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 267

{
  "sourceOrigin": "text",
  "matchPrio": "text",
  "dwhId": "text",
  "uid": "text",
  "chnr": "text",
  "beac": 1,
  "egid": 1,
  "postAddressId": 1,
  "firstname": "text",
  "name": "text",
  "street": "text",
  "houseNo": "text",
  "zip": "text",
  "location": "text",
  "phone": "text",
  "mobile": "text",
  "birthdate": "text"
}

application/jsontext/jsonapplication/*+json

200

OK

[
  {
    "dwhCriteriaId": "text",
    "criteriaId": "text",
    "criteriaSort": 1,
    "criteriaDescription": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "criteriaGroupDescription": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "criteriaGroupSort": 1,
    "value": "text",
    "valueDescription": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]