POST api/search Authentication required

Use this method to submit a new search. Please check the input requirements

Request

Body Parameters

Input : object (See Model)

Input Sample

  • application/json, text/json :
    • { "dataType": 3, "pageSize": 50, "displayLanguage": "EN", "internationalPhoneFormat": false, "detailedCounts": { "globalCounts": false, "countsPerCountry": false, "includeInfobelCategoriesCounts": false, "includeRegionsCounts": false, "includeProvincesCounts": false, "includeCitiesCounts": false, "includePostCodesCounts": false, "includeGeoLevelsCounts": false }, "returnFirstPage": false, "sortingOrder": [], "countryCodes": [ "BE" ], "isBusiness": false, "isResidential": false, "restrictOnMainCategory": false, "infobelCodes": [ "017116" ], "postCodes": [ "1180", "1000" ], "hasAddress": false, "hasPhone": true, "hasFax": false, "hasMobile": false, "hasWebsite": 0, "hasNationalID": 0, "hasEmail": false, "hasWebContact": false, "hasContact": false, "hasCoordinates": false, "hasPhoneDeduplicated": false, "hasEmailDeduplicated": false, "hasWebsiteDeduplicated": false, "hasNationalIDDeduplicated": false, "hasMobileDeduplicated": false, "hasContactDeduplicated": false, "filterOnDNCM": false }
  • application/xml, text/xml :
    • <SearchInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Kapitol.Registered.Tools.Model"> <BusinessName xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <BusinessNameExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <CategoriesKeywords xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <CityCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <CityCodesExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <CityNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <CoordinateOptions /> <CoordinateOptionsExclusive /> <CountryCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>BE</d2p1:string> </CountryCodes> <DetailedCounts> <CountsPerCountry>false</CountsPerCountry> <GlobalCounts>false</GlobalCounts> <IncludeCitiesCounts>false</IncludeCitiesCounts> <IncludeGeoLevelsCounts>false</IncludeGeoLevelsCounts> <IncludeInfobelCategoriesCounts>false</IncludeInfobelCategoriesCounts> <IncludePostCodesCounts>false</IncludePostCodesCounts> <IncludeProvincesCounts>false</IncludeProvincesCounts> <IncludeRegionsCounts>false</IncludeRegionsCounts> </DetailedCounts> <DisplayLanguage>EN</DisplayLanguage> <Email xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <EmailExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <FilterOnDNCM>false</FilterOnDNCM> <GeoLevels xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <GeoLevelsExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <HasAddress>false</HasAddress> <HasContact>false</HasContact> <HasContactDeduplicated>false</HasContactDeduplicated> <HasCoordinates>false</HasCoordinates> <HasEmail>false</HasEmail> <HasEmailDeduplicated>false</HasEmailDeduplicated> <HasFax>false</HasFax> <HasMobile>false</HasMobile> <HasMobileDeduplicated>false</HasMobileDeduplicated> <HasNationalID>Ignore</HasNationalID> <HasNationalIDDeduplicated>false</HasNationalIDDeduplicated> <HasPhone>true</HasPhone> <HasPhoneDeduplicated>false</HasPhoneDeduplicated> <HasWebContact>false</HasWebContact> <HasWebsite>Ignore</HasWebsite> <HasWebsiteDeduplicated>false</HasWebsiteDeduplicated> <HouseNumber i:nil="true" /> <InfobelCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>017116</d2p1:string> </InfobelCodes> <InfobelCodesExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <InternationalPhoneFormat>false</InternationalPhoneFormat> <IsBusiness>false</IsBusiness> <IsResidential>false</IsResidential> <Languages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <LanguagesExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <NationalID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <NationalIDExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <PageSize>50</PageSize> <PhoneNumber xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <PhoneNumberExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <PostCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>1180</d2p1:string> <d2p1:string>1000</d2p1:string> </PostCodes> <PostCodesExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <ProvinceCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <ProvinceCodesExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <ProvinceNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <RegionCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <RegionCodesExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <RegionNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <RestrictOnMainCategory>false</RestrictOnMainCategory> <ReturnFirstPage>false</ReturnFirstPage> <SortingOrder xmlns:d2p1="http://schemas.datacontract.org/2004/07/Kapitol.Registered.Search.Models" /> <StreetAddress i:nil="true" /> <TryAnyLocationMatch i:nil="true" /> <Website xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <WebsiteExclusive xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <Where i:nil="true" /> <Who i:nil="true" /> </SearchInput>

    Response

    Returns the id of the search submitted. You will need it for further use

    Output : object (See Model)

    Ouput Sample

  • application/json, text/json :
    • { "searchId": 1, "counts": { "total": 1000, "hasAddress": 987, "hasPhone": 887, "hasFax": 543, "hasMobile": 678, "hasWebsite": 624, "hasEmail": 438, "hasContact": 888, "hasAdmin": 903, "hasNationalID": 678, "hasGeolevel": 253, "categoriesCounts": [ { "categoryType": "Infobel", "category": "017116", "resultTotal": 987, "resultAddress": 965, "resultPhone": 796, "resultFax": 243, "resultMobile": 456, "resultWebsite": 402, "resultEmail": 386, "resultContact": 888, "resultAdmin": 873, "resultNationalID": 235, "resultGeolevel": 674 } ], "regionsCounts": [ { "region": "Brussels", "resultTotal": 987, "resultAddress": 965, "resultPhone": 796, "resultFax": 243, "resultMobile": 456, "resultWebsite": 402, "resultEmail": 386, "resultContact": 888, "resultAdmin": 873, "resultNationalID": 235, "resultGeolevel": 674 } ], "provincesCounts": [ { "province": "Brussels", "resultTotal": 987, "resultAddress": 965, "resultPhone": 796, "resultFax": 243, "resultMobile": 456, "resultWebsite": 402, "resultEmail": 386, "resultContact": 888, "resultAdmin": 873, "resultNationalID": 235, "resultGeolevel": 674 } ], "citiesCounts": [ { "city": "Brussels", "resultTotal": 987, "resultAddress": 965, "resultPhone": 796, "resultFax": 243, "resultMobile": 456, "resultWebsite": 402, "resultEmail": 386, "resultContact": 888, "resultAdmin": 873, "resultNationalID": 235, "resultGeolevel": 674 } ], "geoLevelsCounts": [ { "geoLevel": 3, "description": "Street Segment Interpolated", "resultTotal": 987, "resultAddress": 965, "resultPhone": 796, "resultFax": 243, "resultMobile": 456, "resultWebsite": 402, "resultEmail": 386, "resultContact": 888, "resultAdmin": 873, "resultNationalID": 235, "resultGeolevel": 674 } ] } }
  • application/xml, text/xml :
    • <SearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Counts> <CategoriesCounts> <CategoryCounts> <Category>017116</Category> <CategoryType>Infobel</CategoryType> <Description i:nil="true" /> <Language i:nil="true" /> <ResultAddress>965</ResultAddress> <ResultAdmin>873</ResultAdmin> <ResultContact>888</ResultContact> <ResultEmail>386</ResultEmail> <ResultFax>243</ResultFax> <ResultGeolevel>674</ResultGeolevel> <ResultMobile>456</ResultMobile> <ResultNationalID>235</ResultNationalID> <ResultPhone>796</ResultPhone> <ResultTotal>987</ResultTotal> <ResultWebsite>402</ResultWebsite> </CategoryCounts> </CategoriesCounts> <CitiesCounts> <CityCounts> <City>Brussels</City> <Code i:nil="true" /> <ResultAddress>965</ResultAddress> <ResultAdmin>873</ResultAdmin> <ResultContact>888</ResultContact> <ResultEmail>386</ResultEmail> <ResultFax>243</ResultFax> <ResultGeolevel>674</ResultGeolevel> <ResultMobile>456</ResultMobile> <ResultNationalID>235</ResultNationalID> <ResultPhone>796</ResultPhone> <ResultTotal>987</ResultTotal> <ResultWebsite>402</ResultWebsite> </CityCounts> </CitiesCounts> <CountriesCounts i:nil="true" /> <CountryCode i:nil="true" /> <CountryName i:nil="true" /> <DataType i:nil="true" /> <GeoLevelsCounts> <GeoLevelCounts> <Description>Street Segment Interpolated</Description> <GeoLevel>3</GeoLevel> <ResultAddress>965</ResultAddress> <ResultAdmin>873</ResultAdmin> <ResultContact>888</ResultContact> <ResultEmail>386</ResultEmail> <ResultFax>243</ResultFax> <ResultGeolevel>674</ResultGeolevel> <ResultMobile>456</ResultMobile> <ResultNationalID>235</ResultNationalID> <ResultPhone>796</ResultPhone> <ResultTotal>987</ResultTotal> <ResultWebsite>402</ResultWebsite> </GeoLevelCounts> </GeoLevelsCounts> <HasAddress>987</HasAddress> <HasAdmin>903</HasAdmin> <HasContact>888</HasContact> <HasEmail>438</HasEmail> <HasFax>543</HasFax> <HasGeolevel>253</HasGeolevel> <HasMobile>678</HasMobile> <HasNationalID>678</HasNationalID> <HasPhone>887</HasPhone> <HasWebsite>624</HasWebsite> <ProvincesCounts> <ProvinceCounts> <Code i:nil="true" /> <Province>Brussels</Province> <ResultAddress>965</ResultAddress> <ResultAdmin>873</ResultAdmin> <ResultContact>888</ResultContact> <ResultEmail>386</ResultEmail> <ResultFax>243</ResultFax> <ResultGeolevel>674</ResultGeolevel> <ResultMobile>456</ResultMobile> <ResultNationalID>235</ResultNationalID> <ResultPhone>796</ResultPhone> <ResultTotal>987</ResultTotal> <ResultWebsite>402</ResultWebsite> </ProvinceCounts> </ProvincesCounts> <RegionsCounts> <RegionCounts> <Code i:nil="true" /> <Region>Brussels</Region> <ResultAddress>965</ResultAddress> <ResultAdmin>873</ResultAdmin> <ResultContact>888</ResultContact> <ResultEmail>386</ResultEmail> <ResultFax>243</ResultFax> <ResultGeolevel>674</ResultGeolevel> <ResultMobile>456</ResultMobile> <ResultNationalID>235</ResultNationalID> <ResultPhone>796</ResultPhone> <ResultTotal>987</ResultTotal> <ResultWebsite>402</ResultWebsite> </RegionCounts> </RegionsCounts> <Total>1000</Total> </Counts> <FirstPageRecords i:nil="true" /> <SearchId>1</SearchId> </SearchResult>