View Source

Summary: Edits an existing food to be a 2016 US label and have the label options provided.

RecommendationProfile
- Adult
- Infant
- Toddler
- PregnantLactating
Style
- Standard
- Tabular
- Linear
- DualColumnSingleRecipeStandard
- DualColumnSingleRecipeTabular
- DualColumnStandard (Adv. Label Only)
- DualColumnTabular (Adv. Label Only)
- AggregateDiffKindsFood (Adv. Label Only)
DisplayType
- Full
- Simplified
Footnote
- Bottom
- Right (Tabular Only)
PrimaryLanguage
- English
- Spanish
EnServingSize
- String
SpServingSize
- String
HideCalculatedServingSize
- Boolean
ServingSizeUoM
- 0 (g)
- 1 (ml)
- 2 (mL)
EnServingsPerContainer
- String
FrServingsPerContainer
- String
HideServingsPerContainer
- Boolean
EnAlternateHeading
- String
SpAlternateHeading
- String
DisplayServingSizeAs
- 0 (Serving Size)
- 1 (Serv Size)
DisplayServingsPerContainerAs
- 0 (Servings per container)
- 1 (Servings)
- 2 (Servings Per Container)
- 3 (Serving)
PrimaryLanguage
- English
- Spanish

UseUnroundedValuesWhenCalcPercentStandard
- Boolean
UseAbbreviations
- Boolean
ShowBilingual
- Boolean
HideDualDeclarationFootnote
- Boolean
HideStandardFootnote
- Boolean
IncludeRecipeNameInAllergenStatement
- Boolean
IncludeRecipeNameInIngredientStatement
- Boolean
Hide449ConversionChart
- Boolean
InsertLessThan2PctIngredientStatement
- Boolean
ContainsLessThan2PctSorted
- Boolean
UppercaseAllergenStatement
- Boolean
UppercaseIngredientStatement
- Boolean
PutVitaminsMineralsIntoTwoColumns
- Boolean
PercentDailyValueHeading
- 0 (% Daily Value)
- 2 (% DV)
- 3 (Percent Daily Value)
- 4 (Percent DV)
NutritionFactsText
- 0 (Proportional)
- 1 (Left Justified)
- 2 (Stretched)
NoBoldingTextInLinear
- Boolean
HideTransFat
- Boolean
HideLinesBetweenVitaminsMinerals
- Boolean
HideVitaminDCalciumIronPotassium
- Boolean
ItalicizeTransFat
- Boolean
Use2018GuidanceForNutrientRoundings
- Boolean
HidePercentDVFootnote
- Boolean
HideQuantitativeValues
- Boolean
ShowInsignificantFootnote
- Boolean
ShowAddedSugarsPalatabilityStmt
- Boolean
PalatabilityStatementText
- String
ShowSingleIngredientSymbol
- Boolean

