sfgboxapi

<back to all web services

ProductsMetricsLookup

Requires Authentication
The following routes are available for this service:
GET/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 ProductsMetricsLookup:
    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

Python ProductsMetricsLookup DTOs

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

HTTP + XML

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

GET /products_metrics HTTP/1.1 
Host: api.sfgtec.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfProductsMetricsLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <ProductsMetricsLookupResponse>
    <BetaineMg>0</BetaineMg>
    <BetainePercRda>0</BetainePercRda>
    <CalciumMg>0</CalciumMg>
    <CalciumPercRda>0</CalciumPercRda>
    <CaloriesKc>0</CaloriesKc>
    <CaloriesPercRda>0</CaloriesPercRda>
    <CarbohydratesG>0</CarbohydratesG>
    <CarbohydratesKc>0</CarbohydratesKc>
    <CarbohydratesKj>0</CarbohydratesKj>
    <CarbohydratesPercRda>0</CarbohydratesPercRda>
    <CholineMg>0</CholineMg>
    <CholinePercRda>0</CholinePercRda>
    <CopperMg>0</CopperMg>
    <CopperPercRda>0</CopperPercRda>
    <FatG>0</FatG>
    <FatKc>0</FatKc>
    <FatKj>0</FatKj>
    <FatPercRda>0</FatPercRda>
    <FiberG>0</FiberG>
    <FluorideMg>0</FluorideMg>
    <FluoridePercRda>0</FluoridePercRda>
    <FolateMcg>0</FolateMcg>
    <FolatePercRda>0</FolatePercRda>
    <IronMg>0</IronMg>
    <IronPercRda>0</IronPercRda>
    <KilojoulesKj>0</KilojoulesKj>
    <MagnesiumMg>0</MagnesiumMg>
    <MagnesiumPercRda>0</MagnesiumPercRda>
    <MangeneseMg>0</MangeneseMg>
    <MangenesePercRda>0</MangenesePercRda>
    <MonoG>0</MonoG>
    <NiacinMg>0</NiacinMg>
    <NiacinPercRda>0</NiacinPercRda>
    <Omega3Mg>0</Omega3Mg>
    <Omega6Mg>0</Omega6Mg>
    <PanthenicAcidMg>0</PanthenicAcidMg>
    <PanthenicAcidPercRda>0</PanthenicAcidPercRda>
    <PhosphorusMg>0</PhosphorusMg>
    <PhosphorusPercRda>0</PhosphorusPercRda>
    <PolyG>0</PolyG>
    <PotassiumMg>0</PotassiumMg>
    <PotassiumPercRda>0</PotassiumPercRda>
    <PriceDescription>String</PriceDescription>
    <PriceKg>0</PriceKg>
    <ProductsId>0</ProductsId>
    <ProteinG>0</ProteinG>
    <ProteinKc>0</ProteinKc>
    <ProteinKj>0</ProteinKj>
    <ProteinPercRda>0</ProteinPercRda>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <RiboflavinMg>0</RiboflavinMg>
    <RiboflavinPercRda>0</RiboflavinPercRda>
    <SaturatedG>0</SaturatedG>
    <SeleniumMcg>0</SeleniumMcg>
    <SeleniumPercRda>0</SeleniumPercRda>
    <SodiumMg>0</SodiumMg>
    <SodiumPercRda>0</SodiumPercRda>
    <StarchG>0</StarchG>
    <SugarsG>0</SugarsG>
    <TenantsId>0</TenantsId>
    <ThiaminMg>0</ThiaminMg>
    <ThiaminPercRda>0</ThiaminPercRda>
    <TransG>0</TransG>
    <VitaminAMcg>0</VitaminAMcg>
    <VitaminAPercRda>0</VitaminAPercRda>
    <VitaminB12Mcg>0</VitaminB12Mcg>
    <VitaminB12PercRda>0</VitaminB12PercRda>
    <VitaminB6Mg>0</VitaminB6Mg>
    <VitaminB6PercRda>0</VitaminB6PercRda>
    <VitaminCMg>0</VitaminCMg>
    <VitaminCPercRda>0</VitaminCPercRda>
    <VitaminDMg>0</VitaminDMg>
    <VitaminDPercRda>0</VitaminDPercRda>
    <VitaminEMg>0</VitaminEMg>
    <VitaminEPercRda>0</VitaminEPercRda>
    <VitaminKMcg>0</VitaminKMcg>
    <VitaminKPercRda>0</VitaminKPercRda>
    <ZincMg>0</ZincMg>
    <ZincPercRda>0</ZincPercRda>
    <ZonesId>0</ZonesId>
  </ProductsMetricsLookupResponse>
</ArrayOfProductsMetricsLookupResponse>