GetFoodByUserCode - Resource

Owned by Rory Plaire (Unlicensed)
Last updated: Feb 15, 2018 by Nate Edwards
9 min read

Summary


 Retrieves the metadata for a food identified by the specified userCode value if it is published.

Note: If you are upgrading to Gen API 3.1 (or later) you will want to reference this page.

Resource


POST /rest/FoodQueryService.svc/GetFoodByUserCode

Request
ParameterTypeDescription
 userCodeStringThe user code assigned to the food that is requested.

Examples


Example Request
POST /rest/FoodQueryService.svc/GetFoodByUserCode HTTP/1.1
Host: eshademo.cloudapp.net
Cache-Control: no-cache

request={"userCode":"15"}
Example Response
 {
    "Food": {
        "HaccpData": [],
        "CookMethod": null,
        "CookTemperature": null,
        "CookTime": null,
        "Instructions": null,
        "HaccpHeadingLevel": null,
        "PanSize": null,
        "PreparationTime": null,
        "ContentClaimReferenceId": null,
        "DefinedServingWeightConversion": null,
        "UseStaticAdditionalAllergenStatement": false,
        "UseStaticAllergenStatement": false,
        "UseStaticIngredientStatement": false,
        "FoodType": 82,
        "Name": {
            "en-US": "Genen Shouyu"
        },
        "CommonName": {
            "en-US": "Genen Shouyu"
        },
        "Description": null,
        "FoodTypeName": null,
        "VarietyName": null,
        "PrimaryDescriptor": null,
        "Title": null,
        "PreparationName": null,
        "OtherDescriptor": null,
        "ContentName": null,
        "MiscName": null,
        "DefiningAmount": {
            "Quantity": {
                "Value": 0
            },
            "UnitId": "00000000-0000-0000-0000-000000000000"
        },
        "AmountCost": {
            "Amount": {
                "Quantity": {
                    "Value": 0
                },
                "UnitId": "00000000-0000-0000-0000-000000000000"
            },
            "Cost": 0
        },
        "DefaultWeightUnitId": null,
        "ConversionMapId": null,
        "Conversions": [{
			"From": {
				"Quantity": {
					"Value": "1",
					"Type": "Double"
				},
				"UnitId": "a7df0af5-001f-0000-7484-751e8eaf05c6"
			},
			"ConversionFactor": {
				"Value": "1",
				"Type": "Double"
			},
			"To": {
				"Quantity": {
					"Value": "1108.65933943304",
					"Type": "Double"
				},
				"UnitId": "a7df0af5-0008-0000-7484-751e8eaf05c6"
			}
		}],
        "Items": [
            {
                "FoodId": "dbfac0f0-42d3-0006-27c3-41e8c688e289",
                "Amount": {
                    "Quantity": {
                        "Value": 2
                    },
                    "UnitId": "00000000-0000-0000-0000-000000000000"
                },
                "Note": ""
            },
            {
                "FoodId": "dbfac0f0-28e2-0000-27c3-41e8c688e289",
                "Amount": {
                    "Quantity": {
                        "Value": 1
                    },
                    "UnitId": "00000000-0000-0000-0000-000000000000"
                },
                "Note": ""
            },
            {
                "FoodId": "dbfac0f0-bb75-0000-27c3-41e8c688e289",
                "Amount": {
                    "Quantity": {
                        "Value": 2
                    },
                    "UnitId": "00000000-0000-0000-0000-000000000000"
                },
                "Note": ""
            },
            {
                "FoodId": "dbfac0f0-5842-0000-27c3-41e8c688e289",
                "Amount": {
                    "Quantity": {
                        "Value": 4
                    },
                    "UnitId": "00000000-0000-0000-0000-000000000000"
                },
                "Note": ""
            }
        ],
        "GlycemicIndex": {
            "Value": 0
        },
        "Created": null,
        "Modified": null,
        "LegacyKey": 147370296,
        "LegacyNutrientRefNum": null,
        "LegacyYieldKey": null,
        "UserCode": "15",
        "UsdaCode": null,
        "EshaCode": null,
        "OwnerName": "",
        "AlternateNames": [],
        "AllergenStatements": [
            {
                "AllergenStatementText": {
                    "en-US": "",
                    "es-US": "",
                    "fr-CA": ""
                },
                "Authority": {
                    "Name": {
                        "en-US": "United States"
                    },
                    "Iso3166Alpha2": "US",
                    "Iso3166Alpha3": "",
                    "Iso3166Numeric": 840,
                    "Id": null
                },
                "AllergenGroups": [],
                "IsUserGenerated": false,
                "Id": null
            }
        ],
        "IngredientStatements": [
            {
                "AlternateName": "Genen Shouyu",
                "AlternateText": "Beef, PEAS AND CARROTS, FROZEN, BOILED, DRAINED, Cheese, cheddar, mild, shredded, Vodka Alcohol.",
                "Language": "en-US",
                "LanguageCode": 1,
                "Id": null
            },
            {
                "AlternateName": "Genen Shouyu",
                "AlternateText": "Carne vacuna, PEAS AND CARROTS, FROZEN, BOILED, DRAINED, Cheese, cheddar, mild, shredded, Vodka.",
                "Language": "es-MX",
                "LanguageCode": 2,
                "Id": null
            },
            {
                "AlternateName": "Genen Shouyu",
                "AlternateText": "Bœuf, PEAS AND CARROTS, FROZEN, BOILED, DRAINED, Cheese, cheddar, mild, shredded, Vodka.",
                "Language": "fr-CA",
                "LanguageCode": 3,
                "Id": null
            }
        ],
        "Brand": {
            "Supplier": "",
            "Product": "",
            "Id": null
        },
        "GroupsIds": [],
        "NutrientTransformIds": [],
        "Images": [],
        "Id": "dbfac0f0-b138-08c8-27c3-41e8c688e289"
    },
    "FoodItems": null,
    "Status": 0
}