AddedSugarDisplayAs
- 0 (Includes Xg Added Sugars)
- 1 (Incl. Xg Added Sugars)
AddedSugarIfLessThanOne
- 0 (Round to nearest gram)
- 1 (State “less than 1g”)
- 2 (State “<1g”)
- 4 (State “Contains <1g”)
- 5 (State “Contains less than 1g”)
AddedSugarShowEvenIfInsignificant
- Boolean
BiotinShowAmount
- Boolean
BiotinRoundToNearestTenth
- Boolean
CalciumRoundToNearestTenth
- Boolean
CalciumShowEvenIfInsignificant
- Boolean
CaloriesDisplayAs
- 0 (Calories)
- 1 (Total Calories)
- 2 (Calories, Total)
- 3 (Calories (Energy))
CaloriesIfLessThanFive
- 0 (Round to nearest 5)
- 1 (Round to 0)
CaloriesCalculationMethod
- 0 (Total of all ingredients)
- 1 (4-4-9 Method)
CaloriesSatFatDisplayAs
- 0 (Calories from saturated fat)
- 1 (Sat fat cal)
CaloriesSatFatIfLessThanFive
- 0 (Round to nearest gram)
- 1 (Set to 0)
CarbohydratesDisplayAs
- 0 (Total Carbohydrate)
- 1 (Total carb.)
CarbohydratesIfLessThanOne
- 0 (Round to nearest gram)
- 1 (State “less than 1g”)
- 2 (State “<1g”)
- 4 (State “Contains <1g”)
- 5 (State “Contains less than 1g”)
ChlorideShowAmount
- Boolean
ChlorideRoundToNearestTenth
- Boolean
CholesterolDisplayAs
- 0 (Cholesterol)
- 1 (Cholest)
CholesterolIfBetweenTwoAndFive
- 0 (Round to nearest 5 mg)
- 1 (State “less than 5 mg”)
- 2 (State “< 5 mg”)
CholesterolShowEvenIfInsignificant
- Boolean
CholineShowAmount
- Boolean
CholineRoundToNearestTenth
- Boolean
ChromiumShowAmount
- Boolean
CopperShowAmount
- Boolean
CopperRoundToNearestHundredth
- Boolean
DietaryFiberDisplayAs
- 0 (Dietary fiber)
- 1 (Fiber)
DietaryFiberIfLessThanOne
- 0 (Round to nearest gram)
- 1 (State “less than 1g”)
- 2 (State “<1g”)
- 4 (State “Contains <1g”)
- 5 (State “Contains less than 1g”)
DietaryFiberShowEvenIfInsignificant
- Boolean
FatDisplayAs
- 0 (Total Fat)
- 1 (Fat, Total)
FolateDFEShowFolicAcidInParens
- Boolean
FolateDFEShowAmount
- Boolean
FolateDFERoundToNearestTenth
- Boolean
InsolubleFiberDisplayAs
- 0 (Insoluble fiber)
- 1 (Insol fiber)
InsolubleFiberIfLessThanOne
- 0 (Round to nearest gram)
- 1 (State “less than 1g”)
- 2 (State “<1g”)
- 3 (State “<1g” only if between 0.5 and 1)
IodineShowAmount
- Boolean
IodineRoundToNearestTenth
- Boolean
MagnesiumShowAmount
- Boolean
MagnesiumRoundToNearestTenth
- Boolean
ManganeseShowAmount
- Boolean
ManganeseRoundToNearestHundredth
- Boolean
MolybdenumShowAmount
- Boolean
MolybdenumRoundToNearestTenth
- Boolean
MonoFatDisplayAs
- 0 (Monounsaturated fat)
- 1 (Monounsat fat)
PantothenticAcidShowAmount
- Boolean
PatothenicAcidRoundToNearestTenth
- Boolean
PhosphorusShowAmount
- Boolean
PhosphorusRoundToNearestTenth
- Boolean
PolyFatDisplayAs
- 0 (Polyunsaturated Fat)
- 1 (Polyunsat Fat)
PotassiumDisplayAs
- 0 (Potassium)
- 1 (Potas)
PotassiumRoundToNearestTenth
- Boolean
PotassiumShowEvenIfInsignificant
- Boolean
ProteinIfLessThanOne
- 0 (Round to nearest gram)
- 1 (State “less than 1g”)
- 2 (State “<1g”)
- 3 (State “Contains <1g”)
- 4 (State “Contains less than 1g”)
ProteinPDCAA
- Double
ProteinPER
- Double
ProteinShowPercentDV
- Boolean
ProteinShowNotASignificantSourceOfStmt
- Boolean
SaturatedFatDisplayAs
- 0 (Saturated fat)
- 1 (Sat fat)
SeleniumShowAmount
- Boolean
SolubleFiberDisplayAs
- 0 (Soluble Fiber)
- 1 (Sol Fiber)
SolubleFiberIfLessThanOne
- 0 (Round to nearest gram)
- 1 (State “less than 1g”)
- 2 (State “<1g”)
- 3 (State “<1g” only if between 0.5 and 1)
SugAlcoholDisplayAs
- 0 (Sugar alcohol)
- 1 (Sugar alc)
SugAlcoholEnglishSpecific
- String
SugAlcoholSpanishSpecific
- String
SulfitesDisplayAs
- 0 (This product contains sulfiting agents.)
- 1 (This product contains sulfur dioxide.)
- 2 (This product contains sodium sulfite.)
- 3 (This product contains sodium bisulfite.)
- 4 (This product contains sodium metabisulfite.)
- 5 (This product contains potassium bisulfite.)
- 6 (This product contains potassium metabisulfite.)
- 7 (Use custom)
SulfitesHide
- Boolean
SugarsIfLessThanOne
- 0 (Round to nearest gram)
- 1 (State "less than 1g")
- 2 (State "<1g")
- 4 (State "Contains <1g")
- 5 (State "Contains less than 1g")
SugarsShowEvenIfInsignificant
- Boolean
VitaminADisplayAs
- 0 (Vitamin A)
- 1 (Vit A)
VitaminAShowAmount
- Boolean
VitaminARoundToNearestTenth
- Boolean
VitaminB1DisplayAs
- 0 (Thiamin)
- 1 (Thiamin (Vitamin B1))
- 2 (Thiamin (Vit B1))
VitaminB1ShowAmount
- Boolean
VitaminB1RoundToNearestHundredth
- Boolean
VitaminB12DisplayAs
- 0 (Vitamin B12)
- 1 (Vit B12)
VitaminB12ShowAmount
- Boolean
VitaminB12RoundToNearestHundredth
- Boolean
VitaminB2DisplayAs
- 0 (Riboflavin)
- 1 (Riboflavin (Vitamin B2))
- 2 (Riboflavin (Vit B2)
VitaminB2ShowAmount
- Boolean
VitaminB6DisplayAs
- 0 (Vitamin B6)
- 1 (Vit B6)
VitaminB6ShowAmount
- Boolean
VitaminB6RoundToNearestHundredth
- Boolean
VitaminCDisplayAs
- 0 (Vitamin C)
- 1 (Vitamin C (Ascorbic Acid))
- 2 (Vit C)
- 3 (Vit C (Ascorbic Acid))
VitaminCShowAmount
- Boolean
VitaminCRoundToNearestTenth
- Boolean
VitaminDDisplayAs
- 0 (Vitamin D)
- 1 (Vit D)
VitaminDShowIUInParensFollowingMcg
- Boolean
VitaminDRoundToNearestTenth
- Boolean
VitaminEDisplayAs
- 0 (Vitamin E)
- 1 (Vit E)
VitaminEShowAmount
- Boolean
VitaminERoundToNearestTenth
- Boolean
VitaminKDisplayAs
- 0 (Vitamin K)
- 1 (Vit K)
VitaminKShowAmount
- Boolean
VitaminKRoundToNearestTenth
- Boolean
ZincShowAmount
- Boolean
ZincRoundToNearestHundredth
- Boolean
VitaminsMineralsBelowTwoPercent
- 0 (Round to nearest 2% increment)
- 1 (Set to 0)
- 2 (Insert footnote)

All the following are boolean options:

ShowBiotin
ShowCaloriesFromSatFat
ShowChloride
ShowCholine
ShowChromium
ShowCopper
ShowFluoride
ShowFolateDFE
ShowInsolubleFiber2016
ShowIodine
ShowMagnesium
ShowManganese
ShowMolybdenum
ShowMonoFat
ShowPantothenicAcid
ShowPhosphorus
ShowPolyFat
ShowSelenium
ShowSolubleFiber2016
ShowSugarAlcohol
ShowVitaminA_RAE
ShowVitaminB1
ShowVitaminB12
ShowVitaminB2
ShowVitaminB3_NiacinEquiv
ShowVitaminB6
ShowVitaminC
ShowVitaminE_AlphaToco
ShowVitaminK
ShowZinc

POST http://localhost:80/rest/FoodEditService.svc/SetUSLabel HTTP/1.1
Content-Type: text/plain
Host: localhost:80

request={ 
    "UserCode":"XYZ-123",
    "GeneralOptions":{
        "RecommendationProfile":"Adult",
        "Style":"Standard",
        "Format":"Full",
        "PrimaryLanguage":"English",
        "EnServingSize":"EN SS US",
        "SpServingSize":"sp SS US",
        "HideCalculatedServingSize":"false",
        "ServingSizeUoM":"0",
        "EnServingsPerContainer":"EN SPC US",
        "SpServingsPerContainer":"SP SPC US",
        "HideServingsPerContainer":"false",
        "EnAlternateHeading":"EN AH US",
        "SpAlternateHeading":"SP AH US",
        "DisplayServingSizeAs":"0",
        "DisplayServingsPerContainerAs":"0",
    },
    "VoluntaryNutrients":{
        "ShowBiotin":"False",
        "ShowCaloriesFromSatFat":"False",
        "ShowChloride":"False",
        "ShowCholine":"False",
        "ShowChromium":"False",
        "ShowCopper":"False",
        "ShowFluoride":"False",
        "ShowFolateDFE":"False",
        "ShowInsolubleFiber2006":"False",
        "ShowIodine":"False",
        "ShowMagnesium":"False",
        "ShowManganese":"False",
        "ShowMolybdenum":"False",
        "ShowMonoFat":"False",
        "ShowPantothenicAcid":"False",
        "ShowPhosphorus":"False",
        "ShowPolyFat":"False",
        "ShowSelenium":"False",
        "ShowSolubleFiber2006":"False",
        "ShowSugarAlcohol":"False",
        "ShowVitaminA_RAE":"False",
        "ShowVitaminB1":"False",
        "ShowVitaminB12":"False",
        "ShowVitaminB2":"False",
        "ShowVitaminB3_NiacinEquiv":"False",
        "ShowVitaminB6":"False",
        "ShowVitaminC":"False",
        "ShowVitaminE_AlphaToco":"False",
        "ShowVitaminK":"False",
        "ShowZinc":"False",
    },
   "FormatOptions":
   {
		"UseUnroundedValuesWhenCalcPercentStandard":"False",
		"UseAbbreviations":"False",
		"ShowBilingual":"False",
		"HideDualDeclarationFootnote":"False",
		"HideStandardFootnote":"False",
		"IncludeRecipeNameInAllergenStatement":"False",
		"IncludeRecipeNameInIngredientStatement":"False",
		"Hide449ConversionChart":"False",
		"InsertLessThan2PctIngredientStatement":"False",
		"ContainsLessThan2PctSorted":"False",
		"UppercaseAllergenStatement":"False",
		"UppercaseIngredientStatement":"False",
		"PutVitaminsMineralsIntoTwoColumns":"False",
		"PercentDailyValueHeading":"0",
		"NutritionFactsText":"0",
		"NoBoldingTextInLinear":"False",
		"HideTransFat":"False",
		"HideLinesBetweenVitaminsMinerals":"False",
		"WrapBilingualNutrients":"False",
		"HideVitaminDCalciumIronPotassium":"False",
		"ItalicizeTransFat":"False",
		"Use2018GuidanceForNutrientRoundings":"False",
		"HidePercentDVFootnote":"False",
		"HideQuantitativeValues":"False",
		"ShowInsignificantFootnote":"False",
		"ShowAddedSugarsPalatabilityStmt":"False",
		"PalatabilityStatementText":"Palatability Text",
		"ShowSingleIngredientSymbol":"False"
    },
   "NutrientOptions":
   { 
        "AddedSugarDisplayAs":"0",
		"AddedSugarIfLessThanOne":"0",
		"AddedSugarShowEvenIfInsignificant":"false",
		"BiotinShowAmount":"false",
		"BiotinRoundToNearestTenth":"false",
		"CalciumShowEvenIfInsignificant":"false",
		"CalciumRoundToNearestTenth":"false",
		"CaloriesDisplayAs":"0",
		"CaloriesIfLessThanFive":"0",
		"CaloriesCalculationMethod":"0",
		"CaloriesSatFatDisplayAs":"0",
		"CaloriesSatFatIfLessThanFive":"0",
		"CarbohydratesDisplayAs":"0",
		"CarbohydratesIfLessThanOne":"0",
		"ChlorideShowAmount":"false",
		"ChlorideRoundToNearestTenth":"false",
		"CholesterolDisplayAs":"0",
		"CholesterolIfBetweenTwoAndFive":"0",
		"CholesterolShowEvenIfInsignificant":"false",
		"CholineShowAmount":"false",
		"CholineRoundToNearestTenth":"false",
		"ChromiumShowAmount":"false",
		"ChromiumRoundToNearestTenth":"false",
		"CopperShowAmount":"false",
		"CopperRoundToNearestHundredth":"false",
		"DietaryFiberDisplayAs":"0",
		"DietaryFiberIfLessThanOne":"0",
		"DietaryFiberShowEvenIfInsignificant":"false",
		"FatDisplayAs":"0",
		"FolateDFEShowFolicAcidInParens":"false",
		"FolateDFEShowAmount":"false",
		"FolateDFERoundToNearestTenth":"false",
		"InsolubleFiberDisplayAs":"0",
		"InsolubleFiberIfLessThanOne":"0",
		"IodineShowAmount":"false",
		"IodineRoundToNearestTenth":"false",
		"IronRoundToNearestTenth":"false",
		"IronShowEvenIfInsignificant":"false",
		"MagnesiumShowAmount":"false",
		"MagnesiumRoundToNearestTenth":"false",
		"ManganeseShowAmount":"false",
		"ManganeseRoundToNearestHundredth":"false",
		"MolybdenumShowAmount":"false",
		"MolybdenumRoundToNearestTenth":"false",
		"MonoFatDisplayAs":"0",
		"PantothenticAcidShowAmount":"false",
		"PatothenicAcidRoundToNearestTenth":"false",
		"PhosphorusShowAmount":"false",
		"PhosphorusRoundToNearestTenth":"false",
		"PolyFatDisplayAs":"0",
		"PotassiumDisplayAs":"0",
		"PotassiumRoundToNearestTenth":"false",
		"PotassiumShowEvenIfInsignificant":"false",
		"ProteinIfLessThanOne":"0",
		"ProteinPDCAA":"0",
		"ProteinPER":"0",
		"ProteinShowPercentDV":"false",
		"ProteinShowNotASignificantSourceOfStmt":"false",
		"SaturatedFatDisplayAs":"0",
		"SeleniumShowAmount":"false",
		"SeleniumRoundToNearestTenth":"false",
		"SolubleFiberDisplayAs":"0",
		"SolubleFiberIfLessThanOne":"0",
		"SugAlcoholDisplayAs":"0",
		"SugAlcoholEnglishSpecific":"EnglishText",
		"SugAlcoholSpanishSpecific":"SpanishText",
		"SulfitesDisplayAs":"0",
		"SulfitesEnglishText":"English Text",
		"SulfitesSpanishText":"Spanish Text",
		"SulfitesHide":"false",
		"SugarsIfLessThanOne":"0",
		"SugarsShowEvenIfInsignificant":"false",
		"TransFatShowEvenIfInsignificant":"false",
		"VitaminADisplayAs":"0",
		"VitaminAShowAmount":"false",
		"VitaminARoundToNearestTenth":"false",
		"VitaminB1DisplayAs":"0",
		"VitaminB1ShowAmount":"false",
		"VitaminB1RoundToNearestHundredth":"false",
		"VitaminB12DisplayAs":"0",
		"VitaminB12ShowAmount":"false",
		"VitaminB12RoundToNearestHundredth":"false",
		"VitaminB2DisplayAs":"0",
		"VitaminB2ShowAmount":"false",
		"VitaminB2RoundToNearestHundredth":"false",
		"VitaminB3ShowAmount":"false",
		"VitaminB3RoundToNearestTenth":"false",
		"VitaminB6DisplayAs":"0",
		"VitaminB6ShowAmount":"false",
		"VitaminB6RoundToNearestHundredth":"false",
		"VitaminCDisplayAs":"0",
		"VitaminCShowAmount":"false",
		"VitaminCRoundToNearestTenth":"false",
		"VitaminDDisplayAs":"0",
		"VitaminDShowIUInParensFollowingMcg":"false",
		"VitaminDRoundToNearestTenth":"false",
		"VitaminDShowEvenIfInsignificant":"false",
		"VitaminEDisplayAs":"0",
		"VitaminEShowAmount":"false",
		"VitaminERoundToNearestTenth":"false",
		"VitaminKDisplayAs":"0",
		"VitaminKShowAmount":"false",
		"VitaminKRoundToNearestTenth":"false",
		"ZincShowAmount":"false",
		"ZincRoundToNearestHundredth":"false",
		"VitaminsMineralsBelowTwoPercent":"0"
   },
   "EditDetails":{
        "EditMessage":"Setting US label on recipe",
        "EditCaller":{
            "Name":"Our PLM System"
        }
    }
}

{
    "UpdatedFoodsCount": 1,
    "Errors": null,
    "Status": {
        "StatusMessage": 200,
        "StatusCode": 200,
        "StatusDetail": null
    },
    "ResponseVersion": {}
}