Web service API

How to use PageSeeder's Web service API

<edit>

Summary

An element representing an edit on a fragment of a PSML document or a change of the structure of a PSML document.

Usage context

Permitted content<author>, <content>, <notes>
Permitted parent<structure-edits>, <edits>

Attributes

This element includes the following attributes.

NameTypeRequiredDescription
idxs:longyesThe ID of the edit in PageSeeder
createdxs:dateTimenoThe edit's creation date in ISO 8601 format.
sharedxs:booleannoIf the edit was to share a previous edit with a new group.
deletedxs:booleannoIf the edit was a deletion.
originalxs:booleannoIf the edit was the first of the fragment, on document creation or upload.
typeenumnoThe edit type, only for structure edits, possible values are "original", "create", "upload", "add", "remove", "move" and "share"

Examples

<edit id="542" created="2017-01-06T17:05:29+11:00" deleted="true">
  <author id="3532" firstname="Steve" surname="Cooper" username="scooper" status="activated">
    <fullname>Steve Cooper</fullname>
  </author>
</edit>
<edit id="36543" created="2015-01-08T11:25:38+11:00">
  <author id="11" firstname="Peter" surname="Muller" status="activated">
    <fullname>Peter Muller</fullname>
  </author>
  <notes>
    <note title="Changed paragraph 2" id="65435" modified="2015-01-08T11:25:39+11:00">
      <content>The second paragraph has been edited to reflect something.</content>
    </note>
  </notes>
</edit>

Schema

XML Schema

<xs:element name="edit">
  <xs:sequence>
    <xs:element ref="author" minOccurs="0"/>
    <xs:element name="content" minOccurs="0" />
    <xs:element name="notes" minOccurs="0" />
  </xs:sequence>
  <xs:attribute name="id"      type="id"/>
  <xs:attribute name="created" type="xs:dateTime" use="optional"/>
  <xs:attribute name="deleted" type="xs:boolean" use="optional"/>
  <xs:attribute name="shared" type="xs:boolean" use="optional"/>
  <xs:attribute name="original" type="xs:boolean" use="optional"/>
  <xs:attribute name="type" use="optional">
    <xs:simpleType>
      <xs:restriction base="xs:string">
        <xs:enumeration value="original" />
        <xs:enumeration value="create" />
        <xs:enumeration value="upload" />
        <xs:enumeration value="add" />
        <xs:enumeration value="remove" />
        <xs:enumeration value="move" />
        <xs:enumeration value="share" />
      </xs:restriction>
    </xs:simpleType>
  <xs:attribute>
<xs:element>

Relax Schema

element edit {
   attribute id { xs:long }?,
   attribute created  { xs:dateTime }?,
   attribute shared   { xs:boolean }?, 
   attribute deleted  { xs:boolean }?,  
   attribute original { xs:boolean }?, 
   attribute type     { "original" | "create" | "upload" | "add" | "remove" | "move" | "share" }?,
   element author?,
   element content?,
   element notes?
}

Compatibility

See also

Created on , last edited on