Daten-Output

Die Ergebnisse werden wahlweise als JSON-Response oder als Datei-Download bereitgestellt. Beide Varianten enthalten identische Ausgabefelder und Strukturen.

JSON-Output

Die Resultate können direkt als JSON-Objekt abgerufen werden.

get

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

/addressprocessing/GetRecords

Autorisierungen

auth-key

auth-keystringErforderlich

API Key required for authorized endpoints

Abfrageparameter

uidstring · uuidOptional

filebooleanOptionalDefault: false

fileDecompressbooleanOptionalDefault: false

Antworten

200

OK

Kein Inhalt

get

/addressprocessing/GetRecords

HTTPcURLJavaScriptPython

GET /v2/addressprocessing/GetRecords HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Accept: */*

200

OK

Kein Inhalt

Beispiel-Output

{
  "id": "f994890a-2y44-4279-99b7-5ebf4d0d9dx5",
  "status": 200,
  "info": [],
  "result": [
    {
      "input_customerId": "123456789",
      "input_uid": "",
      "input_chnr": "",
      "input_egid": "",
      "input_postaddressId": "",
      "input_name": "Doe",
      "input_company": "",
      "input_firstname": "John",
      "input_street": "Schanzenstrasse",
      "input_houseNo": "4c",
      "input_zip": "3008",
      "input_location": "Bern",
      "input_birthdate": "",
      "input_email": "",
      "input_phone": "",
      "input_mobile": "",
      "input_firstname_notexists": "0",
      "input_lastname_notexists": "0",
      "input_zip_notexists": "0",
      "input_ziprange_notexists": "0",
      "input_town_notexists": "0",
      "input_street_notexists": "0",
      "input_hno_notexists": "0",
      "output_status": "HISTORY",
      "output_dwhid": "DMSCA00000000123456789",
      "output_source": "MSC",
      "output_salutation": "Herr",
      "output_acadtitle": "",
      "output_acadtitlelabel": "",
      "output_company": "  ",
      "output_name": "Doe",
      "output_firstname": "John",
      "output_careof1": "",
      "output_careof2": "",
      "output_street": "Alte Tiefenaustrasse",
      "output_streetadditional": "",
      "output_houseno": "6",
      "output_zip": "3048",
      "output_zip6": "0",
      "output_location": "Worblaufen",
      "output_countrycode": "CH",
      "output_postboxflag": "0",
      "output_postbox": "0",
      "output_postboxzip": "",
      "output_postboxzip6": "",
      "output_postboxlocation": "",
      "output_language": "GE",
      "output_addresslabel1": "",
      "output_addresslabel2": "",
      "output_addresslabel3": "",
      "output_addresslabel4": "",
      "output_addresslabel5": "",
      "output_addresslabel6": "",
      "output_lettersalutation": ""
    }
  ]
}

Datei-Download

Nach Abschluss der Verarbeitung kann das Resultat als tab-getrennte Textdatei heruntergeladen werden. Optional kann die Datei gezippt bereitgestellt werden (steuerbar über den Parameter decompress).

Die fileUniqueId muss nach Abschluss der Batch-Verarbeitung aus dem Batch-Detail übernommen werden.

Nach erfolgreicher Verarbeitung stehen drei Dateien zur Verfügung:

• Batch Log – Protokoll der Verarbeitungsschritte

• Output File – Resultate der Verarbeitung (tab-getrenntes Textfile)

• Report – Zusammenfassung der Ergebnisse und Statistiken

get

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

/addressprocessing/FileDownload

Autorisierungen

auth-key

auth-keystringErforderlich

API Key required for authorized endpoints

Abfrageparameter

idinteger · int32Optional

uidstring · uuidOptional

decompressbooleanOptionalDefault: false

Antworten

200

OK

Kein Inhalt

get

/addressprocessing/FileDownload

HTTPcURLJavaScriptPython

GET /v2/addressprocessing/FileDownload HTTP/1.1
Host: api.multisource.ch
auth-key: YOUR_API_KEY
Accept: */*

200

OK

Kein Inhalt

Beispiel-Output (tab-getrenntes Output-File)

1KB

Output-Example.txt

Öffnen

Output-Felder

Feld	Bezeichnung
input_customerId	Kunden-ID
input_uid	Unternehmens-Identifikationsnummer UID
input_chnr	Handelsregisternummer
input_egid	Eidgenössische Gebäudeidentifikator (EGID)
input_postaddressId	Postadresse-ID
input_name	Name
input_company	Firma
input_firstname	Vorname
input_street	Strasse
input_houseNo	Hausnummer
input_zip	Postleitzahl
input_location	Ort
input_birthdate	Geburtsdatum
input_email	E-Mail
input_phone	Telefonnummer
input_mobile	Mobiltelefon
input_firstname_notexists	Boolesches Feld, das angibt, ob ein Eingabefeld übergeben wurde
input_lastname_notexists
input_zip_notexists
input_ziprange_notexists
input_town_notexists
input_street_notexists
input_hno_notexists
output_status	Aktualisierungs-Status
output_dwhid	DWH-ID
output_source	Quelle
output_salutation	Anrede
output_acadtitle	Akademischer Titel
output_acadtitlelabel	Akademischer Titel
output_company	Firma
output_name	Nachname
output_firstname	Vorname
output_careof1	Care-of 1
output_careof2	Care-of 2
output_street	Strasse
output_streetadditional	Zusätzliche Strasse
output_houseno	Hausnummer
output_zip	Postleitzahl
output_zip6	Postleitzahl (6-stellig)
output_location	Ort
output_countrycode	Ländercode
output_postboxflag	Postfachadresse ja / nein
output_postbox	Postfach
output_postboxzip	Postfach PLZ
output_postboxzip6	Postfach PLZ (6-stellig)
output_postboxlocation	Postfach Ort
output_language	Sprache
output_addresslabel1	Felder für die Postanschrift, formatiert für den Briefaufdruck
output_addresslabel2
output_addresslabel3
output_addresslabel4
output_addresslabel5
output_addresslabel6
output_lettersalutation	Briefanrede
output_dub_head	Dubletten-Kopf Alle erkannten Dubletten werden in Gruppen zusammengefasst. Innerhalb jeder Gruppe wird ein Datensatz als sogenannter Group Head gekennzeichnet – bei diesem ist das Feld output_dub_head = 1. Alle weiteren Dubletten derselben Gruppe erhalten den Wert 0.
output_dub_group	Dubletten-Gruppe Eindeutige Kennung der Dubletten-Gruppe. Jede Gruppe erhält eine fortlaufende Nummer zur Identifikation.
criteria1_id	Zusatzkriterium 1 ID Falls Sie Zusatzkriterien beziehen, werden sie dem letzten Output-Feld ‘output_lettersalutation’ aufgeführt.
criteria1	Zusatzkriterium 1 Je nach Konfiguration oder Lizenz können 0 bis n Zusatzkriterien definiert werden.