sfgboxapi

<back to all web services

ProductsMetricsAutoQueryAdd

ProductsMetricsAutoQueryAdd Parameters:
NameParameterData TypeRequiredDescription
TenantsIdquerylongNo
ZonesIdquerylongNo
ProductsIdquerylongNo
PriceKgquerydoubleNo
PriceDescriptionquerystringNo
BetainePercRdaquerydouble?No
BetaineMgquerydouble?No
CalciumPercRdaquerydouble?No
CalciumMgquerydouble?No
CaloriesPercRdaquerydouble?No
CaloriesKcquerydouble?No
CarbohydratesPercRdaquerydouble?No
CarbohydratesGquerydouble?No
CarbohydratesKcquerydouble?No
CarbohydratesKjquerydouble?No
CholinePercRdaquerydouble?No
CholineMgquerydouble?No
CopperPercRdaquerydouble?No
CopperMgquerydouble?No
FatPercRdaquerydouble?No
FatGquerydouble?No
FatKcquerydouble?No
FatKjquerydouble?No
FiberGquerydouble?No
FluoridePercRdaquerydouble?No
FluorideMgquerydouble?No
FolatePercRdaquerydouble?No
FolateMcgquerydouble?No
IronPercRdaquerydouble?No
IronMgquerydouble?No
KilojoulesKjquerydouble?No
MagnesiumPercRdaquerydouble?No
MagnesiumMgquerydouble?No
MangenesePercRdaquerydouble?No
MangeneseMgquerydouble?No
MonoGquerydouble?No
NiacinPercRdaquerydouble?No
NiacinMgquerydouble?No
Omega3Mgquerydouble?No
Omega6Mgquerydouble?No
PanthenicAcidPercRdaquerydouble?No
PanthenicAcidMgquerydouble?No
PhosphorusPercRdaquerydouble?No
PhosphorusMgquerydouble?No
PolyGquerydouble?No
PotassiumPercRdaquerydouble?No
PotassiumMgquerydouble?No
ProteinPercRdaquerydouble?No
ProteinGquerydouble?No
ProteinKcquerydouble?No
ProteinKjquerydouble?No
RiboflavinPercRdaquerydouble?No
RiboflavinMgquerydouble?No
SaturatedGquerydouble?No
SeleniumPercRdaquerydouble?No
SeleniumMcgquerydouble?No
SodiumPercRdaquerydouble?No
SodiumMgquerydouble?No
StarchGquerydouble?No
SugarsGquerydouble?No
ThiaminPercRdaquerydouble?No
ThiaminMgquerydouble?No
VitaminAPercRdaquerydouble?No
VitaminAMcgquerydouble?No
VitaminB12PercRdaquerydouble?No
VitaminB12Mcgquerydouble?No
VitaminB6PercRdaquerydouble?No
VitaminB6Mgquerydouble?No
VitaminCPercRdaquerydouble?No
VitaminCMgquerydouble?No
VitaminDPercRdaquerydouble?No
VitaminDMgquerydouble?No
VitaminEPercRdaquerydouble?No
VitaminEMgquerydouble?No
VitaminKPercRdaquerydouble?No
VitaminKMcgquerydouble?No
ZincPercRdaquerydouble?No
ZincMgquerydouble?No
TransGquerydouble?No
ResponseStatusqueryResponseStatusNo
ProductsMetrics Parameters:
NameParameterData TypeRequiredDescription
IdformlongYes
TenantsIdformlongYes
ZonesIdformlongYes
ProductsIdformlongYes
PriceKgformdoubleYes
PriceDescriptionformstringYes
BetaineMgformdouble?No
CalciumMgformdouble?No
CholineMgformdouble?No
CopperMgformdouble?No
FiberGformdouble?No
FluorideMgformdouble?No
FolateMcgformdouble?No
IronMgformdouble?No
MagnesiumMgformdouble?No
MangeneseMgformdouble?No
MonoGformdouble?No
NiacinMgformdouble?No
Omega3Mgformdouble?No
Omega6Mgformdouble?No
PanthenicAcidMgformdouble?No
PhosphorusMgformdouble?No
PolyGformdouble?No
PotassiumMgformdouble?No
ProteinGformdouble?No
RiboflavinMgformdouble?No
SaturatedGformdouble?No
SeleniumMcgformdouble?No
SodiumMgformdouble?No
StarchGformdouble?No
SugarsGformdouble?No
ThiaminMgformdouble?No
VitaminAMcgformdouble?No
VitaminB12Mcgformdouble?No
VitaminB6Mgformdouble?No
VitaminCMgformdouble?No
VitaminDMgformdouble?No
VitaminEMgformdouble?No
VitaminKMcgformdouble?No
ZincMgformdouble?No
TransGformdouble?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/ProductsMetricsAutoQueryAdd HTTP/1.1 
Host: api-stage.smartfarmertech.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	tenantsId: 0,
	zonesId: 0,
	productsId: 0,
	priceKg: 0,
	priceDescription: String,
	betainePercRda: 0,
	betaineMg: 0,
	calciumPercRda: 0,
	calciumMg: 0,
	caloriesPercRda: 0,
	caloriesKc: 0,
	carbohydratesPercRda: 0,
	carbohydratesG: 0,
	carbohydratesKc: 0,
	carbohydratesKj: 0,
	cholinePercRda: 0,
	cholineMg: 0,
	copperPercRda: 0,
	copperMg: 0,
	fatPercRda: 0,
	fatG: 0,
	fatKc: 0,
	fatKj: 0,
	fiberG: 0,
	fluoridePercRda: 0,
	fluorideMg: 0,
	folatePercRda: 0,
	folateMcg: 0,
	ironPercRda: 0,
	ironMg: 0,
	kilojoulesKj: 0,
	magnesiumPercRda: 0,
	magnesiumMg: 0,
	mangenesePercRda: 0,
	mangeneseMg: 0,
	monoG: 0,
	niacinPercRda: 0,
	niacinMg: 0,
	omega3Mg: 0,
	omega6Mg: 0,
	panthenicAcidPercRda: 0,
	panthenicAcidMg: 0,
	phosphorusPercRda: 0,
	phosphorusMg: 0,
	polyG: 0,
	potassiumPercRda: 0,
	potassiumMg: 0,
	proteinPercRda: 0,
	proteinG: 0,
	proteinKc: 0,
	proteinKj: 0,
	riboflavinPercRda: 0,
	riboflavinMg: 0,
	saturatedG: 0,
	seleniumPercRda: 0,
	seleniumMcg: 0,
	sodiumPercRda: 0,
	sodiumMg: 0,
	starchG: 0,
	sugarsG: 0,
	thiaminPercRda: 0,
	thiaminMg: 0,
	vitaminAPercRda: 0,
	vitaminAMcg: 0,
	vitaminB12PercRda: 0,
	vitaminB12Mcg: 0,
	vitaminB6PercRda: 0,
	vitaminB6Mg: 0,
	vitaminCPercRda: 0,
	vitaminCMg: 0,
	vitaminDPercRda: 0,
	vitaminDMg: 0,
	vitaminEPercRda: 0,
	vitaminEMg: 0,
	vitaminKPercRda: 0,
	vitaminKMcg: 0,
	zincPercRda: 0,
	zincMg: 0,
	transG: 0,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	tenantsId: 0,
	zonesId: 0,
	productsId: 0,
	priceKg: 0,
	priceDescription: String,
	betaineMg: 0,
	calciumMg: 0,
	cholineMg: 0,
	copperMg: 0,
	fiberG: 0,
	fluorideMg: 0,
	folateMcg: 0,
	ironMg: 0,
	magnesiumMg: 0,
	mangeneseMg: 0,
	monoG: 0,
	niacinMg: 0,
	omega3Mg: 0,
	omega6Mg: 0,
	panthenicAcidMg: 0,
	phosphorusMg: 0,
	polyG: 0,
	potassiumMg: 0,
	proteinG: 0,
	riboflavinMg: 0,
	saturatedG: 0,
	seleniumMcg: 0,
	sodiumMg: 0,
	starchG: 0,
	sugarsG: 0,
	thiaminMg: 0,
	vitaminAMcg: 0,
	vitaminB12Mcg: 0,
	vitaminB6Mg: 0,
	vitaminCMg: 0,
	vitaminDMg: 0,
	vitaminEMg: 0,
	vitaminKMcg: 0,
	zincMg: 0,
	transG: 0
}