- POST Search
Find company records
This method allows you to search company records according to search parameters, returning a number of available results.
|query||QueryDetails||yes||Object that contains the search parameters for the registries.|
|country_code||string||no*||Code of the country where you want to search for personal data.|
|admin1_code||string||no*||Code of the region where you want to search for data.|
|admin2_code||string||no*||Code of the province where you want to search for data.|
|dipendenti||string||no*||Range of employed employees who must have the company.|
|fatturato||string||no*||Range of turnover in which the company must be included.|
|forma_giuridica_id||int||no*||Legal form identifier that the company must have.|
|macro_id||int||no*||Commodity macro-category identifier to which the company must belong.|
|micro_id||int||no*||Commodity macro-category identifier to which the company must belong.|
If successful, the response header HTTP status code will be 200 OK and the request will be answered.
If you try to get a request without authorization, you will receive an error 401 Unauthorized.
Additionally you should also handle the 400 Bad request status. For more info on HTTP status handling see dedicated section in Integration best practices page.
|data||DataResponseDetails||Present only if the API call goes to good end, it will contain the answer data.|
|success||boolean||True or false.|
|message||string||It contains a message that can be shown by the user.|
|error||int||Present only if the API call fails, it contains an error code.|
Data Response Details
|total_records||int||Total number of records contained in the system.|
|records_found||int||Number of registries filtered according to your search parameters.|
|query||object||Summary of your research object.|
|state||string||Search status: if it is successful it is "ricerva_evasa".|
|id_request||string||Identification of the research, it will then be used to make the purchase.|