Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Current »

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

 GeneralOptions
  • RecommendationProfile

    • Adult

    • Child

    • Infants

  • Style

    • Standard

    • StandardNarrow

    • Tabular

    • Linear

    • DualFormatDiffAmounts

    • DualFormatRequirePrep (Adv. Label Only)

    • AggregateDiffKindsFood (Adv. Label Only)

    • AggregateDiffAmountsFood (Adv. Label Only)

  • Display Type

    • Full

    • Simplified

    • SimplifiedSingleServingPrepackaged

  • PrimaryLanguage

    • English

    • French

  • EnServingSize

    • String

  • FrServingSize

    • String

  • HideCalculatedServingSize

    • Boolean

  • ServingSizeUoM

    • 0 (g)

    • 1 (ml)

    • 2 (mL)

  • EnServingsPerContainer

    • String

  • FrServingsPerContainer

    • String

  • HideServingsPerContainer

    • Boolean

  • EnAlternateHeading

    • String

  • FrAlternateHeading

    • String

  • DisplayServingSizeAs

    • 0 (per/pour)

    • 1 (per/par)

    • 2 (Serving Size/Portion)

    • 3 (Serving/Pour)

  • DisplayServingsPerContainerAs

    • 0 (Per Container/Par contenant)

    • 1 (Servings Per Container / portions par contenant)

    • 2 (About HM / environ MD)

    • 3 (About HM prepared / environ MD prepare)

    • 4 ( (about HM prepared) / (environ MD Pprepare) )

  • PrimaryLanguage

    • English

    • French

