API Reference

Collections.deleteCollection

Deletes a saved search or manual collection.


Syntax

bool collections.deleteCollection ( int id, int vhost = NULL )

Arguments

NameTypeRequiredDefault valueDescription
idintRequirednoneThe ID of collection that is to be deleted.
vhostintOptionalNULLThe vhost ID that the collection belongs to.

Response

The response for the successful deletion of a collection.

NameTypeDescriptionDefault Values
resultINTUpon success the response will be a 1.1 = success, error message

Sample Response

Sample REST Response
http://api.filemobile.com/services/rest/collections/deleteCollection?vhost=[VHOST_ID]&id=[COLLECTION_ID]&APIKEY=[APIKEY]
<?xml version="1.0" encoding="UTF-8"?>
<result>1</result>
Sample JSON Response
{
    "status": true,
    "result": 1
}

Code examples

0 comments

Be the first to comment on deleteCollection.

Add a Comment

  • captcha