Match

Bietet eine Einzelabfrage ähnlich der Batch-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.

post

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

/match/Match

Autorisierungen

auth-key

auth-keystringErforderlich

API Key required for authorized endpoints

Abfrageparameter

source_filterstringOptionalDefault: ""

criteria_filterstringOptionalDefault: ""

Rumpf

application/jsontext/jsonapplication/*+json

sourceOriginstring · nullfähigOptional

matchPriostring · nullfähigOptional

dwhIdstring · nullfähigOptional

uidstring · nullfähigOptional

chnrstring · nullfähigOptional

beacinteger · int32 · nullfähigOptional

egidinteger · int32 · nullfähigOptional

postAddressIdinteger · int32 · nullfähigOptional

firstnamestring · nullfähigOptional

namestring · nullfähigOptional

streetstring · nullfähigOptional

houseNostring · nullfähigOptional

zipstring · nullfähigOptional

locationstring · nullfähigOptional

phonestring · nullfähigOptional

mobilestring · nullfähigOptional

birthdatestring · nullfähigOptional

Antworten

200

OK

text/plainapplication/jsontext/json

beacstring · nullfähigOptional

recordTypestring · nullfähigOptional

matchRatinginteger · enumOptionalMögliche Werte:

languagestring · nullfähigOptional

salutationstring · nullfähigOptional

acadTitelstring · nullfähigOptional

acadTitelLabelstring · nullfähigOptional

careof1string · nullfähigOptional

careOf2string · nullfähigOptional

streetAdditionalstring · nullfähigOptional

countryCodestring · nullfähigOptional

postBoxFlagboolean · nullfähigOptional

postBoxstring · nullfähigOptional

postBoxTextstring · nullfähigOptional

postBoxZipstring · nullfähigOptional

postBoxZip6string · nullfähigOptional

postBoxLocationstring · nullfähigOptional

addressLabel1string · nullfähigOptional

addressLabel2string · nullfähigOptional

addressLabel3string · nullfähigOptional

addressLabel4string · nullfähigOptional

addressLabel5string · nullfähigOptional

addressLabel6string · nullfähigOptional

letterSalutationstring · nullfähigOptional

dwhIdstring · nullfähigOptional

companynamestring · nullfähigOptional

companyname2string · nullfähigOptional

companyname3string · nullfähigOptional

firstnamestring · nullfähigOptional

namestring · nullfähigOptional

streetstring · nullfähigOptional

houseNumberstring · nullfähigOptional

zipstring · nullfähigOptional

zip6string · nullfähigOptional

locationstring · nullfähigOptional

post

/match/Match

HTTPcURLJavaScriptPython

POST /v2/match/Match HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
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
      }
    ]
  }
}

Update

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

Vor der Aktualisierung wird automatisch ein Match durchgeführt.

post

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

/match/Update

Autorisierungen

auth-key

auth-keystringErforderlich

API Key required for authorized endpoints

Rumpf

application/jsontext/jsonapplication/*+json

sourceOriginstring · nullfähigOptional

matchPriostring · nullfähigOptional

dwhIdstring · nullfähigOptional

uidstring · nullfähigOptional

chnrstring · nullfähigOptional

beacinteger · int32 · nullfähigOptional

egidinteger · int32 · nullfähigOptional

postAddressIdinteger · int32 · nullfähigOptional

firstnamestring · nullfähigOptional

namestring · nullfähigOptional

streetstring · nullfähigOptional

houseNostring · nullfähigOptional

zipstring · nullfähigOptional

locationstring · nullfähigOptional

phonestring · nullfähigOptional

mobilestring · nullfähigOptional

birthdatestring · nullfähigOptional

Antworten

200

OK

text/plainapplication/jsontext/json

prioReferenceStatusstring · nullfähigOptional

beacstring · nullfähigOptional

recordTypestring · nullfähigOptional

matchRatinginteger · enumOptionalMögliche Werte:

languagestring · nullfähigOptional

salutationstring · nullfähigOptional

acadTitelstring · nullfähigOptional

acadTitelLabelstring · nullfähigOptional

careof1string · nullfähigOptional

careOf2string · nullfähigOptional

streetAdditionalstring · nullfähigOptional

countryCodestring · nullfähigOptional

postBoxFlagboolean · nullfähigOptional

postBoxstring · nullfähigOptional

postBoxTextstring · nullfähigOptional

postBoxZipstring · nullfähigOptional

postBoxZip6string · nullfähigOptional

postBoxLocationstring · nullfähigOptional

addressLabel1string · nullfähigOptional

addressLabel2string · nullfähigOptional

addressLabel3string · nullfähigOptional

addressLabel4string · nullfähigOptional

addressLabel5string · nullfähigOptional

addressLabel6string · nullfähigOptional

letterSalutationstring · nullfähigOptional

dwhIdstring · nullfähigOptional

companynamestring · nullfähigOptional

companyname2string · nullfähigOptional

companyname3string · nullfähigOptional

firstnamestring · nullfähigOptional

namestring · nullfähigOptional

streetstring · nullfähigOptional

houseNumberstring · nullfähigOptional

zipstring · nullfähigOptional

zip6string · nullfähigOptional

locationstring · nullfähigOptional

post

/match/Update

HTTPcURLJavaScriptPython

POST /v2/match/Update HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
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.

post

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

/match/Enrich

Autorisierungen

auth-key

auth-keystringErforderlich

API Key required for authorized endpoints

Rumpf

application/jsontext/jsonapplication/*+json

sourceOriginstring · nullfähigOptional

matchPriostring · nullfähigOptional

dwhIdstring · nullfähigOptional

uidstring · nullfähigOptional

chnrstring · nullfähigOptional

beacinteger · int32 · nullfähigOptional

egidinteger · int32 · nullfähigOptional

postAddressIdinteger · int32 · nullfähigOptional

firstnamestring · nullfähigOptional

namestring · nullfähigOptional

streetstring · nullfähigOptional

houseNostring · nullfähigOptional

zipstring · nullfähigOptional

locationstring · nullfähigOptional

phonestring · nullfähigOptional

mobilestring · nullfähigOptional

birthdatestring · nullfähigOptional

Antworten

200

OK

text/plainapplication/jsontext/json

dwhCriteriaIdstring · nullfähigOptional

criteriaIdstring · nullfähigOptional

criteriaSortinteger · int32Optional

criteriaGroupSortinteger · int32Optional

valuestring · nullfähigOptional

post

/match/Enrich

HTTPcURLJavaScriptPython

POST /v2/match/Enrich HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
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"
    }
  }
]