Kraft Recipe Web Service


Click here for a complete list of operations.

GetRecipeByRecipeIDWithExtraInformation

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
iRecipeID:
bStripHTML:
iBrandID:
iLangID:
bIncludeExtraInformation:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /ws/RecipeWS.asmx HTTP/1.1
Host: www.kraftfoods.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.kraftfoods.com/ws/GetRecipeByRecipeIDWithExtraInformation"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetRecipeByRecipeIDWithExtraInformation xmlns="http://www.kraftfoods.com/ws/">
      <iRecipeID>int</iRecipeID>
      <bStripHTML>boolean</bStripHTML>
      <iBrandID>int</iBrandID>
      <iLangID>int</iLangID>
      <bIncludeExtraInformation>boolean</bIncludeExtraInformation>
    </GetRecipeByRecipeIDWithExtraInformation>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetRecipeByRecipeIDWithExtraInformationResponse xmlns="http://www.kraftfoods.com/ws/">
      <GetRecipeByRecipeIDWithExtraInformationResult>
        <Status>string</Status>
        <RecipeDetail>
          <IngredientDetails>
            <IngredientDetail xsi:nil="true" />
            <IngredientDetail xsi:nil="true" />
          </IngredientDetails>
          <PreparationDetails>
            <PreparationDetail xsi:nil="true" />
            <PreparationDetail xsi:nil="true" />
          </PreparationDetails>
          <NutritionItemDetails>
            <NutritionItemDetail xsi:nil="true" />
            <NutritionItemDetail xsi:nil="true" />
          </NutritionItemDetails>
          <NutritionGridItemDetails>
            <NutritionGridItemDetail xsi:nil="true" />
            <NutritionGridItemDetail xsi:nil="true" />
          </NutritionGridItemDetails>
          <RatingDetails>
            <RatingDetail xsi:nil="true" />
            <RatingDetail xsi:nil="true" />
          </RatingDetails>
          <ComplimentaryRecipes>
            <RecipeSummary xsi:nil="true" />
            <RecipeSummary xsi:nil="true" />
          </ComplimentaryRecipes>
          <RecipeTipDetails>
            <RecipeTipDetail xsi:nil="true" />
            <RecipeTipDetail xsi:nil="true" />
          </RecipeTipDetails>
        </RecipeDetail>
      </GetRecipeByRecipeIDWithExtraInformationResult>
    </GetRecipeByRecipeIDWithExtraInformationResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /ws/RecipeWS.asmx HTTP/1.1
Host: www.kraftfoods.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetRecipeByRecipeIDWithExtraInformation xmlns="http://www.kraftfoods.com/ws/">
      <iRecipeID>int</iRecipeID>
      <bStripHTML>boolean</bStripHTML>
      <iBrandID>int</iBrandID>
      <iLangID>int</iLangID>
      <bIncludeExtraInformation>boolean</bIncludeExtraInformation>
    </GetRecipeByRecipeIDWithExtraInformation>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetRecipeByRecipeIDWithExtraInformationResponse xmlns="http://www.kraftfoods.com/ws/">
      <GetRecipeByRecipeIDWithExtraInformationResult>
        <Status>string</Status>
        <RecipeDetail>
          <IngredientDetails>
            <IngredientDetail xsi:nil="true" />
            <IngredientDetail xsi:nil="true" />
          </IngredientDetails>
          <PreparationDetails>
            <PreparationDetail xsi:nil="true" />
            <PreparationDetail xsi:nil="true" />
          </PreparationDetails>
          <NutritionItemDetails>
            <NutritionItemDetail xsi:nil="true" />
            <NutritionItemDetail xsi:nil="true" />
          </NutritionItemDetails>
          <NutritionGridItemDetails>
            <NutritionGridItemDetail xsi:nil="true" />
            <NutritionGridItemDetail xsi:nil="true" />
          </NutritionGridItemDetails>
          <RatingDetails>
            <RatingDetail xsi:nil="true" />
            <RatingDetail xsi:nil="true" />
          </RatingDetails>
          <ComplimentaryRecipes>
            <RecipeSummary xsi:nil="true" />
            <RecipeSummary xsi:nil="true" />
          </ComplimentaryRecipes>
          <RecipeTipDetails>
            <RecipeTipDetail xsi:nil="true" />
            <RecipeTipDetail xsi:nil="true" />
          </RecipeTipDetails>
        </RecipeDetail>
      </GetRecipeByRecipeIDWithExtraInformationResult>
    </GetRecipeByRecipeIDWithExtraInformationResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /ws/RecipeWS.asmx/GetRecipeByRecipeIDWithExtraInformation?iRecipeID=string&bStripHTML=string&iBrandID=string&iLangID=string&bIncludeExtraInformation=string HTTP/1.1
