GET v{version}/dishes/{dishId}/nutrition

Details

Get a dish nutrition response for a specific dish.

https://api.procurewizard.com/v1.0/dishes/{dishId}/nutrition

Request

URI Parameters

These are parameters passed as part of the URL in the request.

Name Description Type Additional information
dishId

The ID of the dish to retrieve nutrition data for.

integer

Required

version

The API version parameter. The current version is 1.0.

string

None

Response

Response Description

A response object of DishNutritionResponse
Name Description Type Additional information
data

The responses data.

DishNutritionResponseData

None

jsonApi

Implementation details of JSON:API.

Implementation

None

links

Related links.

Links

None

meta

A meta object used to include non-standard meta-information. Client meta data will be ignored by the server.

MetaData

None

Response Formats

Example responses of what the data might contain.

    
{
  "data": {
    "id": "12345",
    "type": "dishnutrition",
    "attributes": {
      "totalWeight": 1.0,
      "energy": {
        "totalValueForItem": 1.0,
        "valueFor100Grams": 2.0,
        "referenceIntake": 1.0
      },
      "energyKcal": {
        "totalValueForItem": 1.0,
        "valueFor100Grams": 2.0,
        "referenceIntake": 1.0
      },
      "fat": {
        "totalValueForItem": 1.0,
        "valueFor100Grams": 2.0,
        "referenceIntake": 1.0
      },
      "saturates": {
        "totalValueForItem": 1.0,
        "valueFor100Grams": 2.0,
        "referenceIntake": 1.0
      },
      "carbohydrate": {
        "totalValueForItem": 1.0,
        "valueFor100Grams": 2.0,
        "referenceIntake": 1.0
      },
      "sugars": {
        "totalValueForItem": 1.0,
        "valueFor100Grams": 2.0,
        "referenceIntake": 1.0
      },
      "fibre": {
        "totalValueForItem": 1.0,
        "valueFor100Grams": 2.0,
        "referenceIntake": 1.0
      },
      "protein": {
        "totalValueForItem": 1.0,
        "valueFor100Grams": 2.0,
        "referenceIntake": 1.0
      },
      "salt": {
        "totalValueForItem": 1.0,
        "valueFor100Grams": 2.0,
        "referenceIntake": 1.0
      }
    }
  },
  "links": {
    "self": {
      "href": "http://example-url-1.com"
    },
    "related": {
      "href": "http://example-url-1.com"
    }
  },
  "meta": {
    "copyright": "© 2025 The Access Group"
  },
  "jsonApi": {
    "version": "1.0"
  }
}
    
    
<DishNutritionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.Nutrition">
  <JsonApi xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
    <d2p1:Version>1.0</d2p1:Version>
  </JsonApi>
  <Links xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">
    <Related xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
      <d3p1:Href>http://example-url-1.com/</d3p1:Href>
      <d3p1:Meta i:nil="true" />
    </Related>
    <Self xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
      <d3p1:Href>http://example-url-1.com/</d3p1:Href>
      <d3p1:Meta i:nil="true" />
    </Self>
  </Links>
  <Meta xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">
    <Copyright>© 2025 The Access Group</Copyright>
  </Meta>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.Nutrition" xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api">
    <Id xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">12345</Id>
    <Attributes xmlns="http://schemas.datacontract.org/2004/07/ProcureWizard.Infrastructure.Api.JsonApi">
      <d2p1:Carbohydrate>
        <d2p1:ReferenceIntake>1</d2p1:ReferenceIntake>
        <d2p1:TotalValueForItem>1</d2p1:TotalValueForItem>
        <d2p1:TrafficLightValue i:nil="true" />
        <d2p1:ValueFor100Grams>2</d2p1:ValueFor100Grams>
      </d2p1:Carbohydrate>
      <d2p1:Energy>
        <d2p1:ReferenceIntake>1</d2p1:ReferenceIntake>
        <d2p1:TotalValueForItem>1</d2p1:TotalValueForItem>
        <d2p1:TrafficLightValue i:nil="true" />
        <d2p1:ValueFor100Grams>2</d2p1:ValueFor100Grams>
      </d2p1:Energy>
      <d2p1:EnergyKcal>
        <d2p1:ReferenceIntake>1</d2p1:ReferenceIntake>
        <d2p1:TotalValueForItem>1</d2p1:TotalValueForItem>
        <d2p1:TrafficLightValue i:nil="true" />
        <d2p1:ValueFor100Grams>2</d2p1:ValueFor100Grams>
      </d2p1:EnergyKcal>
      <d2p1:Fat>
        <d2p1:ReferenceIntake>1</d2p1:ReferenceIntake>
        <d2p1:TotalValueForItem>1</d2p1:TotalValueForItem>
        <d2p1:TrafficLightValue i:nil="true" />
        <d2p1:ValueFor100Grams>2</d2p1:ValueFor100Grams>
      </d2p1:Fat>
      <d2p1:Fibre>
        <d2p1:ReferenceIntake>1</d2p1:ReferenceIntake>
        <d2p1:TotalValueForItem>1</d2p1:TotalValueForItem>
        <d2p1:TrafficLightValue i:nil="true" />
        <d2p1:ValueFor100Grams>2</d2p1:ValueFor100Grams>
      </d2p1:Fibre>
      <d2p1:Protein>
        <d2p1:ReferenceIntake>1</d2p1:ReferenceIntake>
        <d2p1:TotalValueForItem>1</d2p1:TotalValueForItem>
        <d2p1:TrafficLightValue i:nil="true" />
        <d2p1:ValueFor100Grams>2</d2p1:ValueFor100Grams>
      </d2p1:Protein>
      <d2p1:Salt>
        <d2p1:ReferenceIntake>1</d2p1:ReferenceIntake>
        <d2p1:TotalValueForItem>1</d2p1:TotalValueForItem>
        <d2p1:TrafficLightValue i:nil="true" />
        <d2p1:ValueFor100Grams>2</d2p1:ValueFor100Grams>
      </d2p1:Salt>
      <d2p1:Saturates>
        <d2p1:ReferenceIntake>1</d2p1:ReferenceIntake>
        <d2p1:TotalValueForItem>1</d2p1:TotalValueForItem>
        <d2p1:TrafficLightValue i:nil="true" />
        <d2p1:ValueFor100Grams>2</d2p1:ValueFor100Grams>
      </d2p1:Saturates>
      <d2p1:Sugars>
        <d2p1:ReferenceIntake>1</d2p1:ReferenceIntake>
        <d2p1:TotalValueForItem>1</d2p1:TotalValueForItem>
        <d2p1:TrafficLightValue i:nil="true" />
        <d2p1:ValueFor100Grams>2</d2p1:ValueFor100Grams>
      </d2p1:Sugars>
      <d2p1:TotalWeight>1</d2p1:TotalWeight>
    </Attributes>
  </Data>
</DishNutritionResponse>
    

Back