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": 0, "canMatchAnyBusinessFilter": false, "pageSize": 50, "displayLanguage": "EN", "internationalPhoneFormat": false, "detailedCounts": { "globalCounts": false, "countsPerCountry": false, "includeInfobelCategoriesCounts": false, "includeRegionsCounts": false, "includeProvincesCounts": false, "includeCitiesCounts": false, "includePostCodesCounts": false, "includeGeoLevelsCounts": false, "includeInternationalCategoriesCounts": false, "includeLocalCategoriesCounts": false, "includeAltInternationalCategoriesCounts": false, "includeImportExportAgentCodesCounts": false, "includeLegalStatusCodesCounts": false, "includeEmployeesRangesCounts": false, "includeSalesRangesCounts": false, "includeExecutiveTagsCounts": false, "includeNationalIdentificationTypeCodesCounts": false, "includeGlobalUltimateCountriesCounts": false, "includeTechnographicsCounts": false }, "returnFirstPage": false, "sortingOrder": [], "countryCodes": [ "BE" ], "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, "hasWebDomainDeduplicated": false, "hasNationalIDDeduplicated": false, "hasMobileDeduplicated": false, "hasContactDeduplicated": false, "filterOnDNCM": false, "hasLinkedIn": false, "hasLogo": false, "hasAdmin": false, "hasMarketability": false, "isPublished": false, "isVAT": false, "salesVolumeCurrency": 0, "hasShopTool": false, "hasPayment": false, "hasDigitalMarketing": false, "hasEShop": false }
  • application/xml :
    • An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Enum value '0' is invalid for type 'Kapitol.Registered.Tools.Model.DataType' and cannot be serialized. Ensure that the necessary enum values are present and are marked with EnumMemberAttribute attribute if the type has DataContractAttribute attribute.
  • text/xml :
    • An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Enum value '0' is invalid for type 'Kapitol.Registered.Tools.Model.DataType' and cannot be serialized. Ensure that the necessary enum values are present and are marked with EnumMemberAttribute attribute if the type has DataContractAttribute attribute.

    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, "hasCorporateLinkage": 0, "hasShopTool": 0, "hasPayment": 0, "hasDigitalMarketing": 0, "hasEShop": 0, "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, "resultCorporateLinkage": 0 } ], "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, "resultCorporateLinkage": 0 } ], "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, "resultCorporateLinkage": 0 } ], "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, "resultCorporateLinkage": 0 } ], "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, "resultCorporateLinkage": 0 } ], "postCodesCounts": [ { "postCode": "1180", "resultTotal": 987, "resultAddress": 965, "resultPhone": 796, "resultFax": 243, "resultMobile": 456, "resultWebsite": 402, "resultEmail": 386, "resultContact": 888, "resultAdmin": 873, "resultNationalID": 235, "resultGeolevel": 674, "resultCorporateLinkage": 0 } ], "importExportAgentCodesCounts": [ { "importExportAgentCode": "A", "resultTotal": 987, "resultAddress": 965, "resultPhone": 796, "resultFax": 243, "resultMobile": 456, "resultWebsite": 402, "resultEmail": 386, "resultContact": 888, "resultAdmin": 873, "resultNationalID": 235, "resultGeolevel": 674, "resultCorporateLinkage": 0 } ], "legalStatusCodesCounts": [ { "legalStatusCode": 3, "description": "Corporation", "resultTotal": 987, "resultAddress": 965, "resultPhone": 796, "resultFax": 243, "resultMobile": 456, "resultWebsite": 402, "resultEmail": 386, "resultContact": 888, "resultAdmin": 873, "resultNationalID": 235, "resultGeolevel": 674, "resultCorporateLinkage": 0 } ], "employeesRangesCounts": [ { "employeesRange": "5-9", "resultTotal": 987, "resultAddress": 965, "resultPhone": 796, "resultFax": 243, "resultMobile": 456, "resultWebsite": 402, "resultEmail": 386, "resultContact": 888, "resultAdmin": 873, "resultNationalID": 235, "resultGeolevel": 674, "resultCorporateLinkage": 0 } ], "salesRangesCounts": [ { "salesRange": "1B+", "resultTotal": 987, "resultAddress": 965, "resultPhone": 796, "resultFax": 243, "resultMobile": 456, "resultWebsite": 402, "resultEmail": 386, "resultContact": 888, "resultAdmin": 873, "resultNationalID": 235, "resultGeolevel": 674, "resultCorporateLinkage": 0 } ], "nationalIdentificationTypeCodesCounts": [ { "nationalIdentificationTypeCode": 10, "hasVAT": false, "resultTotal": 987, "resultAddress": 965, "resultPhone": 796, "resultFax": 243, "resultMobile": 456, "resultWebsite": 402, "resultEmail": 386, "resultContact": 888, "resultAdmin": 873, "resultNationalID": 235, "resultGeolevel": 674, "resultCorporateLinkage": 0 } ], "globalUltimateCountriesCounts": [ { "countryCode": "BE", "countryName": "Belgium", "resultTotal": 987, "resultAddress": 0, "resultPhone": 0, "resultFax": 0, "resultMobile": 0, "resultWebsite": 0, "resultEmail": 0, "resultContact": 0, "resultAdmin": 0, "resultNationalID": 0, "resultGeolevel": 0, "resultCorporateLinkage": 0 } ], "techTagsCounts": [ { "techTag": "PayPal", "resultTotal": 1000 } ] } }
  • 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> <ResultCorporateLinkage>0</ResultCorporateLinkage> <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> <ResultCorporateLinkage>0</ResultCorporateLinkage> <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" /> <EmployeesRangesCounts> <EmployeesRangeCounts> <Description i:nil="true" /> <EmployeesRange>5-9</EmployeesRange> <ResultAddress>965</ResultAddress> <ResultAdmin>873</ResultAdmin> <ResultContact>888</ResultContact> <ResultCorporateLinkage>0</ResultCorporateLinkage> <ResultEmail>386</ResultEmail> <ResultFax>243</ResultFax> <ResultGeolevel>674</ResultGeolevel> <ResultMobile>456</ResultMobile> <ResultNationalID>235</ResultNationalID> <ResultPhone>796</ResultPhone> <ResultTotal>987</ResultTotal> <ResultWebsite>402</ResultWebsite> </EmployeesRangeCounts> </EmployeesRangesCounts> <ExecutiveTagsCounts i:nil="true" /> <GeoLevelsCounts> <GeoLevelCounts> <Description>Street Segment Interpolated</Description> <GeoLevel>3</GeoLevel> <ResultAddress>965</ResultAddress> <ResultAdmin>873</ResultAdmin> <ResultContact>888</ResultContact> <ResultCorporateLinkage>0</ResultCorporateLinkage> <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> <GlobalUltimateCountriesCounts> <GlobalUltimateCountryCounts> <CountryCode>BE</CountryCode> <CountryName>Belgium</CountryName> <ResultAddress>0</ResultAddress> <ResultAdmin>0</ResultAdmin> <ResultContact>0</ResultContact> <ResultCorporateLinkage>0</ResultCorporateLinkage> <ResultEmail>0</ResultEmail> <ResultFax>0</ResultFax> <ResultGeolevel>0</ResultGeolevel> <ResultMobile>0</ResultMobile> <ResultNationalID>0</ResultNationalID> <ResultPhone>0</ResultPhone> <ResultTotal>987</ResultTotal> <ResultWebsite>0</ResultWebsite> </GlobalUltimateCountryCounts> </GlobalUltimateCountriesCounts> <HasAddress>987</HasAddress> <HasAdmin>903</HasAdmin> <HasContact>888</HasContact> <HasCorporateLinkage>0</HasCorporateLinkage> <HasDigitalMarketing>0</HasDigitalMarketing> <HasEShop>0</HasEShop> <HasEmail>438</HasEmail> <HasFax>543</HasFax> <HasGeolevel>253</HasGeolevel> <HasMobile>678</HasMobile> <HasNationalID>678</HasNationalID> <HasPayment>0</HasPayment> <HasPhone>887</HasPhone> <HasShopTool>0</HasShopTool> <HasWebsite>624</HasWebsite> <ImportExportAgentCodesCounts> <ImportExportAgentCodeCounts> <Description i:nil="true" /> <ImportExportAgentCode>A</ImportExportAgentCode> <ResultAddress>965</ResultAddress> <ResultAdmin>873</ResultAdmin> <ResultContact>888</ResultContact> <ResultCorporateLinkage>0</ResultCorporateLinkage> <ResultEmail>386</ResultEmail> <ResultFax>243</ResultFax> <ResultGeolevel>674</ResultGeolevel> <ResultMobile>456</ResultMobile> <ResultNationalID>235</ResultNationalID> <ResultPhone>796</ResultPhone> <ResultTotal>987</ResultTotal> <ResultWebsite>402</ResultWebsite> </ImportExportAgentCodeCounts> </ImportExportAgentCodesCounts> <LegalStatusCodesCounts> <LegalStatusCodeCounts> <Description>Corporation</Description> <LegalStatusCode>3</LegalStatusCode> <ResultAddress>965</ResultAddress> <ResultAdmin>873</ResultAdmin> <ResultContact>888</ResultContact> <ResultCorporateLinkage>0</ResultCorporateLinkage> <ResultEmail>386</ResultEmail> <ResultFax>243</ResultFax> <ResultGeolevel>674</ResultGeolevel> <ResultMobile>456</ResultMobile> <ResultNationalID>235</ResultNationalID> <ResultPhone>796</ResultPhone> <ResultTotal>987</ResultTotal> <ResultWebsite>402</ResultWebsite> </LegalStatusCodeCounts> </LegalStatusCodesCounts> <NationalIdentificationTypeCodesCounts> <NationalIdentificationTypeCodeCounts> <Description i:nil="true" /> <HasVAT>false</HasVAT> <NationalIdentificationTypeCode>10</NationalIdentificationTypeCode> <ResultAddress>965</ResultAddress> <ResultAdmin>873</ResultAdmin> <ResultContact>888</ResultContact> <ResultCorporateLinkage>0</ResultCorporateLinkage> <ResultEmail>386</ResultEmail> <ResultFax>243</ResultFax> <ResultGeolevel>674</ResultGeolevel> <ResultMobile>456</ResultMobile> <ResultNationalID>235</ResultNationalID> <ResultPhone>796</ResultPhone> <ResultTotal>987</ResultTotal> <ResultWebsite>402</ResultWebsite> </NationalIdentificationTypeCodeCounts> </NationalIdentificationTypeCodesCounts> <PostCodesCounts> <PostCodeCounts> <PostCode>1180</PostCode> <ResultAddress>965</ResultAddress> <ResultAdmin>873</ResultAdmin> <ResultContact>888</ResultContact> <ResultCorporateLinkage>0</ResultCorporateLinkage> <ResultEmail>386</ResultEmail> <ResultFax>243</ResultFax> <ResultGeolevel>674</ResultGeolevel> <ResultMobile>456</ResultMobile> <ResultNationalID>235</ResultNationalID> <ResultPhone>796</ResultPhone> <ResultTotal>987</ResultTotal> <ResultWebsite>402</ResultWebsite> </PostCodeCounts> </PostCodesCounts> <ProvincesCounts> <ProvinceCounts> <Code i:nil="true" /> <Province>Brussels</Province> <ResultAddress>965</ResultAddress> <ResultAdmin>873</ResultAdmin> <ResultContact>888</ResultContact> <ResultCorporateLinkage>0</ResultCorporateLinkage> <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> <ResultCorporateLinkage>0</ResultCorporateLinkage> <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> <SalesRangesCounts> <SalesRangeCounts> <Description i:nil="true" /> <ResultAddress>965</ResultAddress> <ResultAdmin>873</ResultAdmin> <ResultContact>888</ResultContact> <ResultCorporateLinkage>0</ResultCorporateLinkage> <ResultEmail>386</ResultEmail> <ResultFax>243</ResultFax> <ResultGeolevel>674</ResultGeolevel> <ResultMobile>456</ResultMobile> <ResultNationalID>235</ResultNationalID> <ResultPhone>796</ResultPhone> <ResultTotal>987</ResultTotal> <ResultWebsite>402</ResultWebsite> <SalesRange>1B+</SalesRange> </SalesRangeCounts> </SalesRangesCounts> <TechTagsCounts> <TechTagCounts> <ResultTotal>1000</ResultTotal> <TechTag>PayPal</TechTag> </TechTagCounts> </TechTagsCounts> <Total>1000</Total> </Counts> <FirstPageRecords i:nil="true" /> <SearchId>1</SearchId> </SearchResult>