The following only affect Dual Format - Different Amounts of Foods Labels

  • AmountInDisplay

    • 0 (Amount in / Teneur pour)

    • 1 (Amount in / Teneur par)

  • EnHouseholdMeasureColumn1

    • String

  • FrHouseholdMeasureColumn1

    • String

  • EnHouseholdMeasureColumn2

    • String

  • FrHouseholdMeasureColumn2

    • String

  • Column2GramWeight

    • Double

 FormatOptions
  • UseAbbreviations

    • Boolean

  • ShowBilingual

    • Boolean

  • HideDualDeclarationFootnote

    • Boolean

  • IncludeRecipeNameInAllergenStatement

    • Boolean

  • IncludeRecipeNameInIngredientStatement

    • Boolean

  • Hide449ConversionChart

    • Boolean

  • UppercaseAllergenStatement

    • Boolean

  • SeperatorInIngredientStatement

    • 0 (Comma)

    • 1 (Bullet)

  • DisplayMicrogramsAs

    • 0 (µg)

    • 1 (mcg)

  • RoundDVToZero

    • Boolean

  • AbbreviateAmountPerServing

    • Boolean

  • AlwaysWrapBilingualHeadings

    • Boolean

  • UseShortenedNotASigSourceStatement

    • Boolean

  • HideAmountInFootnote

    • Boolean

  • ShowAmountPerServingHeadingInfants

    • Boolean

 NutrientOptions
  • CalciumShowEvenInsignificant

    • Boolean

  • CaloriesDisplayAs

    • 0 (Calories)

    • 1 (Total Calories / Calories totales)

    • 2 (Calories, Total / Calories totales)

  • CaloriesIfLessThanZero

    • 0 (Round to the nearest 1)

    • 1 (Set to 0)

  • CaloriesCalculationMethod

    • 0 (Sum of all ingredients)

    • 1 (Estimate using 4-4-9-2)

  • CarbohydratesDisplayAs

    • 0 (Carbohydrate / Glucides)

    • 1 (Total Carbohydrate / Total des glucides)

    • 2 (Carbohydrate, Total / Total des glucides)

  • CarbohydratesUseUnroundedValueCalculatingDV

    • Boolean

  • CholesterolLessThan5mg

    • 0 (Round to nearest 5mg)

    • 1 (Set to 0)

  • CholesterolHidePercent

    • Boolean

  • CholesterolShowForInfants

    • Boolean

  • CholesterolUseUnroundedValueCalculatingDV

    • Boolean

  • CholesterolShowEvenInsignificant

    • Boolean

  • FatDisplayAs

    • 0 (Fat / Lipides)

    • 1 (Total Fat / Total des lipides)

    • 2 (Fat, Total / total des lipides)

  • FatLessThanHalfGram

    • 0 (Round to the nearest 0.1)

    • 1 (Set to 0)

  • FatUseUnroundedValueCalculatingDV

    • Boolean

  • IronShowEvenInsignificant

    • Boolean

  • KilojoulesDisplayAs

    • 0 (kJ)

    • 1 (kilojoules)

  • MonoFatDisplayAs

    • 0 (Monounsaturated / monoinsaturés)

    • 1 (Monounsaturates / monoinsaturés)

    • 2 (Monounsaturated Fat / Lipides monoinsaturés)

    • 3 (Monounsaturated Fatty Acids / Acides gras monoinsaturés)

  • Omega3FattyAcidDisplayAs

    • 0 (Omega-3 / oméga-3)

    • 1 (Omega-3 Polyunsaturated / polyinsaturés oméga-3)

    • 2 (Omega-3 Polyunsaturates / polyinsaturés oméga-3)

    • 3 (Omega-3 Polyunsaturated Fat / Lipides polyinsaturés oméga-3)

    • 4 (Omega-3 Polyunsaturated Fatty Acids / Acides gras polyinsaturés oméga-3)

  • Omega6FattyAcidDisplayAs

    • 0 (Omega-6 / oméga-6)

    • 1 (Omega-6 Polyunsaturated / polyinsaturés oméga-6)

    • 2 (Omega-6 Polyunsaturates / polyinsaturés oméga-6)

    • 3 (Omega-6 Polyunsaturated Fat / Lipides polyinsaturés oméga-6)

    • 4 (Omega-6 Polyunsaturated Fatty Acids / Acides gras polyinsaturés oméga-6)

  • PantothenicAcidDisplayAs

    • 0 (Pantothenate / Pantothénate)

    • 1 (Pantothenic Acid / Acide pantothénique)

  • PolyFatDisplayAs

    • 0 (Polyunsaturated / polyinsaturés)

    • 1 (Polyunsaturates / polyinsaturés)

    • 2 (Polyunsaturated Fat / Lipides polyinsaturés)

    • 3 (Polyunsaturated Fatty Acids / Acides gras polyinsaturés)

  • PotassiumLessThan5mg

    • 0 (Round to nearest 1 mg)

    • 1 (Set to 0)

  • PotassiumShowEvenInsignificant

    • Boolean

  • SaturatedFatDisplayAs

    • 0 (Saturated Fat / Lipides saturés)

    • 1 (Saturated Fatty Acids / Acides gras saturés)

    • 2 (Saturated / saturés)

    • 3 (Saturates / saturés)

  • SaturatedFatLessThanHalfGram

    • 0 (Round to the nearest 0.1 g)

    • 1 (Set to 0)

  • SaturatedFatShowForInfants

    • Boolean

  • SodiumLessThan5Mg

    • 0 (Round to nearest 1 mg)

    • 1 (Set to 0)

  • SodiumShowEvenInsignificant

    • Boolean

  • SugAlcoholDisplayAs

    • 0 (Sugar Alcohols/ Polyalcools)

    • 1 (Polyols)

    • 2 (Sugar Alcohol / Polyalcool)

    • 3 (Polyol)

  • SugAlcoholEnglishSpecific

    • String

  • SugAlcoholFrenchSpecific

    • String

  • TotalDietaryFiberDisplayAs

    • 0 (Fibre / Fibres)

    • 1 (Fiber / Fibres)

    • 2 (Dietary Fibre)

    • 3 (Dietary Fiber)

  • TotalDietaryFiberShowEvenInsignificant

    • Boolean

  • TotalDietaryFiberUseUnroundedValueCalculatingDV

    • Boolean

  • TotalInsolFiberDisplayAs

    • 0 (Insoluble Fibre / Fibres insolubles)

    • 1 (Insoluble Fiber / Fibres insolubles)

  • TotalSolFiberDisplayAs

    • 0 (Soluble Fibre / Fibres solubles)

    • 1 (Soluble Fiber / Fibres solubles)

  • TotalSugarsUseUnroundedValuesCalculatingDV

    • Boolean

  • TotalSugarsShowEvenInsignificant

    • Boolean

  • TransFatDisplayAs

    • 0 (Trans Fat / lipides trans)

    • 1 (Trans Fatty Acids / acides gras trans)

    • 2 (Trans / trans)

  • TransFatLessThanHalfGram

    • 0 (Round to the nearest 0.1 g)

    • 1 (Set to 0)

  • TransFatShowForInfants

    • Boolean

  • VitaminB1DisplayAs

    • 0 (Thiamine)

    • 1 (Thiamin / Thiamine)

    • 2 (Thiamine (Vitamin B1) / Thiamine (vitamine B1))

    • 3 (Thiamine (Vit B1))

    • 4 (Thiamin (Vitamin B1) / Thiamine (Vitamine B1))

    • 5 (Thiamin (Vit B1) / Thiamine (Vit B1))

  • VitaminB2DisplayAs

    • 0 (Riboflavin / Riboflavine)

    • 1 (Riboflavin (Vitamin B2) / Riboflavine (Vitamine B2))

    • 2 (Riboflavin (Vit B2) / Riboflavine (Vit B2))

  • SatFatPlusTransFatUseUnroundedValueCalculatingDV

    • Boolean

  • SaturatedPlusTransShowEvenInsignificant

    • Boolean

