API Reference

Collections.updateCollectionInfo

Updates collection information such as title or description.


Syntax

bool collections.updateCollectionInfo ( int collection, string name = NULL, string description = NULL, int addToTop = NULL, int autoActive = NULL )

Arguments

NameTypeRequiredDefault valueDescription
collectionintRequirednoneThe ID of the collection you are updating.
namestringOptionalNULLThe new name of the collection.
descriptionstringOptionalNULLThe updated description of the collection.
addToTopintOptionalNULLThe updated addToTop value (0/1).
autoActiveintOptionalNULLThe updated autoActive value (0/1).

Response

The response will be 1 if the collection has been updated successfully. An error message will be returned if there was an error with the request (ie. invalid collection ID).

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/updateCollectionInfo?collection=[COLLECTION_ID]&name=[UPDATED_COLLECTION_NAME]&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 updateCollectionInfo.

Add a Comment

  • captcha