sfgboxapi

<back to all web services

ProductsMetricsAdd

Requires Authentication
The following routes are available for this service:
POST/products_metrics
"use strict";
export class ProductsMetricsAddResponse {
    /** @param {{tenantsId?:number,zonesId?:number,productsId?:number,priceKg?:number,priceDescription?:string,betainePercRda?:number,betaineMg?:number,calciumPercRda?:number,calciumMg?:number,caloriesPercRda?:number,caloriesKc?:number,carbohydratesPercRda?:number,carbohydratesG?:number,carbohydratesKc?:number,carbohydratesKj?:number,cholinePercRda?:number,cholineMg?:number,copperPercRda?:number,copperMg?:number,fatPercRda?:number,fatG?:number,fatKc?:number,fatKj?:number,fiberG?:number,fluoridePercRda?:number,fluorideMg?:number,folatePercRda?:number,folateMcg?:number,ironPercRda?:number,ironMg?:number,kilojoulesKj?:number,magnesiumPercRda?:number,magnesiumMg?:number,mangenesePercRda?:number,mangeneseMg?:number,monoG?:number,niacinPercRda?:number,niacinMg?:number,omega3Mg?:number,omega6Mg?:number,panthenicAcidPercRda?:number,panthenicAcidMg?:number,phosphorusPercRda?:number,phosphorusMg?:number,polyG?:number,potassiumPercRda?:number,potassiumMg?:number,proteinPercRda?:number,proteinG?:number,proteinKc?:number,proteinKj?:number,riboflavinPercRda?:number,riboflavinMg?:number,saturatedG?:number,seleniumPercRda?:number,seleniumMcg?:number,sodiumPercRda?:number,sodiumMg?:number,starchG?:number,sugarsG?:number,thiaminPercRda?:number,thiaminMg?:number,vitaminAPercRda?:number,vitaminAMcg?:number,vitaminB12PercRda?:number,vitaminB12Mcg?:number,vitaminB6PercRda?:number,vitaminB6Mg?:number,vitaminCPercRda?:number,vitaminCMg?:number,vitaminDPercRda?:number,vitaminDMg?:number,vitaminEPercRda?:number,vitaminEMg?:number,vitaminKPercRda?:number,vitaminKMcg?:number,zincPercRda?:number,zincMg?:number,transG?:number,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    tenantsId;
    /** @type {number} */
    zonesId;
    /** @type {number} */
    productsId;
    /** @type {number} */
    priceKg;
    /** @type {string} */
    priceDescription;
    /** @type {?number} */
    betainePercRda;
    /** @type {?number} */
    betaineMg;
    /** @type {?number} */
    calciumPercRda;
    /** @type {?number} */
    calciumMg;
    /** @type {?number} */
    caloriesPercRda;
    /** @type {?number} */
    caloriesKc;
    /** @type {?number} */
    carbohydratesPercRda;
    /** @type {?number} */
    carbohydratesG;
    /** @type {?number} */
    carbohydratesKc;
    /** @type {?number} */
    carbohydratesKj;
    /** @type {?number} */
    cholinePercRda;
    /** @type {?number} */
    cholineMg;
    /** @type {?number} */
    copperPercRda;
    /** @type {?number} */
    copperMg;
    /** @type {?number} */
    fatPercRda;
    /** @type {?number} */
    fatG;
    /** @type {?number} */
    fatKc;
    /** @type {?number} */
    fatKj;
    /** @type {?number} */
    fiberG;
    /** @type {?number} */
    fluoridePercRda;
    /** @type {?number} */
    fluorideMg;
    /** @type {?number} */
    folatePercRda;
    /** @type {?number} */
    folateMcg;
    /** @type {?number} */
    ironPercRda;
    /** @type {?number} */
    ironMg;
    /** @type {?number} */
    kilojoulesKj;
    /** @type {?number} */
    magnesiumPercRda;
    /** @type {?number} */
    magnesiumMg;
    /** @type {?number} */
    mangenesePercRda;
    /** @type {?number} */
    mangeneseMg;
    /** @type {?number} */
    monoG;
    /** @type {?number} */
    niacinPercRda;
    /** @type {?number} */
    niacinMg;
    /** @type {?number} */
    omega3Mg;
    /** @type {?number} */
    omega6Mg;
    /** @type {?number} */
    panthenicAcidPercRda;
    /** @type {?number} */
    panthenicAcidMg;
    /** @type {?number} */
    phosphorusPercRda;
    /** @type {?number} */
    phosphorusMg;
    /** @type {?number} */
    polyG;
    /** @type {?number} */
    potassiumPercRda;
    /** @type {?number} */
    potassiumMg;
    /** @type {?number} */
    proteinPercRda;
    /** @type {?number} */
    proteinG;
    /** @type {?number} */
    proteinKc;
    /** @type {?number} */
    proteinKj;
    /** @type {?number} */
    riboflavinPercRda;
    /** @type {?number} */
    riboflavinMg;
    /** @type {?number} */
    saturatedG;
    /** @type {?number} */
    seleniumPercRda;
    /** @type {?number} */
    seleniumMcg;
    /** @type {?number} */
    sodiumPercRda;
    /** @type {?number} */
    sodiumMg;
    /** @type {?number} */
    starchG;
    /** @type {?number} */
    sugarsG;
    /** @type {?number} */
    thiaminPercRda;
    /** @type {?number} */
    thiaminMg;
    /** @type {?number} */
    vitaminAPercRda;
    /** @type {?number} */
    vitaminAMcg;
    /** @type {?number} */
    vitaminB12PercRda;
    /** @type {?number} */
    vitaminB12Mcg;
    /** @type {?number} */
    vitaminB6PercRda;
    /** @type {?number} */
    vitaminB6Mg;
    /** @type {?number} */
    vitaminCPercRda;
    /** @type {?number} */
    vitaminCMg;
    /** @type {?number} */
    vitaminDPercRda;
    /** @type {?number} */
    vitaminDMg;
    /** @type {?number} */
    vitaminEPercRda;
    /** @type {?number} */
    vitaminEMg;
    /** @type {?number} */
    vitaminKPercRda;
    /** @type {?number} */
    vitaminKMcg;
    /** @type {?number} */
    zincPercRda;
    /** @type {?number} */
    zincMg;
    /** @type {?number} */
    transG;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class ProductsMetricsAdd {
    /** @param {{tenantsId?:number,zonesId?:number,productsId?:number,priceKg?:number,priceDescription?:string,betaineMg?:number,calciumMg?:number,cholineMg?:number,copperMg?:number,fiberG?:number,fluorideMg?:number,folateMcg?:number,ironMg?:number,magnesiumMg?:number,mangeneseMg?:number,monoG?:number,niacinMg?:number,omega3Mg?:number,omega6Mg?:number,panthenicAcidMg?:number,phosphorusMg?:number,polyG?:number,potassiumMg?:number,proteinG?:number,riboflavinMg?:number,saturatedG?:number,seleniumMcg?:number,sodiumMg?:number,starchG?:number,sugarsG?:number,thiaminMg?:number,vitaminAMcg?:number,vitaminB12Mcg?:number,vitaminB6Mg?:number,vitaminCMg?:number,vitaminDMg?:number,vitaminEMg?:number,vitaminKMcg?:number,zincMg?:number,transG?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    tenantsId;
    /** @type {number} */
    zonesId;
    /** @type {number} */
    productsId;
    /** @type {number} */
    priceKg;
    /** @type {string} */
    priceDescription;
    /** @type {?number} */
    betaineMg;
    /** @type {?number} */
    calciumMg;
    /** @type {?number} */
    cholineMg;
    /** @type {?number} */
    copperMg;
    /** @type {?number} */
    fiberG;
    /** @type {?number} */
    fluorideMg;
    /** @type {?number} */
    folateMcg;
    /** @type {?number} */
    ironMg;
    /** @type {?number} */
    magnesiumMg;
    /** @type {?number} */
    mangeneseMg;
    /** @type {?number} */
    monoG;
    /** @type {?number} */
    niacinMg;
    /** @type {?number} */
    omega3Mg;
    /** @type {?number} */
    omega6Mg;
    /** @type {?number} */
    panthenicAcidMg;
    /** @type {?number} */
    phosphorusMg;
    /** @type {?number} */
    polyG;
    /** @type {?number} */
    potassiumMg;
    /** @type {?number} */
    proteinG;
    /** @type {?number} */
    riboflavinMg;
    /** @type {?number} */
    saturatedG;
    /** @type {?number} */
    seleniumMcg;
    /** @type {?number} */
    sodiumMg;
    /** @type {?number} */
    starchG;
    /** @type {?number} */
    sugarsG;
    /** @type {?number} */
    thiaminMg;
    /** @type {?number} */
    vitaminAMcg;
    /** @type {?number} */
    vitaminB12Mcg;
    /** @type {?number} */
    vitaminB6Mg;
    /** @type {?number} */
    vitaminCMg;
    /** @type {?number} */
    vitaminDMg;
    /** @type {?number} */
    vitaminEMg;
    /** @type {?number} */
    vitaminKMcg;
    /** @type {?number} */
    zincMg;
    /** @type {?number} */
    transG;
}

JavaScript ProductsMetricsAdd DTOs

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 /products_metrics HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
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: text/jsv
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
		}
	}
}