Web service API

How to use PageSeeder's Web service API

uri fragment

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

com.pageseeder.psml.DeleteFragment

Description

Deletes the content of the fragment provided.

Parameters

NameDescriptionRequiredTypeDefault value
groups The names of the groups to associate the deletion with  no strings depends on URI
labels The labels for the edit no labels
note The content of notes (if specified, it will create a note)  no string
note-labels A comma separated list of labels for the notes (if specified, it will create a note) no labels
note-notify the note notification behavior [normal|announce|silent] no enum silent
note-title The title for the notes. no string Edit Note
notify-async Whether to send emails asynchronously (for slow email servers). no boolean false

The default groups are all the URI's groups where the member is a contributor or the group is Public.

Permission

Undocumented permissions requirements.

Response

When successful, a <document-fragment> wrapped in a <fragment-delete> element is returned 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-delete 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>
  </document-fragment>
</fragment-delete>

Error Handling

No specific errors expected for this service.

Created on , last edited on