Data Output
The results are provided either as a JSON response or as a file download. Both options contain identical output fields and structures.
JSON output
The results can be retrieved directly as a JSON object.
Please enter a valid token
OK
No content
GET /v2/AddressProcessing/GetRecords HTTP/1.1
Host: api.multisource.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
No content
Example 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": ""
}
]
}File download
After processing is complete, the result can be downloaded as a tab-separated text file.
Optionally, the file can be delivered as a zipped archive (controlled via the decompress parameter).
Please enter a valid token
OK
No content
GET /v2/AddressProcessing/FileDownload HTTP/1.1
Host: api.multisource.ch
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
OK
No content
Example output (tab-separated output file)
Output fields
input_customerId
Customer ID
input_uid
Company Identification Number (UID)
input_chnr
Commercial Register Number
input_egid
Federal Building Identifier (EGID)
input_postaddressId
Postal Address ID
input_name
Name
input_company
Company
input_firstname
First Name
input_street
Street
input_houseNo
House Number
input_zip
Postal Code
input_location
City
input_birthdate
Date of Birth
input_email
input_phone
Phone Number
input_mobile
Mobile Phone
input_firstname_notexists
Boolean field indicating whether an input field was provided
input_lastname_notexists
input_zip_notexists
input_ziprange_notexists
input_town_notexists
input_street_notexists
input_hno_notexists
output_status
output_dwhid
DWH ID
output_source
Source
output_salutation
Salutation
output_acadtitle
Academic Title
output_acadtitlelabel
Academic Title
output_company
Company
output_name
Last Name
output_firstname
First Name
output_careof1
Care-of 1
output_careof2
Care-of 2
output_street
Street
output_streetadditional
Additional Street
output_houseno
House Number
output_zip
Postal Code
output_zip6
Postal Code (6 digits)
output_location
City
output_countrycode
Country Code
output_postboxflag
P.O. Box Address Yes / No
output_postbox
P.O. Box
output_postboxzip
P.O. Box Postal Code
output_postboxzip6
P.O. Box Postal Code (6 digits)
output_postboxlocation
P.O. Box City
output_language
Language
output_addresslabel1
Fields for the Mailing Address, formatted for Letter Printing
output_addresslabel2
output_addresslabel3
output_addresslabel4
output_addresslabel5
output_addresslabel6
output_lettersalutation
Salutation for Letter
output_dub_head
Duplicate head
All detected duplicates are grouped together. Within each group, one record is marked as the Group Head – this record has the field output_dub_head =
1.All other duplicates in the same group are assigned the value
0.
output_dub_group
Duplicate group
Unique identifier for the duplicate group. Each group is assigned a sequential number for identification.
criteria1_id
Additional Criterion 1 ID
If you reference additional criteria, they will be listed in the last output field ‘output_lettersalutation’.
criteria1
Additional Criterion 1
Depending on the configuration or license, 0 to n additional criteria can be defined.
Last updated