POST api/search/{searchId}/records/{page}?languageCode={languageCode}&internationalPhoneFormat={internationalPhoneFormat} Authentication required
Use this method to fetch partial records returned by a search. Submit the fields (as an array of strings) you want to be returned by the api. Please note that using this method with only the fields you need may increase the performance and decrease the response time of the api.
Request
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| searchId |
Id of the search |
integer |
Required |
| page |
Page number, starting at 1 (By default you are limited to 20 pages, to access more please contact us) |
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 wanted page of records. Count of records depends on pageSize defined in the search.
Output : object (See Model)Ouput Sample
{
"searchId": 1,
"page": 1,
"recordCount": 1,
"totalRecordCount": 0,
"records": [
{
"relevanceScore": 1.0,
"uniqueID": "BE2000787467",
"universalPublicationId": "BE2000787467",
"isPublished": true,
"isBusiness": true,
"businessName": "McDonald's",
"address1": "Groenplaats 17 ",
"postCode": "2000",
"city": "Antwerpen",
"cityCode": "11002",
"locality": "",
"localityCode": "",
"province": "Antwerpen",
"provinceCode": "10000",
"region": "Vlaanderen",
"regionCode": "02000",
"country": "Belgium",
"countryCode": "BE",
"phoneOrMobile": "03 231 29 17",
"phone": "03 231 29 17",
"fax": "",
"mobile": "",
"email": "",
"website": "https://mcdonalds.be",
"geoLevel": 3,
"geoLevelDescription": "House",
"longitude": "4.4009869",
"latitude": "51.2197895",
"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": "BE0445287606",
"marketingFlag": "1",
"nativeInfos": {
"lastName1": "McDonald's",
"cityName": "Antwerpen"
}
}
]
}
<FetchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Page>1</Page>
<RecordCount>1</RecordCount>
<Records>
<Record>
<AdditionalInfos xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
<Address1>Groenplaats 17 </Address1>
<Address2 i:nil="true" />
<AddressBoxNumber i:nil="true" />
<AddressHouseNumber i:nil="true" />
<AddressStreet i:nil="true" />
<BusinessName>McDonald's</BusinessName>
<City>Antwerpen</City>
<CityCode>11002</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 i:nil="true" />
<Language>DUT</Language>
<Latitude>51.2197895</Latitude>
<Locality></Locality>
<LocalityCode></LocalityCode>
<Longitude>4.4009869</Longitude>
<MarketingFlag>1</MarketingFlag>
<Mobile></Mobile>
<NationalID>BE0445287606</NationalID>
<NativeInfos xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>LastName1</d4p1:Key>
<d4p1:Value>McDonald's</d4p1:Value>
</d4p1:KeyValueOfstringstring>
<d4p1:KeyValueOfstringstring>
<d4p1:Key>CityName</d4p1:Key>
<d4p1:Value>Antwerpen</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</NativeInfos>
<Phone>03 231 29 17</Phone>
<PhoneOrMobile>03 231 29 17</PhoneOrMobile>
<PostCode>2000</PostCode>
<Province>Antwerpen</Province>
<ProvinceCode>10000</ProvinceCode>
<Region>Vlaanderen</Region>
<RegionCode>02000</RegionCode>
<RelevanceScore>1</RelevanceScore>
<TradeName i:nil="true" />
<UniqueID>BE2000787467</UniqueID>
<UniversalPublicationId>BE2000787467</UniversalPublicationId>
<Website>https://mcdonalds.be</Website>
</Record>
</Records>
<SearchId>1</SearchId>
<TotalRecordCount>0</TotalRecordCount>
</FetchResult>