Collection.Clear

August 10, 2015

Description

Clears the contents of a collection but leaves the collection intact.
WARNING: This operation is permanent!

Required parameter

CollectionID

Optional parameter

DeleteFilePackages (‘Yes’, ‘No’ – Yes to delete all file packages for the collection. Default is No)
RetainCollectionHistory (‘Yes’, ‘No’ – Yes to only mark items as deleted. Default is No)

Returns

A message indicating whether or not the command was successful.

Example request url

https://api.mozenda.com/rest?WebServiceKey=C70E1F84-E12B-4e73-B199-2EE6D43AF44E&Service=Mozenda10&Operation=Collection.Clear&CollectionID=1099

Example response

<?xml version="1.0" encoding="utf-8" ?>
<CollectionClearResponse 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Result>Success</Result> 
</CollectionClearResponse>