Web service API

How to use PageSeeder's Web service API

get loading zone tree

/members/{member}/groups/{group}/loadingzone/tree [GET]

com.pageseeder.load.generators.LoadingZoneAsTree

Description

Returns a hierarchical representation of the loading zone.

Parameters

NameDescriptionRequiredTypeDefault value
uploadidThe loading zone's upload ID.nostring
xlinkidAn XLink ID used to build an upload ID (used for comment attachments' loading zone).nostring

Permission

Permissions requirements to be updated.

Response

If there are more than 1000 files, only folders will be returned. If there are more than 100 files in a folder, only the first 100 are returned and the count is added.

<loadingzone member="[memberid]" 
            [uploadid="[uploadid]"] 
            total-files="[total]">
    <file name="[filename]" 
          path="[path]" 
          type="folder" 
          [files="[count]"]>
        <file name="[filename]" 
              path="[path]" 
              type="file" ... />
        <file name="[filename]" 
              path="[path]" 
              type="file" ... />
        ...
        <file name="[filename]" 
              path="[path]" 
              type="folder" 
              [files="[count]"]>
            <file name="[filename]" 
                  path="[path]" 
                  type="file" ... />
        ...
        </file>
    </file>
    <file name="[filename]" 
          path="[path]" 
          type="file" ... />
    ...
</loadingzone>

Error Handling

No specific errors expected for this generator.

Created on , last edited on