EN/API/Analysis

◀ Back to API Menu

List of analyses for the plant in question

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

Result: Json with an array of results

[
	{
		"analisys_id": analysisId,
		"f_data": "Date in ISO format YYYY-MM-DD",
		"analisys_type_id": analysisTypeId,
		"soggetto_id": laboratoryId (from API/Subjects),
		"substrati_id": feedstockId,
		"f_cod": "Analysis type code"
	},
	{
		"analisys_id": 2379,
		"f_data": "2017-08-10",
		"analisys_type_id": 6,
		"soggetto_id": -1,
		"substrati_id": -1,
		"f_cod": "GA-BAS"
	},
	...
]

Single analysis details:

GET https://smartbiogas.it/api/v1/analysis/{analysisId}

Example: https://smartbiogas.it/api/v1/analysis/1136

Result: Same Json as above but with a single record and more details. There is also a field called "parametri" (parameters) containing an array of determinands.

{
	"analisys_id": 1136,
	"f_data": "2013-11-25",
	"analisys_type_id": 7,
	"soggetto_id": -1,
	"substrati_id": -1,
	"ID": 7,
	"F_Descrizione": "Emissions - analysis according to Legislative Decree 152\/2006",
	"ID_Checklist": 145,
	"substrati_analisi_id": 7,
	"set_analisi_id": 1,
	"f_cod": "FU-BAS",
	"f_substrati_cod": "FU",
	"f_substrati_description": "CHP Emissions",
	"f_set_cod": "BAS",
	"f_set_description": "Basic analysis",
	"parametri": [
		{
			"analysis_parameter_id": analysisParameterId,
			"determinand_id": INT determinandId,
			"determinand_cod": TEXT "determinand code",
			"determinand_description": "determinand description",
			"sample_type_id": sampleTypeId,
			"sample_type_cod": "sample type code",
			"sample_type_description": "sample type description",
			"f_metodo": "text reporting the methods used for the analyses",
			"f_value": DECIMAL value of the analysis,
			"unita_misura_id": measurementUnitId,
			"f_um": "measurement unit description",
			"f_note": "any notes regarding the reading"
		},
		{
			"analysis_parameter_id": 7,
			"determinand_id": 5,
			"determinand_cod": "NOx_NO2",
			"determinand_description": "Nitrogen oxides",
			"sample_type_id": 2,
			"sample_type_cod": "as-is",
			"sample_type_description": "on an as-is basis",
			"f_metodo": "Standards UNI EN 14789:2017 – UNI EN 14792:2017 – UNI EN 15058:2017",
			"unita_misura_id": 38,
			"f_value": "481.0000",
			"f_um": "mg\/Nmc",
			"f_note": "test note"
		},
		...
	]
}

Inserting an analysis

It is possible to submit an analysis by providing a JSON containing all the data via the following API.

POST https://smartbiogas.it/api/v1/analysis

In the POST request, use this format along with the X-API-TOKEN key to identify the plant.

In the f_document field, insert only a PDF document (encoded in BASE64).

{
	"f_data": DATE in ISO format,
	"analysis_type_id": analysisTypeId,
	"soggetto_id": subjectId (of the laboratory performing the analysis. Leave -1 if not specified),
	"substrati_id": feedstockId (only if the analysis is performed on a specific material, otherwise leave -1),
	"f_code": TEXT document code/number,
	"f_document": TEXT Document file encoded in BASE64,
	"parametri" :[
		{
			"analysis_parameter_id": analysisParameterId,
			"lca_unita_misura_id": measurementUnitId,
			"f_value" : DECIMAL value of the measurement in the specified unit
			
		},
		...
		
	]
}

Example:

{
	"f_data": "2026-01-31",
	"analysis_type_id": 7,
	"soggetto_id": -1,
	"substrati_id": -1,
	"f_code":"38572.024",
	"f_document":"JVBERi0xLjQKJcfsj6IKNSAwIG9iago8PC9MZW5ndGggNiAwIFIvRmlsdGVyIC9GbGF0ZURlY29kZT4....",
	"parametri" :[
		{
			"analysis_parameter_id": 7,
			"lca_unita_misura_id": 38,
			"f_value" : 0.23
			
		},
		{
			"analysis_parameter_id": 7,
			"lca_unita_misura_id": 38,
			"f_value" : 4.82
			
		}
		
	]
}