Web service API

How to use PageSeeder's Web service API

clear member 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
uploadid The ID specific to the upload, if unspecified the general loading zone for the user and group will be cleared. no string

Permission

Undocumented permissions requirements.

Response

This service returns the following XML:

<files>
  <file name="[name]"
        path="[path]"
        type="[file|folder]"
        media-type="[media type]"
        status="[deleted|not-found]">
   <!-- files and subfolder if file is a folder -->
   ... 
  </file>
  ...
</files>

The @path attribute is the relative path from the root of the loading zone.

The @media-type attribute is determined based on the file extension and the MIME Properties

Error handling

No specific errors expected for this service.

Created on , last edited on