Web service API

How to use PageSeeder's Web service API

clear loading zone

/members/{member}/groups/{group}/loadingzone/clear [POST]

com.pageseeder.load.generators.LoadingZoneClear

Description

Clearing the content in a member loading zone.

The Loading zone contains all the temporary files to upload. It is specific to a member and group. This service can be used to delete all the temporary files in the loading zone.

This generally should generally be done after a successful upload or as part of a general maintenance.

Parameters

NameDescriptionRequiredTypeDefault value
uploadidThe ID specific to the upload, if unspecified the general loading zone for the user and group will be used.nostring
xlinkidA comment ID used to build an upload ID (used for comment attachments' loading zone).nolong

Permission

Undocumented permissions requirements.

Response

This service returns the following XML:

<load-clear filesremoved="[count]" />

Error Handling

No specific errors expected for this service.

Created on , last edited on