Web service API

How to use PageSeeder's Web service API

list structure edits

/groups/{group}/uris/{uri}/structure/edits [GET]

com.pageseeder.psml.ListStructureEdits

Description

List the edits to the structure of the document.

Note

This service is cacheable and uses the URI's last modified date as the etag. While it might not be reflective of the fragment changes (the URI last modified date can change with this fragment not changing), it is better than nothing.

Parameters

No parameters required.

Permission

Undocumented permissions requirements.

Response

The output has the following format:

<structure-edits>
   <edit id="123" created="[date/time]" [type="[original|create|upload|add|remove|move|share]"]>
     [<author id="12" ... ><fullname>John Jones</fullname></author>]
      <content>
         <document>
            <section id="title" [title="My section title for UI"]>
              [<title>My section title for content</title>]
              <fragment-ref id="1" />
              ...
            </section>
            [<toc/>]
            <section id="content" [title="My section title for UI"]>
              [<title>My section title for content</title>]
              <fragment-ref id="2" />
              ...
            </section>
            ...
         </document>
      </content>
   </edit>
   <edit id="456">
   </edit>
   ...
 </structure-edits>

Error handling

No specific errors expected for this generator.

Created on , last edited on