Show Source

• count: integer
  Number of records returned on this page

  Example: 10
• hasMore: boolean
  Indicates whether there are additional pages of records

  Example: true
• items: array items
  Nutrient records
• limit: integer
  The maximum number of records returned on a page

  Example: 10
• offset: integer
  The page number of this data. Starts at 0.

  Example: 0
• totalResults: integer
  Total number of records in the data set

  Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "description":"Total number of records in the data set",
            "type":"integer",
            "example":100
        },
        "hasMore":{
            "description":"Indicates whether there are additional pages of records",
            "type":"boolean",
            "example":true
        },
        "count":{
            "description":"Number of records returned on this page",
            "type":"integer",
            "example":10
        },
        "offset":{
            "description":"The page number of this data. Starts at 0.",
            "type":"integer",
            "example":0
        },
        "limit":{
            "description":"The maximum number of records returned on a page",
            "type":"integer",
            "example":10
        },
        "items":{
            "description":"Nutrient records",
            "type":"array",
            "items":{
                "$ref":"#/definitions/NutrientSetNutrient"
            }
        }
    }
}

Show Source

• Array of: object NutrientSetNutrient
  Nutrient record

{
    "description":"Nutrient records",
    "type":"array",
    "items":{
        "$ref":"#/definitions/NutrientSetNutrient"
    }
}

Show Source

• hierUnitId: integer
  Unique reference of the hierarchy unit. Only Enterprise hierarchy is allowed.

  Example: 3599
• nutrientSetNutrientId: integer
  Unique Id of the nutrient.

  Example: 101
• nutrientSetObjNum: integer
  Object number of the nutrient set.

  Example: 50
• nutritionNameObjNum: integer
  Default Value: 0

  Object number of the nutrition name.

  Example: 8
• quantity: integer
  Default Value: 0

  quantity of the nutrient.

  Example: 10
• unitOfMeasure: integer
  Minimum Value: 1

  Maximum Value: 4

  Default Value: 1

  An integer representing the unit of measurement for quantity. Acceptable values range from 1 to 4 (both inclusive).

  Unit Of Measurement	Description
  1	Calories
  2	KiloJoules
  3	Grams
  4	Milligrams

  Example: 2

{
    "description":"Nutrient record",
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit. Only Enterprise hierarchy is allowed.",
            "type":"integer",
            "example":3599
        },
        "nutrientSetObjNum":{
            "description":"Object number of the nutrient set.",
            "type":"integer",
            "example":50
        },
        "nutrientSetNutrientId":{
            "description":"Unique Id of the nutrient.",
            "type":"integer",
            "example":101
        },
        "nutritionNameObjNum":{
            "description":"Object number of the nutrition name.",
            "default":0,
            "type":"integer",
            "example":8
        },
        "unitOfMeasure":{
            "description":"An integer representing the unit of measurement for quantity. Acceptable values range from 1 to 4 (both inclusive). <table> <tr><th>Unit Of Measurement</th><th>Description</th></tr> <tr><td> 1 </td><td> Calories </td></tr> <tr><td> 2 </td><td> KiloJoules </td></tr> <tr><td> 3 </td><td> Grams </td></tr> <tr><td> 4 </td><td> Milligrams </td></tr> </table>",
            "type":"integer",
            "minimum":1,
            "maximum":4,
            "default":1,
            "example":2
        },
        "quantity":{
            "description":"quantity of the nutrient.",
            "default":0,
            "type":"integer",
            "example":10
        }
    }
}