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, "pageSize": 50, "displayLanguage": "EN", "detailedCounts": false, "sortingOrder": [], "countryCodes": [ "BE" ], "infobelCodes": [ "017116" ], "postCodes": [ "1180", "1000" ], "hasPhone": true, "hasFax": false, "hasMobile": false, "hasWebsite": false, "hasEmail": false, "hasWebContact": false, "hasContact": false, "hasPhoneDeduplicated": false, "hasEmailDeduplicated": false, "hasMobileDeduplicated": false, "hasContactDeduplicated": false, "filterOnDNCM": false, "hasAdmin": false, "coordinateOptions": [], "coordinateOptionsExclusive": [] }
  • 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, "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, "resultPhone": 796, "resultFax": 243, "resultMobile": 456, "resultWebsite": 402, "resultEmail": 386, "resultContact": 888, "resultAdmin": 873, "resultNationalID": 235, "resultGeolevel": 674 } ], "provincesCounts": [ { "province": "Brussels", "resultTotal": 987, "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, "resultPhone": 796, "resultFax": 243, "resultMobile": 456, "resultWebsite": 402, "resultEmail": 386, "resultContact": 888, "resultAdmin": 873, "resultNationalID": 235, "resultGeolevel": 674 } ], "importExportAgentCodesCounts": [ { "importExportAgentCode": "A", "resultTotal": 987, "resultPhone": 796, "resultFax": 243, "resultMobile": 456, "resultWebsite": 402, "resultEmail": 386, "resultContact": 888, "resultAdmin": 873, "resultNationalID": 235, "resultGeolevel": 674 } ], "legalStatusCodesCounts": [ { "legalStatusCode": 3, "description": "Corporation", "resultTotal": 987, "resultPhone": 796, "resultFax": 243, "resultMobile": 456, "resultWebsite": 402, "resultEmail": 386, "resultContact": 888, "resultAdmin": 873, "resultNationalID": 235, "resultGeolevel": 674 } ], "employeesRangesCounts": [ { "employeesRange": "5-9", "resultTotal": 987, "resultPhone": 796, "resultFax": 243, "resultMobile": 456, "resultWebsite": 402, "resultEmail": 386, "resultContact": 888, "resultAdmin": 873, "resultNationalID": 235, "resultGeolevel": 674 } ], "salesRangesCounts": [ { "salesRange": "1B+", "resultTotal": 987, "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" /> <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> <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> <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> </EmployeesRangeCounts> </EmployeesRangesCounts> <GeoLevelsCounts> <GeoLevelCounts> <Description>Street Segment Interpolated</Description> <GeoLevel>3</GeoLevel> <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> <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> <ImportExportAgentCodesCounts> <ImportExportAgentCodeCounts> <Description i:nil="true" /> <ImportExportAgentCode>A</ImportExportAgentCode> <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> </ImportExportAgentCodeCounts> </ImportExportAgentCodesCounts> <LegalStatusCodesCounts> <LegalStatusCodeCounts> <Description>Corporation</Description> <LegalStatusCode>3</LegalStatusCode> <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> </LegalStatusCodeCounts> </LegalStatusCodesCounts> <ProvincesCounts> <ProvinceCounts> <Code i:nil="true" /> <Province>Brussels</Province> <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> <SalesRangesCounts> <SalesRangeCounts> <Description i:nil="true" /> <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> <SalesRange>1B+</SalesRange> </SalesRangeCounts> </SalesRangesCounts> <Total>1000</Total> </Counts> <SearchId>1</SearchId> </SearchResult>