Skip to main content

 Services

Web services from /about to /webhooks

get loading zone

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

Description

Returns a flat (non hierarchical) representation of the loading zone. Does not include META-INF files.

The content of files in the loading zone can be accessed using Service: /upload/get [GET].

Parameters

NameDescriptionRequiredTypeDefault value
uploadidThe loading zone’s upload IDnostring
xlinkidAn XLink ID used to build an upload ID (used for comment attachments’ loading zone)nostring
mediaWhether to return media types and zip files onlynobooleanfalse

Permission

Response

If there are not more than 20 files, then all files only are returned:

<loadingzone member="[memberid]" 
             [uploadid="[uploadid]"] 
             max-workflow-notifications="20">
  <file name="[filename]" 
        path="[path]" 
        type="file" ... />
  <file name="[filename]" 
        path="[path]" 
        type="file" ... />
  ...
</loadingzone>
 

If there are more than 20 files or media="true", then zip files and media types only are included:

<loadingzone member="[memberid]"
             [uploadid="[uploadid]"] 
             max-workflow-notifications="20">
  <file name="[filename]" 
        path="[path.zip]" 
        type="file" ... />
  <mediatype value="[media type]" 
             files="[nb of files]">
    <file name="[filename]" 
          path="[path]" 
          type="file" ... />
    <!-- The first file is included as an example -->
  </mediatype>
  ...
</loadingzone>
 

Error Handling

No specific errors expected for this service.

Created on , last edited on