API/Paesi/Countries

From Smart Biogas Wiki
Jump to navigation Jump to search

◀ Torna al menù API

Elenco dei paesi utilizzati in SB

GET https://smartbiogas.it/api/v1/countries

Risultato: Json con un array di risultati

[
	{
		"eu_countries_id": id del paese,
		"f_cod": "codice di 2 cifre identificativo del paese",
		"f_description": "descrizione"
	},
	{
		"eu_countries_id": 2,
		"f_cod": "AL",
		"f_description": "Albania"
	},
	...
]


Dati del singolo paese:

GET https://smartbiogas.it/api/v1/countries/{country_id}

esempio https://smartbiogas.it/api/v1/countries/19

Risultato: stesso Json di sopra ma con un solo record


Ricerca per codice:

GET https://smartbiogas.it/api/v1/countries?f_cod={Codice paese}

esempio https://smartbiogas.it/api/v1/countries?f_cod=IT

Risultato: stesso Json di sopra ma con un solo record


Ricerca per descrizione:

GET https://smartbiogas.it/api/v1/countries?f_description={stringa da ricercare nella descrizione (multilingua)}

esempio https://smartbiogas.it/api/v1/countries?f_description=fra

Risultato: stesso Json di sopra con 0 o più records

Comuni relativi ad un paese

[edit | edit source]

Questa route porta anche alla ricerca dei comuni filtrato per il Paese attuale.

GET https://smartbiogas.it/api/v1/countries/{idPaese}/cities

definendo il paese in {idPaese} si può ottenere una lista o ricercare i comuni.

esempio https://smartbiogas.it/api/v1/countries/19/cities elenco dei comuni italiani

Risultato:

[
	{
		"eu_cities_id": idComune,
		"eu_countries_id": idPaese,
		"f_cod": "Codice del comune",
		"f_country_cod": "codice del paese",
		"f_description": "Nome del comune",
		"f_validity_zone": 1 - Nord, 2- Centro, 3-Sud, 4-Isole,
		"f_reg_description": "descrizione della regione",
		"f_prov_description": "descrizione della provincia",
		"f_cod_catasto": "Codice catastale del comune"
	},
	{
		"eu_cities_id": 60000,
		"eu_countries_id": 19,
		"f_cod": "ITC44014047",
		"f_country_cod": "IT",
		"f_description": "Pedesina",
		"f_validity_zone": 1,
		"f_reg_description": "Lombardia",
		"f_prov_description": "Sondrio",
		"f_cod_catasto": "G410"
	},
	...
]


Ricerca per idComune

GET https://smartbiogas.it/api/v1/countries/{idPaese}/cities/{$idComune}

esempio https://smartbiogas.it/api/v1/countries/19/cities/67664


Ricerca per descrizione

GET https://smartbiogas.it/api/v1/countries/{idPaese}/cities?f_description={testo da ricercare}

esempio https://smartbiogas.it/api/v1/countries/19/cities?f_description=piner


Ricerca per codice

GET https://smartbiogas.it/api/v1/countries/{idPaese}/cities?f_cod={codice}

esempio https://smartbiogas.it/api/v1/countries/19/cities?f_cod=ITC11001234