Web service API

How to use PageSeeder's Web service API

<share>

Summary

The <share> element is used to display sharing information about a URI (document or external URL). It contains an element that represents a group that the URI is shared with and its attributes specify what is accessible from said group.

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

Usage context

Permitted content<group>
Permitted parent<sharing>

Attributes

For a document URI (internal), this element includes the following attributes:

NameTypeRequiredDescription
ownerxs:booleannoIf the group is the owner of the document.
editablexs:booleannoIf the group members can edit the document.
addcommentsxs:booleannoIf the group members can add comments to the document.
shareeditsxs:booleannoIf the document edits are shared with the group.
sharexrefsxs:booleannoIf the document xrefs are shared with the group.

For a URL (external), this element includes only the following attribute:

groupspecificxs:stringnoComma-separated list of metadata the group can edit.

@owner

Flag whether the group is the owner of the document, this optional attribute's default value is false.

@editable

Flag whether the document is editable in the group, this value is always true for the default group or for all groups if there is no default group.

@addcomments

Flag whether the group members can add comments to the document.

@shareedits

Flag whether the document edits are shared with the group. This value is based on the group property shareDocumentEdits in the default group.

@sharexrefs

Flag whether the document xrefs are shared with the group. This value is based on the group property shareXrefsWithTarget in the default group.

@groupspecific

Comma-separated list of URL metadata that is overwritten by the group; possible metadata values are title, description and labels.

Examples

<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>
<share owner="true" editable="true" addcomments="true" shareedits="true" sharexrefs="true">
  <group id="35" name="dev-group1" description="Dev group 1" owner="dev" access="member" common="false"/>
</share>
<share groupspecific="title,description">
  <group id="35" name="dev-group1" description="Dev group 1" owner="dev" access="member" common="false"/>
</share>

Schema

XML Schema

<xs:element name="share">
  <xs:sequence>
    <xs:element ref="group" />
  </xs:sequence>
  <xs:attribute name="owner" type="xs:boolean" fixed="true" />
  <xs:attribute name="editable" type="xs:boolean" />
  <xs:attribute name="addcomments" type="xs:boolean" />
  <xs:attribute name="shareedits" type="xs:boolean" />
  <xs:attribute name="sharexrefs" type="xs:boolean" />
  <xs:attribute name="groupspecific" type="xs:string" />
</xs:element>

Relax Schema

element share {
  attribute owner{ xs:boolean }?,
  attribute editable { xs:boolean }?,
  attribute addcomments { xs:boolean }?,
  attribute shareedits { xs:boolean }?,
  attribute sharexrefs { xs:boolean }?,
  attribute groupspecific { xs:string }?,
  element group
}

 

Compatibility

See also

Created on , last edited on