Host: www.kraftfoods.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<RecipeDetailResponse xmlns="http://www.kraftfoods.com/ws/">
  <Status>string</Status>
  <RecipeDetail>
    <IngredientDetails>
      <IngredientDetail>
        <RecipeIngredientID>int</RecipeIngredientID>
        <IngredientID>int</IngredientID>
        <IngredientName>string</IngredientName>
        <QuantityText>string</QuantityText>
        <QuantityNum>string</QuantityNum>
        <QuantityUnit>string</QuantityUnit>
        <PostPreparation>string</PostPreparation>
        <PrePreparation>string</PrePreparation>
        <LinkURL>string</LinkURL>
        <LinkText>string</LinkText>
        <Headline>string</Headline>
        <ImageURL>string</ImageURL>
        <Description>string</Description>
        <RolloverHTML>string</RolloverHTML>
        <RecipeIngredientGridHeaderDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </IngredientDetail>
      <IngredientDetail>
        <RecipeIngredientID>int</RecipeIngredientID>
        <IngredientID>int</IngredientID>
        <IngredientName>string</IngredientName>
        <QuantityText>string</QuantityText>
        <QuantityNum>string</QuantityNum>
        <QuantityUnit>string</QuantityUnit>
        <PostPreparation>string</PostPreparation>
        <PrePreparation>string</PrePreparation>
        <LinkURL>string</LinkURL>
        <LinkText>string</LinkText>
        <Headline>string</Headline>
        <ImageURL>string</ImageURL>
        <Description>string</Description>
        <RolloverHTML>string</RolloverHTML>
        <RecipeIngredientGridHeaderDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </IngredientDetail>
    </IngredientDetails>
    <PreparationDetails>
      <PreparationDetail>
        <Description>string</Description>
        <Sequence>string</Sequence>
      </PreparationDetail>
      <PreparationDetail>
        <Description>string</Description>
        <Sequence>string</Sequence>
      </PreparationDetail>
    </PreparationDetails>
    <NutritionItemDetails>
      <NutritionItemDetail>
        <NutritionItemID>int</NutritionItemID>
        <NutritionItemName>string</NutritionItemName>
        <Quantity>string</Quantity>
        <Unit>string</Unit>
        <DisplayOrder>int</DisplayOrder>
      </NutritionItemDetail>
      <NutritionItemDetail>
        <NutritionItemID>int</NutritionItemID>
        <NutritionItemName>string</NutritionItemName>
        <Quantity>string</Quantity>
        <Unit>string</Unit>
        <DisplayOrder>int</DisplayOrder>
      </NutritionItemDetail>
    </NutritionItemDetails>
    <NutritionGridItemDetails>
      <NutritionGridItemDetail>
        <NutritionExchangeItemDesc>string</NutritionExchangeItemDesc>
        <NutritionItemDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </NutritionGridItemDetail>
      <NutritionGridItemDetail>
        <NutritionExchangeItemDesc>string</NutritionExchangeItemDesc>
        <NutritionItemDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </NutritionGridItemDetail>
    </NutritionGridItemDetails>
    <RatingDetails>
      <RatingDetail>
        <Rating>string</Rating>
        <UserName>string</UserName>
        <SubmitDate>string</SubmitDate>
        <SubmitDateJS>string</SubmitDateJS>
        <UpdatedDate>string</UpdatedDate>
        <Comments>string</Comments>
      </RatingDetail>
      <RatingDetail>
        <Rating>string</Rating>
        <UserName>string</UserName>
        <SubmitDate>string</SubmitDate>
        <SubmitDateJS>string</SubmitDateJS>
        <UpdatedDate>string</UpdatedDate>
        <Comments>string</Comments>
      </RatingDetail>
    </RatingDetails>
    <ComplimentaryRecipes>
      <RecipeSummary>
        <CarbChoices>string</CarbChoices>
        <RecipeType>int</RecipeType>
        <LanguageID>int</LanguageID>
        <PreparationPretext>string</PreparationPretext>
        <PointToType>string</PointToType>
        <WebPageName>string</WebPageName>
        <RecipeID>int</RecipeID>
        <RecipeName>string</RecipeName>
        <PrepTime>string</PrepTime>
        <TotalTime>string</TotalTime>
        <NumberOfServings>string</NumberOfServings>
        <NumberOfIngredients>string</NumberOfIngredients>
        <AvgRating>string</AvgRating>
        <NumberOfRatings>string</NumberOfRatings>
        <IsHealthy>boolean</IsHealthy>
        <PhotoURL>string</PhotoURL>
        <RecipeClassifications d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RecipeCategories d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DisplayDate>string</DisplayDate>
      </RecipeSummary>
      <RecipeSummary>
        <CarbChoices>string</CarbChoices>
        <RecipeType>int</RecipeType>
        <LanguageID>int</LanguageID>
        <PreparationPretext>string</PreparationPretext>
        <PointToType>string</PointToType>
        <WebPageName>string</WebPageName>
        <RecipeID>int</RecipeID>
        <RecipeName>string</RecipeName>
        <PrepTime>string</PrepTime>
        <TotalTime>string</TotalTime>
        <NumberOfServings>string</NumberOfServings>
        <NumberOfIngredients>string</NumberOfIngredients>
        <AvgRating>string</AvgRating>
        <NumberOfRatings>string</NumberOfRatings>
        <IsHealthy>boolean</IsHealthy>
        <PhotoURL>string</PhotoURL>
        <RecipeClassifications d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RecipeCategories d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DisplayDate>string</DisplayDate>
      </RecipeSummary>
    </ComplimentaryRecipes>
    <RecipeTipDetails>
      <RecipeTipDetail>
        <RecipeID>int</RecipeID>
        <TipID>int</TipID>
        <TipType>string</TipType>
        <TipName>string</TipName>
        <TipDescription>string</TipDescription>
        <Sequence>int</Sequence>
      </RecipeTipDetail>
      <RecipeTipDetail>
        <RecipeID>int</RecipeID>
        <TipID>int</TipID>
        <TipType>string</TipType>
        <TipName>string</TipName>
        <TipDescription>string</TipDescription>
        <Sequence>int</Sequence>
      </RecipeTipDetail>
    </RecipeTipDetails>
  </RecipeDetail>
