sfgboxapi

<back to all web services

ProductsMetricsAutoQueryLookup

QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
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
QueryResponse<Tenants> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<Tenants>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
Tenants Parameters:
NameParameterData TypeRequiredDescription
IdformlongYes
MainZonesIdformlongYes
IsPublicformboolNo

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/ProductsMetricsAutoQueryLookup HTTP/1.1 
Host: api-stage.smartfarmertech.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	skip: 0,
	take: 0,
	orderBy: String,
	orderByDesc: String,
	include: String,
	fields: String,
	meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			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
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}