Skip to main content

 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 withnostringsdepends on URI
labelsThe label values for the editnolabels
noteThe content of notes (if specified, it creates a note)nostring
note-labelsA comma-separated list of label values for the notes (if specified, it creates a note)nolabels
note-titleThe title for the notesnostringEdit Note

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

Permission

This service requires contributor or higher.

Response

When successful, a <document-fragment> wrapped in a <fragment-delete> element is returned

Example:


<fragment-delete>
  <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