sfgboxapi

<back to all web services

ProductsMetricsAdd

Requires Authentication
The following routes are available for this service:
POST/products_metrics
ProductsMetricsAdd Parameters:
NameParameterData TypeRequiredDescription
TenantsIdbodylongYes
ZonesIdbodylongYes
ProductsIdbodylongYes
PriceKgbodydoubleYes
PriceDescriptionbodystringYes
BetaineMgbodydouble?No
CalciumMgbodydouble?No
CholineMgbodydouble?No
CopperMgbodydouble?No
FiberGbodydouble?No
FluorideMgbodydouble?No
FolateMcgbodydouble?No
IronMgbodydouble?No
MagnesiumMgbodydouble?No
MangeneseMgbodydouble?No
MonoGbodydouble?No
NiacinMgbodydouble?No
Omega3Mgbodydouble?No
Omega6Mgbodydouble?No
PanthenicAcidMgbodydouble?No
PhosphorusMgbodydouble?No
PolyGbodydouble?No
PotassiumMgbodydouble?No
ProteinGbodydouble?No
RiboflavinMgbodydouble?No
SaturatedGbodydouble?No
SeleniumMcgbodydouble?No
SodiumMgbodydouble?No
StarchGbodydouble?No
SugarsGbodydouble?No
ThiaminMgbodydouble?No
VitaminAMcgbodydouble?No
VitaminB12Mcgbodydouble?No
VitaminB6Mgbodydouble?No
VitaminCMgbodydouble?No
VitaminDMgbodydouble?No
VitaminEMgbodydouble?No
VitaminKMcgbodydouble?No
ZincMgbodydouble?No
TransGbodydouble?No
ProductsMetricsAddResponse Parameters:
NameParameterData TypeRequiredDescription
TenantsIdformlongNo
ZonesIdformlongNo
ProductsIdformlongNo
PriceKgformdoubleNo
PriceDescriptionformstringNo
BetainePercRdaformdouble?No
BetaineMgformdouble?No
CalciumPercRdaformdouble?No
CalciumMgformdouble?No
CaloriesPercRdaformdouble?No
CaloriesKcformdouble?No
CarbohydratesPercRdaformdouble?No
CarbohydratesGformdouble?No
CarbohydratesKcformdouble?No
CarbohydratesKjformdouble?No
CholinePercRdaformdouble?No
CholineMgformdouble?No
CopperPercRdaformdouble?No
CopperMgformdouble?No
FatPercRdaformdouble?No
FatGformdouble?No
FatKcformdouble?No
FatKjformdouble?No
FiberGformdouble?No
FluoridePercRdaformdouble?No
FluorideMgformdouble?No
FolatePercRdaformdouble?No
FolateMcgformdouble?No
IronPercRdaformdouble?No
IronMgformdouble?No
KilojoulesKjformdouble?No
MagnesiumPercRdaformdouble?No
MagnesiumMgformdouble?No
MangenesePercRdaformdouble?No
MangeneseMgformdouble?No
MonoGformdouble?No
NiacinPercRdaformdouble?No
NiacinMgformdouble?No
Omega3Mgformdouble?No
Omega6Mgformdouble?No
PanthenicAcidPercRdaformdouble?No
PanthenicAcidMgformdouble?No
PhosphorusPercRdaformdouble?No
PhosphorusMgformdouble?No
PolyGformdouble?No
PotassiumPercRdaformdouble?No
PotassiumMgformdouble?No
ProteinPercRdaformdouble?No
ProteinGformdouble?No
ProteinKcformdouble?No
ProteinKjformdouble?No
RiboflavinPercRdaformdouble?No
RiboflavinMgformdouble?No
SaturatedGformdouble?No
SeleniumPercRdaformdouble?No
SeleniumMcgformdouble?No
SodiumPercRdaformdouble?No
SodiumMgformdouble?No
StarchGformdouble?No
SugarsGformdouble?No
ThiaminPercRdaformdouble?No
ThiaminMgformdouble?No
VitaminAPercRdaformdouble?No
VitaminAMcgformdouble?No
VitaminB12PercRdaformdouble?No
VitaminB12Mcgformdouble?No
VitaminB6PercRdaformdouble?No
VitaminB6Mgformdouble?No
VitaminCPercRdaformdouble?No
VitaminCMgformdouble?No
VitaminDPercRdaformdouble?No
VitaminDMgformdouble?No
VitaminEPercRdaformdouble?No
VitaminEMgformdouble?No
VitaminKPercRdaformdouble?No
VitaminKMcgformdouble?No
ZincPercRdaformdouble?No
ZincMgformdouble?No
TransGformdouble?No
ResponseStatusformResponseStatusNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /products_metrics HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"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}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"tenantsId":0,"zonesId":0,"productsId":0,"priceKg":0,"priceDescription":"String","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,"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"}}}