getprop

Get the properties of a Library member or of a hierarchy of members.

HTTP Request: GET

Parameters:

Name Value Description
path Path of the Library member to get. Can be specified explicitly or as the remainder the HTTP URL.
depth

if depth=0, get only properties of the member itself.

If depth > 0, the Library member must be a Collection. Descend the collection tree down to this depth and return properties of each Library member. Note that the returned list of members is flat.

properties [optional] names of properties to return. By default, all properties are returned. The names are separated by commas or whitespace.
library Name of Library used (can be empty if exactly one Library in server).

Response:

mime-type: text/xml or text/plain

The return format is one or several element 'properties' wrapped in a 'getprop' element. Each element 'properties' corresponds with a Document or Collection and contains a list of elements 'property' with a name a type and a value:

<getprop>
 <properties path="/plays/hamlet.xml">
   <property name="dtd-name">PLAY</property>
   <property name="dtd-system-id">play.dtd</property>
   <property name="nature">document</property>
   <property name="path">/plays/hamlet.xml</property>
   <property name="size" type="integer">274083</property>
 </properties> 
 <properties path="/plays/r_and_j.xml">
   <property name="dtd-name">PLAY</property>
   ...
 </properties> 
</getprop>

Error codes:

NotFound
when the Library member does not exist.
AccessControl
when the user is not allowed to read the root Library member. Note that Library members than cannot be read by a user do not appear in the result.