Data

Sobald ein Datensatz über Search oder Match identifiziert wurde, können mit der eindeutigen dwhId über die Data-Funktion Detailinformationen zum Datensatz abgerufen werden.

Detail

Ruft detaillierte Informationen zu einer spezifischen dwhId ab.

Dieser Endpoint wird verwendet, um alle verfügbaren Details zu einem bestimmten Datensatz abzurufen. Dies kann für eine präzise Analyse oder Weiterverarbeitung der Daten genutzt werden.

get
/api/Data/Detail
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
dwhIdstringOptional
Responses
200

OK

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

CriteriaDetail

Zeigt detaillierte Informationen zu spezifischen Kriterien an.

Dieser Endpoint liefert eine detaillierte Beschreibung der Kriterien, die in verschiedenen Datenkontexten verwendet werden. Nützlich für die Analyse und Verwaltung von Datenkriterien.

get
/api/Data/CriteriaDetail
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
cdwhIdstringOptional
Responses
200

OK

get
/api/Data/CriteriaDetail
GET /api/Data/CriteriaDetail HTTP/1.1
Host: webservices.kbdata.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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"
    }
  }
]

Relation

Ruft Informationen zu Datenrelationen ab.

Dieser Endpoint liefert Informationen über Beziehungen zwischen Datensätzen oder Entitäten. Ideal für die Analyse von Abhängigkeiten und Datenverknüpfungen.

get
/api/Data/Relation
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
relationDwhIdstringOptional
typeintegerOptional
languageintegerOptional
Responses
200

OK

get
/api/Data/Relation
GET /api/Data/Relation HTTP/1.1
Host: webservices.kbdata.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

[
  {
    "id": 1,
    "type": "1 = Company",
    "typeDescription": "text",
    "valueCombined": "text",
    "value1": "text",
    "value2": "text",
    "value3": "text",
    "relationId": 1,
    "relationDwhId": "text",
    "relationName": "text"
  }
]

UpdateCriteriaAvailable

Prüft, ob neue Kriterien verfügbar sind, die für Datenaktualisierungen genutzt werden können.

Dieser Endpoint dient dazu, festzustellen, ob neue oder aktualisierte Kriterien bereitstehen, die für zukünftige Datenaktualisierungen genutzt werden können.

get
/api/Data/UpdateCriteriaAvailable
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodystring[]
string[]Optional
Responses
200

OK

get
/api/Data/UpdateCriteriaAvailable
GET /api/Data/UpdateCriteriaAvailable HTTP/1.1
Host: webservices.kbdata.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]
200

OK

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

UpdateAvailable

Prüft, ob neue Datenaktualisierungen verfügbar sind, die abgerufen werden können.

Mit diesem Endpoint lässt sich überprüfen, ob neue oder geänderte Daten seit der letzten Abfrage verfügbar sind. Dies ermöglicht eine effiziente Synchronisation und Aktualisierung der Datenbestände.

get
/api/Data/UpdateAvailable
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
dwhIdstringOptional
Responses
200

OK

get
/api/Data/UpdateAvailable
GET /api/Data/UpdateAvailable HTTP/1.1
Host: webservices.kbdata.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

Last updated