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
groupsThe names of the groups to associate the deletion with.nostringsdepends on URI
labelsThe label values for the edit.nolabels
noteThe content of notes (if specified, it will create a note).nostring
note-labelsA comma-separated list of label values for the notes (if specified, it will create a note).nolabels
note-notifyThe note notification behavior [normal|announce|silent].noenumsilent
note-titleThe title for the notes.nostringEdit Note
notify-asyncWhether emails should be sent asynchronously (for slow email servers).nobooleanfalse

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

Permission

Permissions requirements to be updated.

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