Name | Description | Type | Additional information |
---|---|---|---|
DataType |
DataType for BizSearch is Business |
enum (See Model) |
None. |
PageSize |
Specify the count of records you will fetch by http request. Default is 50 (To specify a bigger page size please contact us) |
integer |
None. |
DisplayLanguage |
Specify the language to use for categories labels. Default values is EN |
string |
None. |
InternationalPhoneFormat |
Set this to true if you want phone number formatted as international phone number (Starting with +xxx prefix). Default values is false |
boolean |
None. |
DetailedCounts |
You can ask for fully detailed counts : you will get full distinct counts for each category and province, but be aware that this can have a significant impact on response time. False by default |
object (See Model) |
None. |
ReturnFirstPage |
You can ask for the first page of records to be returned along side result counts. The count of records is defined by the PageSize attribute. False by default |
boolean |
None. |
SortingOrder |
Specify sorting order when fetching records |
array of SortingOrder (See Enum) |
None. |
CountryCodes |
Specify for which country(ies) you want to search. If no country is provided, the search will be run on all countries available |
array of String |
None. |
Who |
A single field to search records based on their business name, categoryor phone (like you would do on infobel.com) |
string |
None. |
Where |
A single field to search records based on their location, including city name and post code (like you would do on infobel.com) |
string |
None. |
TryAnyLocationMatch |
When Where is provided and not an exact location can be found, uses any that partially matches |
boolean |
None. |
IsBusiness |
Filter only records flagged as Business (WP only) |
boolean |
None. |
IsResidential |
Filter only records flagged as Residential (WP only) |
boolean |
None. |
BusinessName |
Filter records on the business name |
array of String |
None. |
BusinessNameExclusive |
Exclude records on the business name |
array of String |
None. |
Languages |
Filter records on the business language. Languages represented by their ISO 639-3 Code (3 chars long) |
array of String |
None. |
LanguagesExclusive |
Exclude records on the business language. Languages represented by their ISO 639-3 Code (3 chars long) |
array of String |
None. |
CityCodes |
Filter records on Cities. You can find City codes using the appropriate method available in the api, see GET api/locations/{countryCode}/cities |
array of String |
None. |
CityNames |
Filter records on Cities providing cities names |
array of String |
None. |
CityCodesExclusive |
Exclude records on Cities. You can find City codes using the appropriate method available in the api, see GET api/locations/{countryCode}/cities |
array of String |
None. |
ProvinceCodes |
Filter records on Provinces. You can find Province codes using the appropriate method available in the api, see GET api/locations/{countryCode}/provinces |
array of String |
None. |
ProvinceNames |
Filter records on Provinces providing provinces names |
array of String |
None. |
ProvinceCodesExclusive |
Exclude records on Provinces. You can find Province codes using the appropriate method available in the api, see GET api/locations/{countryCode}/provinces |
array of String |
None. |
RegionCodes |
Filter records on Regions. You can find Region codes using the appropriate method available in the api, see GET api/locations/{countryCode}/regions |
array of String |
None. |
RegionNames |
Filter records on Regions providing regions names |
array of String |
None. |
RegionCodesExclusive |
Exclude records on Regions. You can find Region codes using the appropriate method available in the api, see GET api/locations/{countryCode}/regions |
array of String |
None. |
CategoriesKeywords |
Filter records on Infobel categories providing categories keywords |
array of String |
None. |
RestrictOnMainCategory |
If any category filter is provided (Infobel, International, AltInternational or Local Codes), the search will be restricted to match only the primary (xxxCode01) |
boolean |
None. |
InfobelCodes |
Filter records on Infobel categories. You can find Infobel codes using the appropriate method available in the api, see GET api/categories/infobel/{language} |
array of String |
None. |
InfobelCodesExclusive |
Exclude records on Infobel categories. You can find Infobel codes using the appropriate method available in the api, see GET api/categories/infobel/{language} |
array of String |
None. |
PostCodes |
Filter records on Postal codes |
array of String |
None. |
PostCodesExclusive |
Exclude records on Postal codes |
array of String |
None. |
HasAddress |
Filter only records having an Address1 |
boolean |
None. |
HasPhone |
Filter only records having a Phone number |
boolean |
None. |
HasFax |
Filter only records having a Fax number |
boolean |
None. |
HasMobile |
Filter only records having a Mobile number |
boolean |
None. |
HasWebsite |
Filter only records having a Website url (Has) or having no Website url (HasNot) |
enum (See Model) |
None. |
HasNationalID |
Filter only records having a NationalID |
enum (See Model) |
None. |
HasEmail |
Filter only records having an Email address |
boolean |
None. |
HasWebContact |
Filter only records having either a Website url or an Email address. Can only be set if both HasWebsite and HasEmail are not set |
boolean |
None. |
HasContact |
Filter only records having either a Phone number or a Mobile number. Can only be set if both HasPhone and HasMobile are not set |
boolean |
None. |
HasCoordinates |
Filter only records having Latitude and Longitude to be positionnable on a map |
boolean |
None. |
HasPhoneDeduplicated |
Will force the search to deduplicate on Phone number: in case the search returns records having the same Phone number, this flag will force to only take the best one. Can only be set if HasPhone is set |
boolean |
None. |
HasEmailDeduplicated |
Will force the search to deduplicate on Email address: in case the search returns records having the same Email address, this flag will force to only take the best one. Can only be set if HasEmail is set |
boolean |
None. |
HasWebsiteDeduplicated |
Will force the search to deduplicate on Website address: in case the search returns records having the same Website address, this flag will force to only take the best one. Can only be set if HasWebsite is set |
boolean |
None. |
HasNationalIDDeduplicated |
Will force the search to deduplicate on NationalID: in case the search returns records having the same national ID, this flag will force to only take the best one. Can only be set if HasNationalID is set |
boolean |
None. |
HasMobileDeduplicated |
Will force the search to deduplicate on Mobile number: in case the search returns records having the same Mobile number, this flag will force to only take the best one. Can only be set if HasMobile is set |
boolean |
None. |
HasContactDeduplicated |
Will force the search to deduplicate on Contact number (Phone number if a Phone number is present, Mobile number if not): in case the search returns records having the same Contact number, this flag will force to only take the best one. Can only be set if HasContact is set |
boolean |
None. |
FilterOnDNCM |
Will exclude all the records present in the DoNotCallMe database. Only available for BE |
boolean |
None. |
GeoLevels |
Filter records on the GeoLevel |
array of Int32 |
None. |
GeoLevelsExclusive |
Exclude records based on their GeoLevel |
array of Int32 |
None. |
CoordinateOptions |
Filter only records located in the circle calculated by its center and radius (in meters) |
array of objects (See Model) |
None. |
CoordinateOptionsExclusive |
Exclude records located in the circle calculated by its center and radius (in meters) |
array of objects (See Model) |
None. |
Filter records on the email address |
array of String |
None. |
|
EmailExclusive |
Exclude records on the email address |
array of String |
None. |
Website |
Filter on the website url |
array of String |
None. |
WebsiteExclusive |
Exclude records on the website url |
array of String |
None. |
NationalID |
Filter on the national ID |
array of String |
None. |
NationalIDExclusive |
Exclude records on the national ID |
array of String |
None. |
PhoneNumber |
Filter businesses on the phone number |
array of String |
None. |
PhoneNumberExclusive |
Exclude records on the phone number |
array of String |
None. |
StreetAddress |
Filter businesses on the street |
string |
None. |
HouseNumber |
Filter businesses on the house number |
string |
None. |