Login

  • Postontarget
  • POST Fields

Looking for a field

This method allows you to find the values ​​of all allowed search parameters.

Resource

Production environment:

  • https://postontaget.com/fields/"layout"

Testing environment

  • https://test.postontarget.com/fields/"layout"

Parameters

Property name Type Required Description
layout string yes Macro field of research of values.
limit int yes Number of results to return, if set 0 returns all values.
query object no Possibility to filter the search according to the subfields of the various layouts.

Layouts and Query Filters

Layout Description Filters
country List of countries. country_code, country_name_EN, country_name_IT
admin1_geo List of regions divided by country. ID, admin1_name, admin1_name_ascii, country_code
admin2_geo List of provinces divided by region and country. ID, admin2_name, admin2_name_ascii, country_code, id_admin1
dipendenti List of number of employees per company. dipendenti
fatturato List of companies' turnover ranges in millions. fatturato
forma_giuridica List of corporate legal forms divided by country. ID, forma_giuridica, country_code
macrocategorie List of commercial macro-categories. ID, macro_name_IT, macro_name_EN
microcategorie List of micro-commercial categories divided by macro-categories. ID, micro_name_ITA, micro_name_ENG, id_macro

Request examples

Response

Response Format

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.

Request Response

Parameter Type Description
data DataResponseDetails Present only if the API call goes to good end, it will contain the answer data.
searchRecords int Number of results requested.
totalRecords int Total of the chosen layout results.
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

If the layout is "country":

Parameter Type Description
country_code string Country identifier.
country_name_EN string English name of the country.
country_name_IT string Italian name of the country.

Data Response Details

If the layout is "admin1_geo":

Parameter Type Description
ID string Region identifier.
admin1_name string Name of the region.
admin1_name_ascii string ASCII region name.
country_code string Code of the origin country.

Data Response Details

If the layout is "admin2_geo":

Parameter Type Description
ID string Identification of the province.
admin2_name string Name of the province.
admin2_name_ascii string Province name in ASCII.
country_code string Code of the origin country.
id_admin1 string Identification of the region to which it belongs.

Data Response Details

If the layout is "dipendenti":

Parameter Type Description
dipendenti string Range of employees employed in the company.

Data Response Details

If the layout is "fatturato":

Parameter Type Description
fatturato string Company turnover range.

Data Response Details

If the layout is "forma_giuridica":

Parameter Type Description
ID string Unique identifier of the legal form.
forma_giuridica string Legal form.
country_code string Code of the origin country.

Data Response Details

If the layout is "macrocategorie":

Parameter Type Description
ID string Unique identifier of the macro-category.
macro_name_IT string Italian name of the macro-category.
macro_name_EN string English name of the macro-category.

Data Response Details

If the layout is "microcategorie":

Parameter Type Description
ID string Unique identifier of the micro-category.
micro_name_ITA string Italian name of the micro-category.
micro_name_ENG string English name of the micro-category.
id_macro string Unique identifier of the macro category to which it belongs.