Kraft Recipe Web Service


Click here for a complete list of operations.

AddShoppingList

Creates the specified shopping list on behalf of the specified user. If specified shopping list already exists, does not recreate it and returns existing list's ID. If user already has 2 or more shopping lists, does not create specified shopping list and returns status of "error" and ErrorCode of 1. Under all other circumstances, ErrorCode is returned as 0.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
iSiteUserID:
sShoppingListName:

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/AddShoppingList"

<?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>
    <AddShoppingList xmlns="http://www.kraftfoods.com/ws/">
      <iSiteUserID>int</iSiteUserID>
      <sShoppingListName>string</sShoppingListName>
    </AddShoppingList>
  </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>
    <AddShoppingListResponse xmlns="http://www.kraftfoods.com/ws/">
      <AddShoppingListResult>
        <ShoppingListId>int</ShoppingListId>
        <ErrorCode>int</ErrorCode>
      </AddShoppingListResult>
    </AddShoppingListResponse>
  </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>
    <AddShoppingList xmlns="http://www.kraftfoods.com/ws/">
      <iSiteUserID>int</iSiteUserID>
      <sShoppingListName>string</sShoppingListName>
    </AddShoppingList>
  </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>
    <AddShoppingListResponse xmlns="http://www.kraftfoods.com/ws/">
      <AddShoppingListResult>
        <ShoppingListId>int</ShoppingListId>
        <ErrorCode>int</ErrorCode>
      </AddShoppingListResult>
    </AddShoppingListResponse>
  </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/AddShoppingList?iSiteUserID=string&sShoppingListName=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"?>
<ShoppingListResponse xmlns="http://www.kraftfoods.com/ws/">
  <ShoppingListId>int</ShoppingListId>
  <ErrorCode>int</ErrorCode>
</ShoppingListResponse>

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/AddShoppingList HTTP/1.1
Host: www.kraftfoods.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<ShoppingListResponse xmlns="http://www.kraftfoods.com/ws/">
  <ShoppingListId>int</ShoppingListId>
  <ErrorCode>int</ErrorCode>
</ShoppingListResponse>