sfgboxapi

<back to all web services

ProductsMetricsAutoQueryLookup

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 QueryBase:
    skip: Optional[int] = None
    take: Optional[int] = None
    order_by: Optional[str] = None
    order_by_desc: Optional[str] = None
    include: Optional[str] = None
    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb(Generic[T], QueryBase, IReturn[QueryResponse[T]]):
    @staticmethod
    def response_type(): return QueryResponse[T]


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductsMetrics:
    # @Required()
    id: int = 0

    # @Required()
    # @References(typeof(Tenants))
    tenants_id: int = 0

    # @Required()
    # @References(typeof(Zones))
    zones_id: int = 0

    # @Required()
    # @References(typeof(Products))
    products_id: int = 0

    # @Required()
    price_kg: float = 0.0

    # @Required()
    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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductsMetricsAutoQueryLookup(QueryDb[ProductsMetrics]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Tenants:
    # @Required()
    id: int = 0

    # @Required()
    # @References(typeof(Zones))
    main_zones_id: int = 0

    is_public: bool = False


Tenants = TypeVar('Tenants')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[Tenants]):
    offset: int = 0
    total: int = 0
    results: Optional[List[Tenants]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python ProductsMetricsAutoQueryLookup 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.

POST /xml/reply/ProductsMetricsAutoQueryLookup HTTP/1.1 
Host: api-stage.smartfarmertech.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProductsMetricsAutoQueryLookup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ProductsMetricsAutoQueryLookup>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfProductsMetricsZC5p8r_So xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel.Types">
    <d2p1:ProductsMetrics>
      <d2p1:BetaineMg>0</d2p1:BetaineMg>
      <d2p1:CalciumMg>0</d2p1:CalciumMg>
      <d2p1:CholineMg>0</d2p1:CholineMg>
      <d2p1:CopperMg>0</d2p1:CopperMg>
      <d2p1:FiberG>0</d2p1:FiberG>
      <d2p1:FluorideMg>0</d2p1:FluorideMg>
      <d2p1:FolateMcg>0</d2p1:FolateMcg>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IronMg>0</d2p1:IronMg>
      <d2p1:MagnesiumMg>0</d2p1:MagnesiumMg>
      <d2p1:MangeneseMg>0</d2p1:MangeneseMg>
      <d2p1:MonoG>0</d2p1:MonoG>
      <d2p1:NiacinMg>0</d2p1:NiacinMg>
      <d2p1:Omega3Mg>0</d2p1:Omega3Mg>
      <d2p1:Omega6Mg>0</d2p1:Omega6Mg>
      <d2p1:PanthenicAcidMg>0</d2p1:PanthenicAcidMg>
      <d2p1:PhosphorusMg>0</d2p1:PhosphorusMg>
      <d2p1:PolyG>0</d2p1:PolyG>
      <d2p1:PotassiumMg>0</d2p1:PotassiumMg>
      <d2p1:PriceDescription>String</d2p1:PriceDescription>
      <d2p1:PriceKg>0</d2p1:PriceKg>
      <d2p1:ProductsId>0</d2p1:ProductsId>
      <d2p1:ProteinG>0</d2p1:ProteinG>
      <d2p1:RiboflavinMg>0</d2p1:RiboflavinMg>
      <d2p1:SaturatedG>0</d2p1:SaturatedG>
      <d2p1:SeleniumMcg>0</d2p1:SeleniumMcg>
      <d2p1:SodiumMg>0</d2p1:SodiumMg>
      <d2p1:StarchG>0</d2p1:StarchG>
      <d2p1:SugarsG>0</d2p1:SugarsG>
      <d2p1:TenantsId>0</d2p1:TenantsId>
      <d2p1:ThiaminMg>0</d2p1:ThiaminMg>
      <d2p1:TransG>0</d2p1:TransG>
      <d2p1:VitaminAMcg>0</d2p1:VitaminAMcg>
      <d2p1:VitaminB12Mcg>0</d2p1:VitaminB12Mcg>
      <d2p1:VitaminB6Mg>0</d2p1:VitaminB6Mg>
      <d2p1:VitaminCMg>0</d2p1:VitaminCMg>
      <d2p1:VitaminDMg>0</d2p1:VitaminDMg>
      <d2p1:VitaminEMg>0</d2p1:VitaminEMg>
      <d2p1:VitaminKMcg>0</d2p1:VitaminKMcg>
      <d2p1:ZincMg>0</d2p1:ZincMg>
      <d2p1:ZonesId>0</d2p1:ZonesId>
    </d2p1:ProductsMetrics>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfProductsMetricsZC5p8r_So>