sfgboxapi

<back to all web services

ProductsMetricsEdit

Requires Authentication
The following routes are available for this service:
PUT/products_metrics/{Id}
ProductsMetricsEdit Parameters:
NameParameterData TypeRequiredDescription
IdpathlongYes
TenantsIdbodylongYes
ZonesIdbodylongYes
ProductsIdbodylongYes
PriceKgbodydoubleYes
PriceDescriptionbodystringYes
BetaineMgbodydouble?No
CalciumMgbodydouble?No
CholineMgbodydouble?No
CopperMgbodydouble?No
FiberGbodydouble?No
FluorideMgbodydouble?No
FolateMcgbodydouble?No
IronMgbodydouble?No
MagnesiumMgbodydouble?No
MangeneseMgbodydouble?No
MonoGbodydouble?No
NiacinMgbodydouble?No
Omega3Mgbodydouble?No
Omega6Mgbodydouble?No
PanthenicAcidMgbodydouble?No
PhosphorusMgbodydouble?No
PolyGbodydouble?No
PotassiumMgbodydouble?No
ProteinGbodydouble?No
RiboflavinMgbodydouble?No
SaturatedGbodydouble?No
SeleniumMcgbodydouble?No
SodiumMgbodydouble?No
StarchGbodydouble?No
SugarsGbodydouble?No
ThiaminMgbodydouble?No
VitaminAMcgbodydouble?No
VitaminB12Mcgbodydouble?No
VitaminB6Mgbodydouble?No
VitaminCMgbodydouble?No
VitaminDMgbodydouble?No
VitaminEMgbodydouble?No
VitaminKMcgbodydouble?No
ZincMgbodydouble?No
TransGbodydouble?No
ProductsMetricsEditResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
TenantsIdformlongNo
ZonesIdformlongNo
ProductsIdformlongNo
PriceKgformdoubleNo
PriceDescriptionformstringNo
BetainePercRdaformdouble?No
BetaineMgformdouble?No
CalciumPercRdaformdouble?No
CalciumMgformdouble?No
CaloriesPercRdaformdouble?No
CaloriesKcformdouble?No
CarbohydratesPercRdaformdouble?No
CarbohydratesGformdouble?No
CarbohydratesKcformdouble?No
CarbohydratesKjformdouble?No
CholinePercRdaformdouble?No
CholineMgformdouble?No
CopperPercRdaformdouble?No
CopperMgformdouble?No
FatPercRdaformdouble?No
FatGformdouble?No
FatKcformdouble?No
FatKjformdouble?No
FiberGformdouble?No
FluoridePercRdaformdouble?No
FluorideMgformdouble?No
FolatePercRdaformdouble?No
FolateMcgformdouble?No
IronPercRdaformdouble?No
IronMgformdouble?No
KilojoulesKjformdouble?No
MagnesiumPercRdaformdouble?No
MagnesiumMgformdouble?No
MangenesePercRdaformdouble?No
MangeneseMgformdouble?No
MonoGformdouble?No
NiacinPercRdaformdouble?No
NiacinMgformdouble?No
Omega3Mgformdouble?No
Omega6Mgformdouble?No
PanthenicAcidPercRdaformdouble?No
PanthenicAcidMgformdouble?No
PhosphorusPercRdaformdouble?No
PhosphorusMgformdouble?No
PolyGformdouble?No
PotassiumPercRdaformdouble?No
PotassiumMgformdouble?No
ProteinPercRdaformdouble?No
ProteinGformdouble?No
ProteinKcformdouble?No
ProteinKjformdouble?No
RiboflavinPercRdaformdouble?No
RiboflavinMgformdouble?No
SaturatedGformdouble?No
SeleniumPercRdaformdouble?No
SeleniumMcgformdouble?No
SodiumPercRdaformdouble?No
SodiumMgformdouble?No
StarchGformdouble?No
SugarsGformdouble?No
ThiaminPercRdaformdouble?No
ThiaminMgformdouble?No
VitaminAPercRdaformdouble?No
VitaminAMcgformdouble?No
VitaminB12PercRdaformdouble?No
VitaminB12Mcgformdouble?No
VitaminB6PercRdaformdouble?No
VitaminB6Mgformdouble?No
VitaminCPercRdaformdouble?No
VitaminCMgformdouble?No
VitaminDPercRdaformdouble?No
VitaminDMgformdouble?No
VitaminEPercRdaformdouble?No
VitaminEMgformdouble?No
VitaminKPercRdaformdouble?No
VitaminKMcgformdouble?No
ZincPercRdaformdouble?No
ZincMgformdouble?No
TransGformdouble?No
ResponseStatusformResponseStatusNo

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.

PUT /products_metrics/{Id} HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProductsMetricsEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Id>0</Id>
  <TenantsId>0</TenantsId>
  <ZonesId>0</ZonesId>
  <ProductsId>0</ProductsId>
  <PriceKg>0</PriceKg>
  <PriceDescription>String</PriceDescription>
  <BetaineMg>0</BetaineMg>
  <CalciumMg>0</CalciumMg>
  <CholineMg>0</CholineMg>
  <CopperMg>0</CopperMg>
  <FiberG>0</FiberG>
  <FluorideMg>0</FluorideMg>
  <FolateMcg>0</FolateMcg>
  <IronMg>0</IronMg>
  <MagnesiumMg>0</MagnesiumMg>
  <MangeneseMg>0</MangeneseMg>
  <MonoG>0</MonoG>
  <NiacinMg>0</NiacinMg>
  <Omega3Mg>0</Omega3Mg>
  <Omega6Mg>0</Omega6Mg>
  <PanthenicAcidMg>0</PanthenicAcidMg>
  <PhosphorusMg>0</PhosphorusMg>
  <PolyG>0</PolyG>
  <PotassiumMg>0</PotassiumMg>
  <ProteinG>0</ProteinG>
  <RiboflavinMg>0</RiboflavinMg>
  <SaturatedG>0</SaturatedG>
  <SeleniumMcg>0</SeleniumMcg>
  <SodiumMg>0</SodiumMg>
  <StarchG>0</StarchG>
  <SugarsG>0</SugarsG>
  <ThiaminMg>0</ThiaminMg>
  <VitaminAMcg>0</VitaminAMcg>
  <VitaminB12Mcg>0</VitaminB12Mcg>
  <VitaminB6Mg>0</VitaminB6Mg>
  <VitaminCMg>0</VitaminCMg>
  <VitaminDMg>0</VitaminDMg>
  <VitaminEMg>0</VitaminEMg>
  <VitaminKMcg>0</VitaminKMcg>
  <ZincMg>0</ZincMg>
  <TransG>0</TransG>
</ProductsMetricsEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProductsMetricsEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <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>
  <FatKc>0</FatKc>
  <FatKj>0</FatKj>
  <FatPercRda>0</FatPercRda>
  <FiberG>0</FiberG>
  <FluorideMg>0</FluorideMg>
  <FluoridePercRda>0</FluoridePercRda>
  <FolateMcg>0</FolateMcg>
  <FolatePercRda>0</FolatePercRda>
  <Id>0</Id>
  <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:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1: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>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1: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>
    </d2p1: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>
</ProductsMetricsEditResponse>