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
[
{
"relevanceScore": 1.0,
"uniqueID": "BE2001014023",
"universalPublicationId": "BE2001014023",
"isPublished": true,
"isResidential": true,
"isBusiness": true,
"businessName": "Pootemans Jeannine",
"address1": "Eikelstraat 16 ",
"postCode": "2920",
"city": "Kalmthout",
"cityCode": "11022",
"locality": "",
"localityCode": "",
"province": "Antwerpen",
"provinceCode": "10000",
"region": "Vlaanderen",
"regionCode": "02000",
"country": "Belgium",
"countryCode": "BE",
"phoneOrMobile": "03 666 42 58",
"phone": "03 666 42 58",
"fax": "",
"mobile": "",
"email": "",
"website": "",
"geoLevel": 3,
"geoLevelDescription": "House",
"longitude": "4.4724269",
"latitude": "51.3761211",
"infobelCategories": [
{
"code": "017116",
"name": "Restaurants",
"language": "EN",
"type": "Infobel",
"parentCode": "017100",
"level": 3
}
],
"infobelCode01": "017116",
"infobelCode02": "",
"infobelCode03": "",
"infobelCode04": "",
"infobelCode05": "",
"infobelCode06": "",
"infobelCode07": "",
"infobelCode08": "",
"infobelCode09": "",
"infobelCode10": "",
"infobelLabel01": "Restaurants",
"language": "DUT",
"nationalID": "BE0631253630",
"marketingFlag": "1",
"nativeInfos": {
"lastName1": "Pootemans",
"firstName1": "Jeannine",
"cityName": "Kalmthout"
}
},
{
"relevanceScore": 1.0,
"uniqueID": "BE2001014023",
"universalPublicationId": "BE2001014023",
"isPublished": true,
"isResidential": true,
"isBusiness": true,
"businessName": "Pootemans Jeannine",
"address1": "Eikelstraat 16 ",
"postCode": "2920",
"city": "Kalmthout",
"cityCode": "11022",
"locality": "",
"localityCode": "",
"province": "Antwerpen",
"provinceCode": "10000",
"region": "Vlaanderen",
"regionCode": "02000",
"country": "Belgium",
"countryCode": "BE",
"phoneOrMobile": "03 666 42 58",
"phone": "03 666 42 58",
"fax": "",
"mobile": "",
"email": "",
"website": "",
"geoLevel": 3,
"geoLevelDescription": "House",
"longitude": "4.4724269",
"latitude": "51.3761211",
"infobelCategories": [
{
"code": "017116",
"name": "Restaurants",
"language": "EN",
"type": "Infobel",
"parentCode": "017100",
"level": 3
}
],
"infobelCode01": "017116",
"infobelCode02": "",
"infobelCode03": "",
"infobelCode04": "",
"infobelCode05": "",
"infobelCode06": "",
"infobelCode07": "",
"infobelCode08": "",
"infobelCode09": "",
"infobelCode10": "",
"infobelLabel01": "Restaurants",
"language": "DUT",
"nationalID": "BE0631253630",
"marketingFlag": "1",
"nativeInfos": {
"lastName1": "Pootemans",
"firstName1": "Jeannine",
"cityName": "Kalmthout"
}
}
]
<ArrayOfRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Record>
<AdditionalInfos xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<Address1>Eikelstraat 16 </Address1>
<Address2 i:nil="true" />
<AddressBoxNumber i:nil="true" />
<AddressHouseNumber i:nil="true" />
<AddressStreet i:nil="true" />
<BusinessName>Pootemans Jeannine</BusinessName>
<City>Kalmthout</City>
<CityCode>11022</CityCode>
<CompanyName i:nil="true" />
<Country>Belgium</Country>
<CountryCode>BE</CountryCode>
<DNCMMobile i:nil="true" />
<DNCMPhone i:nil="true" />
<DirectoryName i:nil="true" />
<Email></Email>
<Fax></Fax>
<GeoLevel>3</GeoLevel>
<GeoLevelDescription>House</GeoLevelDescription>
<InfobelCategories>
<Category>
<Code>017116</Code>
<CountryCode i:nil="true" />
<Language>EN</Language>
<Level>3</Level>
<Name>Restaurants</Name>
<ParentCode>017100</ParentCode>
<Type>Infobel</Type>
</Category>
</InfobelCategories>
<InfobelCode01>017116</InfobelCode01>
<InfobelCode02></InfobelCode02>
<InfobelCode03></InfobelCode03>
<InfobelCode04></InfobelCode04>
<InfobelCode05></InfobelCode05>
<InfobelCode06></InfobelCode06>
<InfobelCode07></InfobelCode07>
<InfobelCode08></InfobelCode08>
<InfobelCode09></InfobelCode09>
<InfobelCode10></InfobelCode10>
<InfobelLabel01>Restaurants</InfobelLabel01>
<InfobelLabel02 i:nil="true" />
<InfobelLabel03 i:nil="true" />
<InfobelLabel04 i:nil="true" />
<InfobelLabel05 i:nil="true" />
<InfobelLabel06 i:nil="true" />
<InfobelLabel07 i:nil="true" />
<InfobelLabel08 i:nil="true" />
<InfobelLabel09 i:nil="true" />
<InfobelLabel10 i:nil="true" />
<IsBusiness>true</IsBusiness>
<IsPublished>true</IsPublished>
<IsResidential>true</IsResidential>
<Language>DUT</Language>
<Latitude>51.3761211</Latitude>
<Locality></Locality>
<LocalityCode></LocalityCode>
<Longitude>4.4724269</Longitude>
<MarketingFlag>1</MarketingFlag>
<Mobile></Mobile>
<NationalID>BE0631253630</NationalID>
<NativeInfos xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>LastName1</d3p1:Key>
<d3p1:Value>Pootemans</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>FirstName1</d3p1:Key>
<d3p1:Value>Jeannine</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>CityName</d3p1:Key>
<d3p1:Value>Kalmthout</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</NativeInfos>
<Phone>03 666 42 58</Phone>
<PhoneOrMobile>03 666 42 58</PhoneOrMobile>
<PostCode>2920</PostCode>
<Province>Antwerpen</Province>
<ProvinceCode>10000</ProvinceCode>
<Region>Vlaanderen</Region>
<RegionCode>02000</RegionCode>
<RelevanceScore>1</RelevanceScore>
<TradeName i:nil="true" />
<UniqueID>BE2001014023</UniqueID>
<UniversalPublicationId>BE2001014023</UniversalPublicationId>
<Website></Website>
</Record>
<Record>
<AdditionalInfos xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<Address1>Eikelstraat 16 </Address1>
<Address2 i:nil="true" />
<AddressBoxNumber i:nil="true" />
<AddressHouseNumber i:nil="true" />
<AddressStreet i:nil="true" />
<BusinessName>Pootemans Jeannine</BusinessName>
<City>Kalmthout</City>
<CityCode>11022</CityCode>
<CompanyName i:nil="true" />
<Country>Belgium</Country>
<CountryCode>BE</CountryCode>
<DNCMMobile i:nil="true" />
<DNCMPhone i:nil="true" />
<DirectoryName i:nil="true" />
<Email></Email>
<Fax></Fax>
<GeoLevel>3</GeoLevel>
<GeoLevelDescription>House</GeoLevelDescription>
<InfobelCategories>
<Category>
<Code>017116</Code>
<CountryCode i:nil="true" />
<Language>EN</Language>
<Level>3</Level>
<Name>Restaurants</Name>
<ParentCode>017100</ParentCode>
<Type>Infobel</Type>
</Category>
</InfobelCategories>
<InfobelCode01>017116</InfobelCode01>
<InfobelCode02></InfobelCode02>
<InfobelCode03></InfobelCode03>
<InfobelCode04></InfobelCode04>
<InfobelCode05></InfobelCode05>
<InfobelCode06></InfobelCode06>
<InfobelCode07></InfobelCode07>
<InfobelCode08></InfobelCode08>
<InfobelCode09></InfobelCode09>
<InfobelCode10></InfobelCode10>
<InfobelLabel01>Restaurants</InfobelLabel01>
<InfobelLabel02 i:nil="true" />
<InfobelLabel03 i:nil="true" />
<InfobelLabel04 i:nil="true" />
<InfobelLabel05 i:nil="true" />
<InfobelLabel06 i:nil="true" />
<InfobelLabel07 i:nil="true" />
<InfobelLabel08 i:nil="true" />
<InfobelLabel09 i:nil="true" />
<InfobelLabel10 i:nil="true" />
<IsBusiness>true</IsBusiness>
<IsPublished>true</IsPublished>
<IsResidential>true</IsResidential>
<Language>DUT</Language>
<Latitude>51.3761211</Latitude>
<Locality></Locality>
<LocalityCode></LocalityCode>
<Longitude>4.4724269</Longitude>
<MarketingFlag>1</MarketingFlag>
<Mobile></Mobile>
<NationalID>BE0631253630</NationalID>
<NativeInfos xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>LastName1</d3p1:Key>
<d3p1:Value>Pootemans</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>FirstName1</d3p1:Key>
<d3p1:Value>Jeannine</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>CityName</d3p1:Key>
<d3p1:Value>Kalmthout</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</NativeInfos>
<Phone>03 666 42 58</Phone>
<PhoneOrMobile>03 666 42 58</PhoneOrMobile>
<PostCode>2920</PostCode>
<Province>Antwerpen</Province>
<ProvinceCode>10000</ProvinceCode>
<Region>Vlaanderen</Region>
<RegionCode>02000</RegionCode>
<RelevanceScore>1</RelevanceScore>
<TradeName i:nil="true" />
<UniqueID>BE2001014023</UniqueID>
<UniversalPublicationId>BE2001014023</UniversalPublicationId>
<Website></Website>
</Record>
</ArrayOfRecord>