</RecipeDetailResponse>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /ws/RecipeWS.asmx/GetRecipeByRecipeIDWithExtraInformation HTTP/1.1
Host: www.kraftfoods.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

iRecipeID=string&bStripHTML=string&iBrandID=string&iLangID=string&bIncludeExtraInformation=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<RecipeDetailResponse xmlns="http://www.kraftfoods.com/ws/">
  <Status>string</Status>
  <RecipeDetail>
    <IngredientDetails>
      <IngredientDetail>
        <RecipeIngredientID>int</RecipeIngredientID>
        <IngredientID>int</IngredientID>
        <IngredientName>string</IngredientName>
        <QuantityText>string</QuantityText>
        <QuantityNum>string</QuantityNum>
        <QuantityUnit>string</QuantityUnit>
        <PostPreparation>string</PostPreparation>
        <PrePreparation>string</PrePreparation>
        <LinkURL>string</LinkURL>
        <LinkText>string</LinkText>
        <Headline>string</Headline>
        <ImageURL>string</ImageURL>
        <Description>string</Description>
        <RolloverHTML>string</RolloverHTML>
        <RecipeIngredientGridHeaderDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </IngredientDetail>
      <IngredientDetail>
        <RecipeIngredientID>int</RecipeIngredientID>
        <IngredientID>int</IngredientID>
        <IngredientName>string</IngredientName>
        <QuantityText>string</QuantityText>
        <QuantityNum>string</QuantityNum>
        <QuantityUnit>string</QuantityUnit>
        <PostPreparation>string</PostPreparation>
        <PrePreparation>string</PrePreparation>
        <LinkURL>string</LinkURL>
        <LinkText>string</LinkText>
        <Headline>string</Headline>
        <ImageURL>string</ImageURL>
        <Description>string</Description>
        <RolloverHTML>string</RolloverHTML>
        <RecipeIngredientGridHeaderDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </IngredientDetail>
    </IngredientDetails>
    <PreparationDetails>
      <PreparationDetail>
        <Description>string</Description>
        <Sequence>string</Sequence>
      </PreparationDetail>
      <PreparationDetail>
        <Description>string</Description>
        <Sequence>string</Sequence>
      </PreparationDetail>
    </PreparationDetails>
    <NutritionItemDetails>
      <NutritionItemDetail>
        <NutritionItemID>int</NutritionItemID>
        <NutritionItemName>string</NutritionItemName>
        <Quantity>string</Quantity>
        <Unit>string</Unit>
        <DisplayOrder>int</DisplayOrder>
      </NutritionItemDetail>
      <NutritionItemDetail>
        <NutritionItemID>int</NutritionItemID>
        <NutritionItemName>string</NutritionItemName>
        <Quantity>string</Quantity>
        <Unit>string</Unit>
        <DisplayOrder>int</DisplayOrder>
      </NutritionItemDetail>
    </NutritionItemDetails>
    <NutritionGridItemDetails>
      <NutritionGridItemDetail>
        <NutritionExchangeItemDesc>string</NutritionExchangeItemDesc>
        <NutritionItemDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </NutritionGridItemDetail>
      <NutritionGridItemDetail>
        <NutritionExchangeItemDesc>string</NutritionExchangeItemDesc>
        <NutritionItemDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </NutritionGridItemDetail>
    </NutritionGridItemDetails>
    <RatingDetails>
      <RatingDetail>
        <Rating>string</Rating>
        <UserName>string</UserName>
        <SubmitDate>string</SubmitDate>
        <SubmitDateJS>string</SubmitDateJS>
        <UpdatedDate>string</UpdatedDate>
        <Comments>string</Comments>
      </RatingDetail>
      <RatingDetail>
        <Rating>string</Rating>
        <UserName>string</UserName>
        <SubmitDate>string</SubmitDate>
        <SubmitDateJS>string</SubmitDateJS>
        <UpdatedDate>string</UpdatedDate>
        <Comments>string</Comments>
      </RatingDetail>
    </RatingDetails>
    <ComplimentaryRecipes>
      <RecipeSummary>
        <CarbChoices>string</CarbChoices>
        <RecipeType>int</RecipeType>
        <LanguageID>int</LanguageID>
        <PreparationPretext>string</PreparationPretext>
        <PointToType>string</PointToType>
        <WebPageName>string</WebPageName>
        <RecipeID>int</RecipeID>
        <RecipeName>string</RecipeName>
        <PrepTime>string</PrepTime>
        <TotalTime>string</TotalTime>
        <NumberOfServings>string</NumberOfServings>
        <NumberOfIngredients>string</NumberOfIngredients>
        <AvgRating>string</AvgRating>
        <NumberOfRatings>string</NumberOfRatings>
        <IsHealthy>boolean</IsHealthy>
        <PhotoURL>string</PhotoURL>
        <RecipeClassifications d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RecipeCategories d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DisplayDate>string</DisplayDate>
      </RecipeSummary>
      <RecipeSummary>
        <CarbChoices>string</CarbChoices>
        <RecipeType>int</RecipeType>
        <LanguageID>int</LanguageID>
        <PreparationPretext>string</PreparationPretext>
        <PointToType>string</PointToType>
        <WebPageName>string</WebPageName>
        <RecipeID>int</RecipeID>
        <RecipeName>string</RecipeName>
        <PrepTime>string</PrepTime>
        <TotalTime>string</TotalTime>
        <NumberOfServings>string</NumberOfServings>
        <NumberOfIngredients>string</NumberOfIngredients>
        <AvgRating>string</AvgRating>
        <NumberOfRatings>string</NumberOfRatings>
        <IsHealthy>boolean</IsHealthy>
        <PhotoURL>string</PhotoURL>
        <RecipeClassifications d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RecipeCategories d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DisplayDate>string</DisplayDate>
      </RecipeSummary>
    </ComplimentaryRecipes>
    <RecipeTipDetails>
      <RecipeTipDetail>
        <RecipeID>int</RecipeID>
        <TipID>int</TipID>
        <TipType>string</TipType>
        <TipName>string</TipName>
        <TipDescription>string</TipDescription>
        <Sequence>int</Sequence>
      </RecipeTipDetail>
      <RecipeTipDetail>
        <RecipeID>int</RecipeID>
        <TipID>int</TipID>
        <TipType>string</TipType>
        <TipName>string</TipName>
        <TipDescription>string</TipDescription>
        <Sequence>int</Sequence>
      </RecipeTipDetail>
    </RecipeTipDetails>
  </RecipeDetail>
</RecipeDetailResponse>