The following are only affect labels with the Simplified - Single Serving Pre-Package Products Display Type

  • CalciumShowSimplifiedSingleServing

    • Boolean

  • CholesterolShowSimplifiedSingleServing

    • Boolean

  • IronShowSimplifiedSingleServing

    • Boolean

  • PotassiumShowSimplifiedSingleServing

    • Boolean

  • TotalDietaryFiberShowSimplifiedSingleServing

    • Boolean

 VoluntaryNutrients

All the following are boolean options:

  • ShowBiotin

  • ShowChloride

  • ShowCholine

  • ShowChromium

  • ShowCopper

  • ShowFolateDFE

  • ShowIodine

  • ShowKilojoules

  • ShowMagnesium

  • ShowManganese

  • ShowMolybdenum

  • ShowMonoFat

  • ShowOmega3FattyAcid

  • ShowOmega6FattyAcid

  • ShowPantothenicAcid

  • ShowPhosphorus

  • ShowPolyFat

  • ShowSelenium

  • ShowStarch

  • ShowSugarAlcohol

  • ShowTotalInsolubleFiber

  • ShowTotalSolubleFiber

  • ShowVitaminA_RAE

  • ShowVitaminB1

  • ShowVitaminB12

  • ShowVitaminB2

  • ShowVitaminB3_NiacinEquiv

  • ShowVitaminB6

  • ShowVitaminC

  • ShowVitaminD_MCG

  • ShowVitaminE_MG

  • ShowVitaminK

  • ShowZinc

 REST Request

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

