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

NameDescriptionTypeAdditional 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 String

Input Sample

  • application/json, text/json :
  • [ "sample string 1", "sample string 2" ]
  • application/xml, text/xml :
  • <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

  • application/json, text/json :
  • [ { "uniqueID": "BE2000656526", "universalPublicationId": "BE2000656526", "isPublished": true, "isBusiness": true, "businessName": "Bar du Matin", "address1": "Chaussée d'Alsemberg 172 ", "postCode": "1190", "city": "Forest", "cityCode": "21007", "locality": "", "localityCode": "", "province": "Bruxelles Capitale", "provinceCode": "99999990001", "region": "Bruxelles Capitale", "regionCode": "04000", "country": "Belgium", "countryCode": "BE", "phoneOrMobile": "02 537 71 59", "phone": "02 537 71 59", "fax": "", "mobile": "", "email": "bardumatin@gmail.com", "website": "https://compagnieabc.be/restaurant/bar-du-matin/", "geoLevel": 3, "geoLevelDescription": "House", "longitude": "4.3421885", "latitude": "50.8215554", "infobelCategories": [ { "code": "017116", "name": "Restaurants", "type": "Infobel", "parentCode": "017100", "level": 3 } ], "infobelCode01": "017116", "infobelCode02": "", "infobelCode03": "", "infobelCode04": "", "infobelCode05": "", "infobelCode06": "", "infobelCode07": "", "infobelCode08": "", "infobelCode09": "", "infobelCode10": "", "infobelLabel01": "Restaurants", "language": "FRE", "nationalID": "BE0885381158", "marketingFlag": "1", "nativeInfos": { "lastName1": "Bar du Matin", "cityName": "Forest" } }, { "uniqueID": "BE2000656526", "universalPublicationId": "BE2000656526", "isPublished": true, "isBusiness": true, "businessName": "Bar du Matin", "address1": "Chaussée d'Alsemberg 172 ", "postCode": "1190", "city": "Forest", "cityCode": "21007", "locality": "", "localityCode": "", "province": "Bruxelles Capitale", "provinceCode": "99999990001", "region": "Bruxelles Capitale", "regionCode": "04000", "country": "Belgium", "countryCode": "BE", "phoneOrMobile": "02 537 71 59", "phone": "02 537 71 59", "fax": "", "mobile": "", "email": "bardumatin@gmail.com", "website": "https://compagnieabc.be/restaurant/bar-du-matin/", "geoLevel": 3, "geoLevelDescription": "House", "longitude": "4.3421885", "latitude": "50.8215554", "infobelCategories": [ { "code": "017116", "name": "Restaurants", "type": "Infobel", "parentCode": "017100", "level": 3 } ], "infobelCode01": "017116", "infobelCode02": "", "infobelCode03": "", "infobelCode04": "", "infobelCode05": "", "infobelCode06": "", "infobelCode07": "", "infobelCode08": "", "infobelCode09": "", "infobelCode10": "", "infobelLabel01": "Restaurants", "language": "FRE", "nationalID": "BE0885381158", "marketingFlag": "1", "nativeInfos": { "lastName1": "Bar du Matin", "cityName": "Forest" } } ]
  • application/xml, text/xml :
  • <ArrayOfRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Record> <AdditionalInfos xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <Address1>Chaussée d'Alsemberg 172 </Address1> <Address2 i:nil="true" /> <AddressBoxNumber i:nil="true" /> <AddressHouseNum i:nil="true" /> <AddressStreet i:nil="true" /> <BusinessName>Bar du Matin</BusinessName> <City>Forest</City> <CityCode>21007</CityCode> <CompanyName i:nil="true" /> <Country>Belgium</Country> <CountryCode>BE</CountryCode> <DNCMMobile i:nil="true" /> <DNCMPhone i:nil="true" /> <DirectoryName i:nil="true" /> <Email>bardumatin@gmail.com</Email> <Fax></Fax> <GeoLevel>3</GeoLevel> <GeoLevelDescription>House</GeoLevelDescription> <InfobelCategories> <Category> <Code>017116</Code> <CountryCode i:nil="true" /> <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 i:nil="true" /> <Language>FRE</Language> <Latitude>50.8215554</Latitude> <Locality></Locality> <LocalityCode></LocalityCode> <Longitude>4.3421885</Longitude> <MarketingFlag>1</MarketingFlag> <Mobile></Mobile> <NationalID>BE0885381158</NationalID> <NativeInfos xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>LastName1</d3p1:Key> <d3p1:Value>Bar du Matin</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>CityName</d3p1:Key> <d3p1:Value>Forest</d3p1:Value> </d3p1:KeyValueOfstringstring> </NativeInfos> <Phone>02 537 71 59</Phone> <PhoneOrMobile>02 537 71 59</PhoneOrMobile> <PostCode>1190</PostCode> <Province>Bruxelles Capitale</Province> <ProvinceCode>99999990001</ProvinceCode> <Region>Bruxelles Capitale</Region> <RegionCode>04000</RegionCode> <TradeName i:nil="true" /> <UniqueID>BE2000656526</UniqueID> <UniversalPublicationId>BE2000656526</UniversalPublicationId> <Website>https://compagnieabc.be/restaurant/bar-du-matin/</Website> </Record> <Record> <AdditionalInfos xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <Address1>Chaussée d'Alsemberg 172 </Address1> <Address2 i:nil="true" /> <AddressBoxNumber i:nil="true" /> <AddressHouseNum i:nil="true" /> <AddressStreet i:nil="true" /> <BusinessName>Bar du Matin</BusinessName> <City>Forest</City> <CityCode>21007</CityCode> <CompanyName i:nil="true" /> <Country>Belgium</Country> <CountryCode>BE</CountryCode> <DNCMMobile i:nil="true" /> <DNCMPhone i:nil="true" /> <DirectoryName i:nil="true" /> <Email>bardumatin@gmail.com</Email> <Fax></Fax> <GeoLevel>3</GeoLevel> <GeoLevelDescription>House</GeoLevelDescription> <InfobelCategories> <Category> <Code>017116</Code> <CountryCode i:nil="true" /> <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 i:nil="true" /> <Language>FRE</Language> <Latitude>50.8215554</Latitude> <Locality></Locality> <LocalityCode></LocalityCode> <Longitude>4.3421885</Longitude> <MarketingFlag>1</MarketingFlag> <Mobile></Mobile> <NationalID>BE0885381158</NationalID> <NativeInfos xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>LastName1</d3p1:Key> <d3p1:Value>Bar du Matin</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>CityName</d3p1:Key> <d3p1:Value>Forest</d3p1:Value> </d3p1:KeyValueOfstringstring> </NativeInfos> <Phone>02 537 71 59</Phone> <PhoneOrMobile>02 537 71 59</PhoneOrMobile> <PostCode>1190</PostCode> <Province>Bruxelles Capitale</Province> <ProvinceCode>99999990001</ProvinceCode> <Region>Bruxelles Capitale</Region> <RegionCode>04000</RegionCode> <TradeName i:nil="true" /> <UniqueID>BE2000656526</UniqueID> <UniversalPublicationId>BE2000656526</UniversalPublicationId> <Website>https://compagnieabc.be/restaurant/bar-du-matin/</Website> </Record> </ArrayOfRecord>