Web service API

How to use PageSeeder's Web service API

uri fragment

/members/{member}/groups/{group}/uris/{uri}/fragments/{+fragment} [POST]

com.pageseeder.psml.PutFragment

This service is deprecated since version 5.7900

Description

Fragment's Content

Parameters

NameDescriptionRequiredTypeDefault value
content Content of edit yes string
draft A flag to save edit as a draft no boolean false
html flag to specify content is HTML no boolean false
labels Comma separated list of edit labels no string
lastmodified The last modified date/time (ISO 8601) of the fragment (prevents edit clashes) no string
note content for edit notes (if exists creates a note) no string
note-labels Comma separated list of labels for the note (if exists creates a note) no string
note-notify the note notification behavior (normal|announce|silent) no enum silent
note-title title for edit note no string Edit Note
tidy flag to perform Tidy on HTML content no boolean true
transclude A flag to resolve transclusions when outputting result no boolean true

Permission

Undocumented permissions requirements.

Response

When successful, the new fragment is returned as a <document-fragment> wrapped in a <fragment-creation> element with the following optional attributes:

  • notification-email-delayed="true": if the edit note notification has been queued due to large number of recipients.
  • notification-email-failed="true": if the edit note notification could not be sent.

Example:


<fragment-creation notification-email-failed="true">
  <document-fragment>
    <locator id="325" fragment="example" editid="6340" modified="2015-03-24T13:21:57">
      <notes>
        <note id="6342" modified="2015-03-24T13:21:57" title="Typography">
          <content>Fixed typographical error.</content>
        </note>
      </notes>
    </locator>
    <fragment id="example">
      <para>This is the fragment content</para>
    </fragment>
  </document-fragment>
</fragment-creation>

Error Handling

No specific errors expected for this service.

Created on , last edited on