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

As a cacheable service, the etag value is created from the last modified date of the URI. Although the last modified date can change even when the fragment has not, this is a workable start.

Parameters

No parameters required.

Permission

Permissions requirements to be updated.

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