sfgboxapi

<back to all web services

ProductsMetricsAdd

Requires Authentication
The following routes are available for this service:
POST/products_metrics
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductsMetricsAddResponse:
    tenants_id: int = 0
    zones_id: int = 0
    products_id: int = 0
    price_kg: float = 0.0
    price_description: Optional[str] = None
    betaine_perc_rda: Optional[float] = None
    betaine_mg: Optional[float] = None
    calcium_perc_rda: Optional[float] = None
    calcium_mg: Optional[float] = None
    calories_perc_rda: Optional[float] = None
    calories_kc: Optional[float] = None
    carbohydrates_perc_rda: Optional[float] = None
    carbohydrates_g: Optional[float] = None
    carbohydrates_kc: Optional[float] = None
    carbohydrates_kj: Optional[float] = None
    choline_perc_rda: Optional[float] = None
    choline_mg: Optional[float] = None
    copper_perc_rda: Optional[float] = None
    copper_mg: Optional[float] = None
    fat_perc_rda: Optional[float] = None
    fat_g: Optional[float] = None
    fat_kc: Optional[float] = None
    fat_kj: Optional[float] = None
    fiber_g: Optional[float] = None
    fluoride_perc_rda: Optional[float] = None
    fluoride_mg: Optional[float] = None
    folate_perc_rda: Optional[float] = None
    folate_mcg: Optional[float] = None
    iron_perc_rda: Optional[float] = None
    iron_mg: Optional[float] = None
    kilojoules_kj: Optional[float] = None
    magnesium_perc_rda: Optional[float] = None
    magnesium_mg: Optional[float] = None
    mangenese_perc_rda: Optional[float] = None
    mangenese_mg: Optional[float] = None
    mono_g: Optional[float] = None
    niacin_perc_rda: Optional[float] = None
    niacin_mg: Optional[float] = None
    omega3_mg: Optional[float] = None
    omega6_mg: Optional[float] = None
    panthenic_acid_perc_rda: Optional[float] = None
    panthenic_acid_mg: Optional[float] = None
    phosphorus_perc_rda: Optional[float] = None
    phosphorus_mg: Optional[float] = None
    poly_g: Optional[float] = None
    potassium_perc_rda: Optional[float] = None
    potassium_mg: Optional[float] = None
    protein_perc_rda: Optional[float] = None
    protein_g: Optional[float] = None
    protein_kc: Optional[float] = None
    protein_kj: Optional[float] = None
    riboflavin_perc_rda: Optional[float] = None
    riboflavin_mg: Optional[float] = None
    saturated_g: Optional[float] = None
    selenium_perc_rda: Optional[float] = None
    selenium_mcg: Optional[float] = None
    sodium_perc_rda: Optional[float] = None
    sodium_mg: Optional[float] = None
    starch_g: Optional[float] = None
    sugars_g: Optional[float] = None
    thiamin_perc_rda: Optional[float] = None
    thiamin_mg: Optional[float] = None
    vitamin_a_perc_rda: Optional[float] = None
    vitamin_a_mcg: Optional[float] = None
    vitamin_b12_perc_rda: Optional[float] = None
    vitamin_b12_mcg: Optional[float] = None
    vitamin_b6_perc_rda: Optional[float] = None
    vitamin_b6_mg: Optional[float] = None
    vitamin_c_perc_rda: Optional[float] = None
    vitamin_c_mg: Optional[float] = None
    vitamin_d_perc_rda: Optional[float] = None
    vitamin_d_mg: Optional[float] = None
    vitamin_e_perc_rda: Optional[float] = None
    vitamin_e_mg: Optional[float] = None
    vitamin_k_perc_rda: Optional[float] = None
    vitamin_k_mcg: Optional[float] = None
    zinc_perc_rda: Optional[float] = None
    zinc_mg: Optional[float] = None
    trans_g: Optional[float] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductsMetricsAdd:
    # @Validate(Validator="NotNull")
    tenants_id: int = 0

    # @Validate(Validator="NotNull")
    zones_id: int = 0

    # @Validate(Validator="NotNull")
    products_id: int = 0

    # @Validate(Validator="NotNull")
    price_kg: float = 0.0

    # @Validate(Validator="NotNull")
    price_description: Optional[str] = None

    betaine_mg: Optional[float] = None
    calcium_mg: Optional[float] = None
    choline_mg: Optional[float] = None
    copper_mg: Optional[float] = None
    fiber_g: Optional[float] = None
    fluoride_mg: Optional[float] = None
    folate_mcg: Optional[float] = None
    iron_mg: Optional[float] = None
    magnesium_mg: Optional[float] = None
    mangenese_mg: Optional[float] = None
    mono_g: Optional[float] = None
    niacin_mg: Optional[float] = None
    omega3_mg: Optional[float] = None
    omega6_mg: Optional[float] = None
    panthenic_acid_mg: Optional[float] = None
    phosphorus_mg: Optional[float] = None
    poly_g: Optional[float] = None
    potassium_mg: Optional[float] = None
    protein_g: Optional[float] = None
    riboflavin_mg: Optional[float] = None
    saturated_g: Optional[float] = None
    selenium_mcg: Optional[float] = None
    sodium_mg: Optional[float] = None
    starch_g: Optional[float] = None
    sugars_g: Optional[float] = None
    thiamin_mg: Optional[float] = None
    vitamin_a_mcg: Optional[float] = None
    vitamin_b12_mcg: Optional[float] = None
    vitamin_b6_mg: Optional[float] = None
    vitamin_c_mg: Optional[float] = None
    vitamin_d_mg: Optional[float] = None
    vitamin_e_mg: Optional[float] = None
    vitamin_k_mcg: Optional[float] = None
    zinc_mg: Optional[float] = None
    trans_g: Optional[float] = None

Python 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
		}
	}
}