POST api/search/{searchId}/preview?languageCode={languageCode}&internationalPhoneFormat={internationalPhoneFormat} Authentication required
Use this method to fetch a partial preview of records returned by a search. The will return first page of records (max 100) so you can preview the output result.
Request
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
searchId |
Id of the search |
integer |
Required |
languageCode |
[Optional] Language represented by its ISO 639-1 Code (2 chars long). Provide this if you wish to receive the labels in another language |
string |
Default value is |
internationalPhoneFormat |
[Optional] Default if false. Set this to true if you want phone number formatted as international phone number (Starting with +xxx prefix) |
boolean |
Default value is False |
Body Parameters
List of fields to extract : simply put the fields names as strings
Input : array of StringInput Sample
[
"sample string 1",
"sample string 2"
]
<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<string>sample string 1</string>
<string>sample string 2</string>
</ArrayOfstring>
Response
Returns the preview of records.
Output : array of objects (See Model)Ouput Sample
[
{
"uniqueID": "BE100005416",
"universalPublicationId": "BE100005416",
"isPublished": true,
"businessName": "Infobel / Kapitol",
"companyName": "Infobel / Kapitol",
"tradeName": "",
"directoryName": "",
"addressStreet": "Chaussée de Saint-Job",
"addressHouseNumber": "506",
"address1": "Chaussée de Saint-Job 506",
"address2": "",
"postCode": "1180",
"city": "Uccle",
"cityCode": "21016",
"locality": "",
"localityCode": "",
"province": "Bruxelles Capitale",
"provinceCode": "99999990001",
"region": "",
"regionCode": "",
"country": "Belgium",
"countryCode": "BE",
"phoneOrMobile": "023792940",
"phone": "023792940",
"dncmPhone": false,
"fax": "023792988",
"mobile": "",
"dncmMobile": false,
"email": "",
"website": "http://www.infobel.be",
"geoLevel": 4,
"geoLevelDescription": "RoofTop",
"longitude": "4.35838065",
"latitude": "50.79234975",
"internationalCategories": [
{
"code": "7379",
"name": "Computer related services, nec",
"language": "EN",
"type": "International",
"level": 1
},
{
"code": "5099",
"name": "Durable goods, nec",
"language": "EN",
"type": "International",
"level": 1
}
],
"internationalCode01": "7379",
"internationalCode02": "5099",
"internationalCode03": "",
"internationalCode04": "",
"internationalCode05": "",
"internationalCode06": "",
"internationalLabel01": "Computer related services, nec",
"internationalLabel02": "Durable goods, nec",
"infobelCategories": [
{
"code": "016118",
"name": "Publishing Of Telephone Directories",
"language": "EN",
"type": "Infobel",
"parentCode": "016100",
"level": 3
}
],
"infobelCode01": "016118",
"infobelCode02": "",
"infobelCode03": "",
"infobelCode04": "",
"infobelCode05": "",
"infobelCode06": "",
"infobelCode07": "",
"infobelCode08": "",
"infobelCode09": "",
"infobelCode10": "",
"infobelLabel01": "Publishing Of Telephone Directories",
"localCategories": [
{
"code": "62020",
"name": "Computer consultancy activities",
"language": "EN",
"type": "Local",
"countryCode": "BE",
"level": 1
},
{
"code": "46190",
"name": "Agents involved in the sale of a variety of goods",
"language": "EN",
"type": "Local",
"countryCode": "BE",
"level": 1
}
],
"localCode01": "62020",
"localCode02": "46190",
"localCode03": "",
"localCode04": "",
"localCode05": "",
"localCode06": "",
"localCode07": "",
"localCode08": "",
"localCode09": "",
"localCode10": "",
"localCode11": "",
"localCode12": "",
"localCode13": "",
"localCode14": "",
"localCode15": "",
"localLabel01": "Computer consultancy activities",
"localLabel02": "Agents involved in the sale of a variety of goods",
"language": "FRE",
"nationalID": "BE0453604761",
"genericSocialLinks": [],
"nativeInfos": {
"stdCityCode": "21016",
"stdCityName": "Uccle",
"stdProvinceCode": "99999990001",
"stdProvinceName": "Bruxelles Capitale",
"stdStreetCode": "001180000000298",
"stdStreetName": "Chaussée de Saint-Job",
"stdStreetPostCode": "1180",
"stdStreetSegmentID": "10560000339644"
},
"additionalInfos": {
"internationalCodeType": "SIC87",
"busFlag": "0",
"namingMethod": "",
"isQualified": "",
"lastUpdateDate": "Sep 4 2024 8:31AM",
"logo": "https://ypsearch.infobelpro.com/api/record/BE/BE100005416/media/XFxzcnYtd2ViZGF0YVxDdXN0b21lcnNcQkVcQkUxMDAwMDU0MTZcMzkxNDcwOTNcSW5mb2JlbC1ibHVlLXNpdGUgKDAwNCkuanBn.jpg",
"photos": [
"https://ypsearch.infobelpro.com/api/record/BE/BE100005416/media/XFxzcnYtd2ViZGF0YVxDdXN0b21lcnNcQkVcQkUxMDAwMDU0MTZcMzkxNDcwOTNcSW5mb2JlbC1ibHVlLXNpdGUuanBn.jpg"
]
}
},
{
"uniqueID": "BE100005416",
"universalPublicationId": "BE100005416",
"isPublished": true,
"businessName": "Infobel / Kapitol",
"companyName": "Infobel / Kapitol",
"tradeName": "",
"directoryName": "",
"addressStreet": "Chaussée de Saint-Job",
"addressHouseNumber": "506",
"address1": "Chaussée de Saint-Job 506",
"address2": "",
"postCode": "1180",
"city": "Uccle",
"cityCode": "21016",
"locality": "",
"localityCode": "",
"province": "Bruxelles Capitale",
"provinceCode": "99999990001",
"region": "",
"regionCode": "",
"country": "Belgium",
"countryCode": "BE",
"phoneOrMobile": "023792940",
"phone": "023792940",
"dncmPhone": false,
"fax": "023792988",
"mobile": "",
"dncmMobile": false,
"email": "",
"website": "http://www.infobel.be",
"geoLevel": 4,
"geoLevelDescription": "RoofTop",
"longitude": "4.35838065",
"latitude": "50.79234975",
"internationalCategories": [
{
"code": "7379",
"name": "Computer related services, nec",
"language": "EN",
"type": "International",
"level": 1
},
{
"code": "5099",
"name": "Durable goods, nec",
"language": "EN",
"type": "International",
"level": 1
}
],
"internationalCode01": "7379",
"internationalCode02": "5099",
"internationalCode03": "",
"internationalCode04": "",
"internationalCode05": "",
"internationalCode06": "",
"internationalLabel01": "Computer related services, nec",
"internationalLabel02": "Durable goods, nec",
"infobelCategories": [
{
"code": "016118",
"name": "Publishing Of Telephone Directories",
"language": "EN",
"type": "Infobel",
"parentCode": "016100",
"level": 3
}
],
"infobelCode01": "016118",
"infobelCode02": "",
"infobelCode03": "",
"infobelCode04": "",
"infobelCode05": "",
"infobelCode06": "",
"infobelCode07": "",
"infobelCode08": "",
"infobelCode09": "",
"infobelCode10": "",
"infobelLabel01": "Publishing Of Telephone Directories",
"localCategories": [
{
"code": "62020",
"name": "Computer consultancy activities",
"language": "EN",
"type": "Local",
"countryCode": "BE",
"level": 1
},
{
"code": "46190",
"name": "Agents involved in the sale of a variety of goods",
"language": "EN",
"type": "Local",
"countryCode": "BE",
"level": 1
}
],
"localCode01": "62020",
"localCode02": "46190",
"localCode03": "",
"localCode04": "",
"localCode05": "",
"localCode06": "",
"localCode07": "",
"localCode08": "",
"localCode09": "",
"localCode10": "",
"localCode11": "",
"localCode12": "",
"localCode13": "",
"localCode14": "",
"localCode15": "",
"localLabel01": "Computer consultancy activities",
"localLabel02": "Agents involved in the sale of a variety of goods",
"language": "FRE",
"nationalID": "BE0453604761",
"genericSocialLinks": [],
"nativeInfos": {
"stdCityCode": "21016",
"stdCityName": "Uccle",
"stdProvinceCode": "99999990001",
"stdProvinceName": "Bruxelles Capitale",
"stdStreetCode": "001180000000298",
"stdStreetName": "Chaussée de Saint-Job",
"stdStreetPostCode": "1180",
"stdStreetSegmentID": "10560000339644"
},
"additionalInfos": {
"internationalCodeType": "SIC87",
"busFlag": "0",
"namingMethod": "",
"isQualified": "",
"lastUpdateDate": "Sep 4 2024 8:31AM",
"logo": "https://ypsearch.infobelpro.com/api/record/BE/BE100005416/media/XFxzcnYtd2ViZGF0YVxDdXN0b21lcnNcQkVcQkUxMDAwMDU0MTZcMzkxNDcwOTNcSW5mb2JlbC1ibHVlLXNpdGUgKDAwNCkuanBn.jpg",
"photos": [
"https://ypsearch.infobelpro.com/api/record/BE/BE100005416/media/XFxzcnYtd2ViZGF0YVxDdXN0b21lcnNcQkVcQkUxMDAwMDU0MTZcMzkxNDcwOTNcSW5mb2JlbC1ibHVlLXNpdGUuanBn.jpg"
]
}
}
]
An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]' with data contract name 'ArrayOfstring:http://schemas.microsoft.com/2003/10/Serialization/Arrays' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.
An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]' with data contract name 'ArrayOfstring:http://schemas.microsoft.com/2003/10/Serialization/Arrays' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.