deleteItem()

Pixelsilk API function to remove a list item
Parameters:
itemId: the unique identifier of the list item
deleteMode: whether deletion is for the item alone or for the series it is in

Output:
The function deleteItem returns void.

C# Example:
Guid itemId = <list item's id>;
string deleteMode = "item";
DeleteItem(itemId, deleteMode);
Note the capital first letter of the C# method.

HTTP Example:
Request Headers:
POST /api2/deleteItem HTTP/1.1
HOST: www.example.com
Content-Length: 161
Content-Type: application/x-www-form-urlencoded
Cookie: auth=967ECE1DAB8F...8C2B4C5082A5

Request Data:
Unencoded Data:
json={
   "itemId":"c9d7ae3c-9b8f-4fa8-ad73-9dcac07cc561",
   "deleteMode":"item"
}&token=7AdbNHZQBtwc...RPTEK8UvSUQ=

Url-encoded Data:
json=%7b%0d%0a+++...%22%0d%0a%7d&token=7AdbNHZQBtwc...TEK8UvSUQ%3d

Response Headers:
HTTP/1.1 200 OK
Set-Cookie: auth=E09ED4B996B5...77973B3C40C; path=/
Content-Type: text/javascript; charset=UTF-8
Content-Length: 2

Response Data:
{}

JavaScript Example:
Method Call:
pixelsilk2.deleteItem(input, callback);

Input Object:
{
    itemId:"fc1f974a-92e0-4b8b-bc5f-a4a639cf0386",
    deleteMode:"item"
}

Returned Data:
{}

Back to List Items »