Web service API

How to use PageSeeder's Web service API

<sharing>

Summary

This element is a container for the sharing information about a URI (document or external URL). It contains one or more <share> elements, one for each group the URI is shared with.

For a more detailed discussion on this share documents, see document sharing.

Note

URI sharing information is usually available when there is a context member: the groups listed are the ones the member has access to and the hidden attribute specifies the number of groups the URI is shared with that the user cannot see.

Usage context

Permitted content<share>
Permitted parent<uri>, <groupfolder>

Attributes

This element includes the following attributes

NameTypeRequiredDescription
statusenumyesWhether the URI is "shared" or "private".
hiddenxs:positiveIntegernoThe number of groups the URI is shared with but that are not visible to the current member
publicxs:booleannoWhether the URI is visible to public.

@status

This attribute's value shows whether the URI is "shared" to other groups or "private" to a single group. The value is one of the following:

  • "shared"
  • "private"

@hidden

This attribute's value is the number of groups that the URI is shared with but that the member cannot see.

@public

Flag whether public has access to the URI, this optional attribute's default value is false.

Examples

<sharing status="private">
  <share default="true" editable="true" addcomments="true" shareedits="true" sharexrefs="true">
    <group id="56" name="app-testing" description="App testing group" owner="app" access="member" common="false"/>
  </share>
</sharing>
<sharing status="shared" hidden="1" public="true">
  <share default="true" editable="true" addcomments="true" shareedits="false" sharexrefs="true">
    <group id="12" name="dev-group1" description="Dev group 1" owner="dev" access="member" common="false"/>
  </share>
  <share editable="false" addcomments="true" shareedits="false" sharexrefs="true">
    <group id="82" name="dev-group2" description="Dev group 2" owner="dev" access="member" common="false" relatedurl="http://dev.example.org/home.html"/>
  </share>
</sharing>

Schema

XML Schema

<xs:element name="sharing">
  <xs:sequence>
     <xs:element name="share" type="share" maxOccurs="unbounded"/>
  </xs:sequence>
  <xs:attribute name="status" use="required">
    <xs:simpleType>
      <xs:restriction base="xs:string">
        <xs:enumeration value="private" />
        <xs:enumeration value="shared" />
      </xs:restriction>
    </xs:simpleType>
  </xs:attribute>
  <xs:attribute name="hidden"        type="xs:positiveInteger" />
  <xs:attribute name="public"        type="boolean"       fixed="true"/>
</xs:element>

Compatibility

See also

Created on , last edited on