Collection.Clear

Updated on 17 Apr 2024
1 Minute to read
Contributors

Print
Share
Dark
Light
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

Description

Clears the contents of a collection but leaves the collection intact.

WARNING!

This operation is permanent!

URL Parameters

URL parameter ordering

The URL parameters below are listed in the order they should be entered in the API URL.

Name	Required	Type	Description
`CollectionID`	True	numeric	Unique identifier of the collection.
`DeleteFilePackages`	False	boolean	Yes, No, True, False - Yes/True to delete all file packages for the collection. Default is No.
`RetainCollectionHistory`	False	boolean	Yes, No, True, False - Yes/True to only mark items as deleted (rather than delete them completely). Default is No.
`ClearBookmarkItemCounts`	False	boolean	Yes, No, True, False - Yes/True to clear the bookmark item counts. Default is No.

Responses

Name	Type	Description
`Result`	string	`Success` if the operation was successful.

Sample request

curl -X GET 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Collection.Clear&CollectionID=1001'

Sample responses

XML

<?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>

JSON (add `&ResponseFormat=JSON`)

{
  "JsonResult": {
    "Command": "Collection.Clear",
    "AutoLoggedIn": false,
    "WebConsoleKey": "",
    "Result": "Success",
    "ErrorCode": "",
    "ErrorDescription": "",
    "ErrorList": [],
    "ExecutionTime": {
      "Ticks": 0,
      "Days": 0,
      "Hours": 0,
      "Milliseconds": 0,
      "Minutes": 0,
      "Seconds": 0,
      "TotalDays": 0,
      "TotalHours": 0,
      "TotalMilliseconds": 0,
      "TotalMinutes": 0,
      "TotalSeconds": 0
    }
  }
}

Was this article helpful?

What's Next

Collection.Delete