request={
    "UserCode":"REC-987x",
    "GeneralOptions":{
        "RecommendationProfile":"Adult",
        "Style":"Standard",
        "DisplayType":"Full",
        "PrimaryLanguage":"French",
        "EnServingSize":"EN SS",
        "FrServingSize":"FR SS",
        "HideCalculatedServingSize":"false",
        "ServingSizeUoM":"0",
        "EnServingsPerContainer":"EN SPC",
        "FrServingsPerContainer":"FR SPC",
        "HideServingsPerContainer":"false",
        "EnAlternateHeading":"EN AH",
        "FrAlternateHeading":"FR AH",
        "DisplayServingSizeAs":"0",
        "DisplayServingsPerContainerAs":"0",
        "PrimaryLanguage":"English",
        "AmountInDisplay":"0",
        "EnHouseholdMeasureColumn0":"EN Col0",
        "FrHouseholdMeasureColumn0":"FR Col0",
        "EnHouseholdMeasureColumn2":"EN Col2",
        "FrHouseholdMeasureColumn2":"FR Col2",
        "Column2GramWeight":"10.0"
    },
    "VoluntaryNutrients":{
        "ShowBiotin":"false",
        "ShowChloride":"false",
        "ShowCholine":"false",
        "Showchromium":"false",
        "ShowCopper":"false",
        "ShowFolateDFE":"false",
        "ShowIodine":"false",
        "ShowKilojoules":"false",
        "ShowMagnesium":"false",
        "ShowManganese":"false",
        "ShowMolybdenum":"false",
        "ShowMonoFat":"false",
        "ShowOmega3FattyAcid":"false",
        "ShowOmega6FattyAcid":"false",
        "ShowPantothenicAcid":"false",
        "ShowPhosphorus":"false",
        "ShowPolyFat":"false",
        "ShowSelenium":"false",
        "ShowStarch":"false",
        "ShowSugarAlcohol":"false",
        "ShowTotalInsolubleFiber":"false",
        "ShowTotalSolubleFiber":"false",
        "ShowVitainA":"false",
        "ShowVitaminB1":"false",
        "ShowVitaminB2":"false",
        "ShowVitaminB12":"false",
        "ShowVitaminB3":"false",
        "ShowVitaminB6":"false",
        "ShowVitaminC":"false",
        "ShowVitaminD":"false",
        "ShowVitaminE":"false",
        "ShowVitaminK":"false",
        "ShowZinc":"false"
    },
    "FormatOptions":{
        "UseAbbreviations":"false",
        "ShowBilingual":"false",
        "HideDualDeclarationFootnote":"false",
        "IncludeRecipeNameInAllergenStatement":"false",
        "IncludeRecipeNameInIngredientStatement":"false",
        "Hide449ConversionChart":"false",
        "UppercaseAllergenStatement":"false",
        "SeperatorInIngredientStatement":"0",
        "DisplayMicrogramsAs":"0",
        "RoundDVToZero":"false",
        "AbbreviateAmountPerServing":"false",
        "AlwaysWrapBilingualHeadings":"false",
        "UseShortenedNotASigSourceStatement":"false",
        "HideAmountInFootnote":"false",
        "ShowAmountPerServingHeadingInfants":"false",
    },
    "NutrientOptions":{ 
        "CaloriesDisplayAs":"0",
        "CaloriesIfLessThanZero":"0",
        "CaloriesCalculationMethod":"0",
        "CarbohydratesDisplayAs":"0",
        "CarbohydratesUseUnroundedValueCalculatingDV":"false",
        "CholesterolLessThan5mg":"0",
        "CholesterolHidePercent":"false",
        "CholesterolShowForInfants":"false",
        "CholesterolUseUnroundedValueCalculatingDV":"false",
        "FatDisplayAs":"0",
        "FatLessThanHalfGram":"0",
        "FatUseUnroundedValueCalculatingDV":"false",
        "KilojoulesDisplayAs":"0",
        "MonoFatDisplayAs":"0",
        "Omega3FattyAcidDisplayAs":"0",
        "Omega6FattyAcidDisplayAs":"0",
        "PantothenicAcidDisplayAs":"0",
        "PolyFatDisplayAs":"0",
        "PotassiumLessThan5mg":"0",
        "SaturatedFatDisplayAs":"0",
        "SaturatedFatLessThanHalfGram":"0",
        "SaturatedFatShowForInfants":"false",
        "SodiumLessThan5Mg":"0",
        "SugAlcoholDisplayAs":"0",
        "SugAlcoholEnglishSpecific":"ENGLISH",
        "SugAlcoholFrenchSpecific":"FRENCH",
        "TotalDietaryFiberDisplayAs":"0",
        "TotalDietaryFiberUseUnroundedValueCalculatingDV":"false",
        "TotalInsolFiberDisplayAs":"0",
        "TotalSolFiberDisplayAs":"0",
        "TotalSugarsUseUnroundedValuesCalculatingDV":"false",
        "TransFatDisplayAs":"0",
        "TransFatLessThanHalfGram":"0",
        "TransFatShowForInfants":"false",
        "VitaminB1DisplayAs":"0",
        "VitaminB2DisplayAs":"0",
        "SatFatPlusTransFatUseUnroundedValueCalculatingDV":"false",
        "SaturatedPlusTransShowEvenInsignificant":"false",
        "TotalDietaryFiberShowEvenInsignificant":"false",
        "TotalSugarsShowEvenInsignificant":"false",
        "CholesterolShowEvenInsignificant":"false",
        "SodiumShowEvenInsignificant":"false",
        "PotassiumShowEvenInsignificant":"false",
        "IronShowEvenInsignificant":"true",
        "CalciumShowEvenInsignificant":"false",
        "TotalDietaryFiberShowSimplifiedSingleServing":"false",
        "PotassiumShowSimplifiedSingleServing":"false",
        "CalciumShowSimplifiedSingleServing":"false",
        "IronShowSimplifiedSingleServing":"false",
        "CholesterolShowSimplifiedSingleServing":"false"
    },
    "EditDetails":{
        "EditMessage":"Setting Canadian label on recipe",
        "EditCaller":{
            "Name":"Our PLM System"
        }
    }
}
 REST Response

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